summaryrefslogtreecommitdiff
path: root/docs/static_dir.md
diff options
context:
space:
mode:
authorWilliam Pearson <uiri00@gmail.com>2019-01-20 01:44:00 +0000
committerWilliam Pearson <uiri00@gmail.com>2019-03-15 02:28:18 +0000
commit3dadaa4432b442d75b0ac0425aa05527d52f0e7a (patch)
tree84b54ea9b38a8765a3cdda450e4bf9d61a9e7c4c /docs/static_dir.md
parent4e72762322a5616ce426df62888ee3bc7af19dc8 (diff)
downloadpleroma-3dadaa4432b442d75b0ac0425aa05527d52f0e7a.tar.gz
pleroma-3dadaa4432b442d75b0ac0425aa05527d52f0e7a.zip
robots.txt
Add default robots.txt that allows bots access to all paths. Add mix task to generate robots.txt taht allows bots access to no paths. Document custom emojis, MRF and static_dir static_dir documentation includes docs for the robots.txt Mix task.
Diffstat (limited to 'docs/static_dir.md')
-rw-r--r--docs/static_dir.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/docs/static_dir.md b/docs/static_dir.md
new file mode 100644
index 000000000..0cc52b99a
--- /dev/null
+++ b/docs/static_dir.md
@@ -0,0 +1,20 @@
+# Static Directory
+
+Static frontend files are shipped in `priv/static/` and tracked by version control in this repository. If you want to overwrite or update these without the possibility of merge conflicts, you can write your custom versions to `instance/static/`.
+
+```
+config :pleroma, :instance,
+ static_dir: "instance/static/",
+```
+
+You can overwrite this value in your configuration to use a different static instance directory.
+
+## robots.txt
+
+By default, the `robots.txt` that ships in `priv/static/` is permissive. It allows well-behaved search engines to index all of your instance's URIs.
+
+If you want to generate a restrictive `robots.txt`, you can run the following mix task. The generated `robots.txt` will be written in your instance static directory.
+
+```
+mix pleroma.robots_txt disallow_all
+```