aboutsummaryrefslogtreecommitdiff
path: root/docs/static_dir.md
diff options
context:
space:
mode:
authorkaniini <nenolod@gmail.com>2019-03-15 02:50:27 +0000
committerkaniini <nenolod@gmail.com>2019-03-15 02:50:27 +0000
commitc708656b5e4dd0a7c7f9ec5fb0116f542a85e309 (patch)
tree7e67da76a93f3eb77f48dfe28ef6a51606b64665 /docs/static_dir.md
parent7ecc201029a8c90cf5dc3313ff78d56eb0a2445c (diff)
parent3dadaa4432b442d75b0ac0425aa05527d52f0e7a (diff)
downloadpleroma-c708656b5e4dd0a7c7f9ec5fb0116f542a85e309.tar.gz
Merge branch 'robotstxt' into 'develop'
Add robots.txt Closes #723 See merge request pleroma/pleroma!929
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
+```