From efc79528d2e26e0470799cb25fa7225a2123dbde Mon Sep 17 00:00:00 2001 From: kim Date: Tue, 29 Apr 2025 08:59:28 +0000 Subject: [PATCH] [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 Co-committed-by: kim --- docs/{admin => advanced}/scraper_deterrence.md | 3 +++ example/config.yaml | 2 +- mkdocs.yml | 1 + 3 files changed, 5 insertions(+), 1 deletion(-) rename docs/{admin => advanced}/scraper_deterrence.md (86%) diff --git a/docs/admin/scraper_deterrence.md b/docs/advanced/scraper_deterrence.md similarity index 86% rename from docs/admin/scraper_deterrence.md rename to 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"