summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLibravatar kim <grufwub@gmail.com>2025-04-29 08:59:28 +0000
committerLibravatar tobi <tsmethurst@noreply.codeberg.org>2025-04-29 08:59:28 +0000
commitefc79528d2e26e0470799cb25fa7225a2123dbde (patch)
treeab988faefa2328a7d49c15e466bfc7818e8f0c12
parent[feature] proof of work scraper deterrence (#4043) (diff)
downloadgotosocial-efc79528d2e26e0470799cb25fa7225a2123dbde.tar.xz
[docs] small changes to the proof-of-work scraper deterrence docs (#4084)
- moves it to the advanced section - adds it to the mkdocs config - adds warning about it not covering RSS endpoints Reviewed-on: https://codeberg.org/superseriousbusiness/gotosocial/pulls/4084 Co-authored-by: kim <grufwub@gmail.com> Co-committed-by: kim <grufwub@gmail.com>
-rw-r--r--docs/advanced/scraper_deterrence.md (renamed from docs/admin/scraper_deterrence.md)3
-rw-r--r--example/config.yaml2
-rw-r--r--mkdocs.yml1
3 files changed, 5 insertions, 1 deletions
diff --git a/docs/admin/scraper_deterrence.md b/docs/advanced/scraper_deterrence.md
index c1cdbbff8..cd0165292 100644
--- a/docs/admin/scraper_deterrence.md
+++ b/docs/advanced/scraper_deterrence.md
@@ -11,4 +11,7 @@ This was heavily inspired by the great project that is [anubis], but ultimately
The GoToSocial implementation of this scraper deterrence is still incredibly minimal, so if you're looking for more features or fine-grained control over your deterrence measures then by all means keep ours disabled and stand-up a service like [anubis] in front of your instance!
+!!! warning
+ This proof-of-work scraper deterrence does not protect user profile RSS feeds due to the extra complexity involved. If you rely on your RSS feed being exposed, this is one such case where [anubis] may be a better fit!
+
[anubis]: https://github.com/TecharoHQ/anubis \ No newline at end of file
diff --git a/example/config.yaml b/example/config.yaml
index c7504ce56..4ac018e47 100644
--- a/example/config.yaml
+++ b/example/config.yaml
@@ -1275,7 +1275,7 @@ advanced-header-filter-mode: ""
# The downside is that it requires javascript to be enabled.
#
# For more details please check the documentation at:
-# https://docs.gotosocial.org/en/latest/admin/scraper_deterrence
+# https://docs.gotosocial.org/en/latest/advanced/scraper_deterrence
#
# Options: [true, false]
# Default: true
diff --git a/mkdocs.yml b/mkdocs.yml
index 02dadf4cf..255ae8f7b 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -131,6 +131,7 @@ nav:
- "advanced/tracing.md"
- "advanced/metrics.md"
- "advanced/replicating-sqlite.md"
+ - "advanced/scraper_deterrence.md"
- "advanced/sqlite-networked-storage.md"
- "Advanced builds":
- "advanced/builds/nowasm.md"