From ab90a83b5b36b09dcad44adaf8f2f0aa1b11f609 Mon Sep 17 00:00:00 2001 From: Nick Sweeting Date: Fri, 3 May 2024 16:42:18 -0700 Subject: [PATCH] Created Setting up Authentication (markdown) --- Setting-up-Authentication.md | 54 ++++++++++++++++++++++++++++++++++++ 1 file changed, 54 insertions(+) create mode 100644 Setting-up-Authentication.md diff --git a/Setting-up-Authentication.md b/Setting-up-Authentication.md new file mode 100644 index 0000000..b7ace4f --- /dev/null +++ b/Setting-up-Authentication.md @@ -0,0 +1,54 @@ +ArchiveBox supports 4 types of authentication currently. + +*These docs are a work in progress, follow the links to learn more about each authentication setup.* + +If you encounter any issues or need help feel free to ask questions in our public forum: https://zulip.archivebox.io + +--- + +### Username & Password (the default) + +```bash +archivebox manage createsuperuser + +archivebox manage changepassword +``` + +- https://github.com/ArchiveBox/ArchiveBox/wiki/Configuration#admin_username--admin_password + +### Reverse Proxy Authentication (e.g. Authelia) + +- https://github.com/ArchiveBox/ArchiveBox/wiki/Configuration#reverse_proxy_user_header +- https://github.com/ArchiveBox/ArchiveBox/wiki/Configuration#reverse_proxy_whitelist +- https://github.com/ArchiveBox/ArchiveBox/wiki/Configuration#logout_redirect_url +- https://github.com/ArchiveBox/ArchiveBox/pull/866 + +### LDAP Authentication + +- https://github.com/ArchiveBox/ArchiveBox/wiki/Configuration#ldap +- https://github.com/ArchiveBox/ArchiveBox/pull/1214 +- https://github.com/django-auth-ldap/django-auth-ldap#example-configuration +- https://jumpcloud.com/blog/what-is-ldap-authentication + +### API Token Authentication + +The new REST API released in v0.8.0 supports several methods of authentication using an API token. + +First, generate your API key in your Admin UI: `[/admin/api/apitoken/add/`](http://127.0.0.1:8000/admin/api/apitoken/add/). +You can read the API docs and test the authentication methods here: [`/api/v1/docs`](http://127.0.0.1:8000/api/v1/docs). + +- passing Bearer=xyz as a bearer token request header +- passing `X-API-Key=xyz` as a request header +- passing `api_key=xyz` as a GET/POST query parameter +- fallback: passing username & password via HTTP Basic Authentication (not recommended) + +Screenshot 2024-05-03 at 4 40 22 PM + +--- + +## Web Server UI Permissions + +Make sure to set up your Web UI permissions to allow or prevent guest access to content according to your needs. See the links below for more information. + +- https://github.com/ArchiveBox/ArchiveBox/wiki/Configuration#public_index--public_snapshots--public_add_view +- https://github.com/ArchiveBox/ArchiveBox/wiki/Security-Overview \ No newline at end of file