diff --git a/Setting-up-Authentication.md b/Setting-up-Authentication.md index 17258b8..f5e6e7c 100644 --- a/Setting-up-Authentication.md +++ b/Setting-up-Authentication.md @@ -14,12 +14,12 @@ ArchiveBox supports several types of authentication for users logging in via the Non-admin user permissions are only available to paying ArchiveBox clients +Use these three options to set up your desired permissions for non-admin guest users: +- `PUBLIC_INDEX=[True]|False`: Default allows non-logged-in users to see the list of all Snapshots +- `PUBLIC_SNAPSHOTS=[True]|False`: Default allows non-logged-in users to see archived Snapshot content by default +- `PUBLIC_ADD_VIEW=True|[False]`: Default doesn't allow non-logged-in users to submit new URLs to archive -> [!IMPORTANT] -> Make sure to **set up your [Web UI permissions](https://github.com/ArchiveBox/ArchiveBox/wiki/Configuration#public_index--public_snapshots--public_add_view) first** to allow/restrict public access. -> Configuring advanced auth methods below is pointless if your Web UI permissions allow unrestricted access to guests! - -*Note, free ArchiveBox does not currently support setting up non-admin users* with more granular read-only permissions. We do offer this feature to [paying clients](https://docs.monadical.com/s/archivebox-consulting-services) that hire us to set up a server for their company. We use this revenue (from mostly large corporate clients who can afford to pay for things) to support ArchiveBox open source development. +*Note, free ArchiveBox does not currently support setting up **non-admin** users* with more granular read-only permissions. We do offer this feature to [paying clients](https://docs.monadical.com/s/archivebox-consulting-services) that hire us to set up a server for their company. We use this revenue (from mostly large corporate clients who can afford to pay for things) to support ArchiveBox open source development. - [Wiki: Configuration (`PUBLIC_ADD_VIEW`, `PUBLIC_SNAPSHOTS`, `PUBLIC_INDEX`)](https://github.com/ArchiveBox/ArchiveBox/wiki/Configuration#public_index--public_snapshots--public_add_view) - [Wiki: Security Overview](https://github.com/ArchiveBox/ArchiveBox/wiki/Security-Overview) @@ -28,6 +28,10 @@ ArchiveBox supports several types of authentication for users logging in via the ## Admin Web UI Authentication Methods +> [!IMPORTANT] +> Make sure to **set up your [Web UI permissions](https://github.com/ArchiveBox/ArchiveBox/wiki/Configuration#public_index--public_snapshots--public_add_view) first** to restrict public access. +> Configuring advanced auth methods below is pointless if your Web UI permissions allow unrestricted access to guests! +
### Username & Password (the default)