A local-first personal finance app
Added documention about the header authentication (#341)
Joseph Livecchi3311ea58fdfb
diff --git a/docs-sidebar.js b/docs-sidebar.jsindex bff3ee0c46..d5a13e2445 100644--- a/docs-sidebar.js+++ b/docs-sidebar.js@@ -208,6 +208,7 @@ const sidebars = {},items: ['advanced/bank-sync',+ 'advanced/http-header-auth',{type: 'category',label: 'Scripts',diff --git a/docs/advanced/http-header-auth.md b/docs/advanced/http-header-auth.mdnew file mode 100644index 0000000000..65046a2be5--- /dev/null+++ b/docs/advanced/http-header-auth.md@@ -0,0 +1,25 @@+# Authenticating With HTTP Headers++:::note+Client Version 24.6.0 and+Server Version 24.6.0 or higher are required for this feature.+:::++This feature will allow Actual to use an HTTP header to automatically authenticate and log in without prompting for a password. This would be useful for individuals who run SSO services like [Authentik](https://goauthentik.io/), [Authelia](https://www.authelia.com/), and more.++## Setup++This feature needs to be enabled on the server, it is not configured to work out of the box. In the Actual config, set the value `loginMethod` or env `ACTUAL_LOGIN_METHOD` to `"header"`. This will enable header authentication, but the normal password authentication will still work as a fallback.++:::warning+Be careful! A misconfiguration on this next step could make your instance available to the whole internet.+:::++The SSO provider then needs to be configured to pass an extra HTTP header to Actual. The details on how to do this are unique to the SSO provider, but the header `x-actual-password` needs to be set to your actual password.+++If your setup needs it, it possible to config trusted proxies. See [`trustedProxies` configuration](../config/index.md#trustedProxies) for details.++:::note+This feature is not an HTTP basic auth, but a different form of using a password. For HTTP basic auth or user accounts see [this issue](https://github.com/actualbudget/actual/issues/524)+:::diff --git a/docs/config/index.md b/docs/config/index.mdindex f2e2bde6b4..e7f5f5ebb5 100644--- a/docs/config/index.md+++ b/docs/config/index.md@@ -51,3 +51,14 @@ The server will put all the budget files in this directory as binary blobs. If n(Advanced, most people will not need to configure this.) The server will serve the frontend from this directory. If not specified, the server will use the files in the `@actual-app/web` package that it has installed. (environment variable: `ACTUAL_WEB_ROOT`)If you’re providing a custom frontend, make sure you provide an `index.html` in the top level of the `webRoot` directory, which will be served from the `/` route.++## `loginMethod`++Change the authentication method for Actual (environment variable: `ACTUAL_LOGIN_METHOD`). The valid values are:+* `"password"` (default) - This is standard password authentication+* `"header"` - Use the HTTP header `x-actual-password` to automatically login. This is advances used and is not done correctly could have security implications.+++## `trustedProxies`++Config the clients that are allowed to authentic with HTTP headers. This defaults to known internal ip ranges: `[10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16, fc00::/7, ::1/128]` (environment variable: `ACTUAL_TRUSTED_PROXIES`, comma separated string).