Actual Budget

Requirements

• Actual Budget client and server version 25.1.0 or higher
• HTTPS connection to your Actual server

Create the client in Pocket ID

1. In Pocket ID, open Administration → OIDC Clients and click Add OIDC Client.
2. Enter a name such as Actual Budget and add the callback URL https://actual.example.com/openid/callback.
3. Click Create and copy the Client ID, the Client secret and the OIDC Discovery URL. The client secret is only shown once.
4. On the client’s Access tab, select the groups that may sign in under Allowed User Groups, or choose All Users.

Configure Actual using the UI

1. Click Start using OpenID.
2. Fill in the fields:
   • OpenID Provider: choose Other.
   • Provider URL: the OIDC Discovery URL from Pocket ID, or the Pocket ID URL (https://id.example.com).
   • Client ID: the Client ID from Pocket ID.
   • Client Secret: the Client secret from Pocket ID.
3. Click OK and you will be redirected to the login page.
4. Enter your existing file password and sign in with OpenID to test it. The first user who signs in successfully becomes the administrator.

Multiple users

After setting up the integration, you can manage users in Actual by following these instructions.

Configure Actual with other methods

You can also configure OpenID with the following methods. Check out Actual’s documentation for more information.

• Environment variables
• Configuration file

Example with .env:

ACTUAL_OPENID_DISCOVERY_URL=https://id.example.com
ACTUAL_OPENID_CLIENT_ID=<client-id>
ACTUAL_OPENID_CLIENT_SECRET=<client-secret>

Example with config.json:

"openId": {
        "discoveryURL": "https://id.example.com",
        "client_id": "<client-id>",
        "client_secret": "<client-secret>",
        "server_hostname": "https://actual.example.com",
        "authMethod": "openid" // or "oauth2"
    }