mirror/archivebox
1
0
Fork 0
mirror of https://github.com/pirate/ArchiveBox.git synced 2025-08-25 15:31:22 +02:00
Code Issues Releases Wiki Activity

Updated Setting up Authentication (markdown)

Nick Sweeting
2024-05-08 17:39:05 -07:00
parent c5cbe5ed6d
commit 83029bb062
1 changed files with 9 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
Setting-up-Authentication.md

@@ -14,12 +14,12 @@ ArchiveBox supports several types of authentication for users logging in via the
<img src="https://github.com/ArchiveBox/ArchiveBox/assets/511499/024913f0-ad2c-463c-aa4a-eb3d0ec8eb64" alt="Non-admin user permissions are only available to paying ArchiveBox clients" width="200px" align="right">
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!
<br/>
### Username & Password (the default)