diff --git a/docs/actual-server-repo-move.md b/docs/actual-server-repo-move.md index 185900e1..17fc0544 100644 --- a/docs/actual-server-repo-move.md +++ b/docs/actual-server-repo-move.md @@ -37,7 +37,12 @@ The reasons for this change are as follows: ``` yarn workspaces focus @actual-app/sync-server --production ``` - 4. Run the server with: + 4. If you have a [config.json](https://actualbudget.com/docs/config/) file you will need to copy it into the following directory: + ``` + packages/sync-server + ``` + 5. Run the server with: ``` yarn start:server ``` + diff --git a/docs/config/https.md b/docs/config/https.md index af96cdb7..c1ae1edd 100644 --- a/docs/config/https.md +++ b/docs/config/https.md @@ -21,7 +21,7 @@ Use a service like [Tailscale](https://tailscale.com/kb/1153/enabling-https/) or Once you have the certificate, you’ll need to configure Actual to use it. There are two methods to do this: ### Configuring with `config.json`: -Create a `config.json` file in the same folder where you run Actual. Put the paths to the `.key` and `.crt` files in the file. Note: if you’re using Docker or a similar container environment, make sure the paths are accessible to the container. +Create a `config.json` file in the same folder where you run the Actual Sync Server. If you are running a [local installation](https://actualbudget.com/docs/install/local) this will be in ```packages/sync-server/```. Put the paths to the `.key` and `.crt` files in the config file. Note: if you’re using Docker or a similar container environment, make sure the paths are accessible to the container. If using a Docker container, this folder is `/data` within the container. If you mounted a volume for the container, the folder on the host where `/data` is mounted is where you can place the `config.json` file. @@ -35,7 +35,7 @@ If using a Docker container, this folder is `/data` within the container. If you } } ``` - + ### Configuring with environment variables: If you can’t easily create new files, you can also configure HTTPS using environment variables. Set the `ACTUAL_HTTPS_KEY` and `ACTUAL_HTTPS_CERT` environment variables to the contents of the `.key` and `.crt` files, respectively. If you’re unable to include newlines in the environment variable values, you can replace any newlines with `\n` and Actual will automatically convert them back to newlines. diff --git a/docs/config/index.md b/docs/config/index.md index 94c3c55b..f61fbacc 100644 --- a/docs/config/index.md +++ b/docs/config/index.md @@ -2,7 +2,7 @@ title: Configuring the Server --- -When it starts up, Actual looks for an optional `config.json` file in the same directory as its `package.json`. If present, any keys you define there will override the default values. All values can also be specified as environment variables, which will override the values in the `config.json` file. +When it starts up, Actual looks for an optional `config.json` file in the same directory as the sync-server's `package.json`. If you are running a [local installation](https://actualbudget.com/docs/install/local) this will be in ```packages/sync-server/```. If present, any keys you define there will override the default values. All values can also be specified as environment variables, which will override the values in the `config.json` file. :::info @@ -22,7 +22,7 @@ See also sections on `userFiles` and `serverFiles`. ## `ACTUAL_CONFIG_PATH` This is the path to the config file. If not specified, the server will look for a `config.json` file either in the -`/data` folder if it is present or in the same directory as the `package.json` if `/data` is absent. +`/data` folder if it is present or in the same directory as the sync-server's `package.json` if `/data` is absent. See the `ACTUAL_DATA_DIR` section above to override the data folder location. diff --git a/docs/experimental/oauth-auth.md b/docs/experimental/oauth-auth.md index 9be7ae70..82a16072 100644 --- a/docs/experimental/oauth-auth.md +++ b/docs/experimental/oauth-auth.md @@ -16,7 +16,7 @@ This feature requires use of [Actual Server](../config/) If you require a more robust authentication method than a server password, it is recommended to use an OpenID provider. Most OpenID providers support multi-factor authentication, enhancing your application's security. Additionally, if you need support for multiple users, you must enable this feature. -To enable this feature, you can use a configuration file `config.json` on the Actual server, or use the UI. +To enable this feature, you can use a [configuration file](https://actualbudget.com/docs/config/) `config.json` on the Actual server, or use the UI. ### Configuration Using a Configuration File @@ -117,4 +117,4 @@ When setup is done, you will be redirected to the _login_ page: :::tip Configuring the OpenID provider from options supports discovery; otherwise, use [file configuration](oauth-auth#config-using-configuration-file) -::: \ No newline at end of file +:::