diff options
| author | Ivan Tashkinov <ivantashkinov@gmail.com> | 2020-07-07 20:44:16 +0300 |
|---|---|---|
| committer | Ivan Tashkinov <ivantashkinov@gmail.com> | 2020-07-07 20:44:16 +0300 |
| commit | 20461137a37968ee4dc8e3a38f7d9c63714702d3 (patch) | |
| tree | a797bdf77b21d746d852c89ba37e231d95cb8316 | |
| parent | 3e08e7715126ca1f3bfaf7dddf4806e76d9bd993 (diff) | |
| download | pleroma-20461137a37968ee4dc8e3a38f7d9c63714702d3.tar.gz pleroma-20461137a37968ee4dc8e3a38f7d9c63714702d3.zip | |
[#1895] Documentation hints on private instances and instance/restrict_unauthenticated setting.
| -rw-r--r-- | config/description.exs | 5 | ||||
| -rw-r--r-- | docs/configuration/cheatsheet.md | 2 |
2 files changed, 4 insertions, 3 deletions
diff --git a/config/description.exs b/config/description.exs index 650610fbe..705ba83d0 100644 --- a/config/description.exs +++ b/config/description.exs @@ -700,8 +700,9 @@ config :pleroma, :config_description, [ key: :public, type: :boolean, description: - "Makes the client API in authentificated mode-only except for user-profiles." <> - " Useful for disabling the Local Timeline and The Whole Known Network." + "Makes the client API in authenticated mode-only except for user-profiles." <> + " Useful for disabling the Local Timeline and The Whole Known Network. " <> + " Note: when setting to `false`, please also check `:restrict_unauthenticated` setting." }, %{ key: :quarantined_instances, diff --git a/docs/configuration/cheatsheet.md b/docs/configuration/cheatsheet.md index 1de51e72d..f6529b940 100644 --- a/docs/configuration/cheatsheet.md +++ b/docs/configuration/cheatsheet.md @@ -37,7 +37,7 @@ To add configuration to your config file, you can copy it from the base config. * `federation_incoming_replies_max_depth`: Max. depth of reply-to activities fetching on incoming federation, to prevent out-of-memory situations while fetching very long threads. If set to `nil`, threads of any depth will be fetched. Lower this value if you experience out-of-memory crashes. * `federation_reachability_timeout_days`: Timeout (in days) of each external federation target being unreachable prior to pausing federating to it. * `allow_relay`: Enable Pleroma’s Relay, which makes it possible to follow a whole instance. -* `public`: Makes the client API in authenticated mode-only except for user-profiles. Useful for disabling the Local Timeline and The Whole Known Network. +* `public`: Makes the client API in authenticated mode-only except for user-profiles. Useful for disabling the Local Timeline and The Whole Known Network. See also: `restrict_unauthenticated`. * `quarantined_instances`: List of ActivityPub instances where private(DMs, followers-only) activities will not be send. * `managed_config`: Whenether the config for pleroma-fe is configured in [:frontend_configurations](#frontend_configurations) or in ``static/config.json``. * `allowed_post_formats`: MIME-type list of formats allowed to be posted (transformed into HTML). |