A local-first personal finance app
Add a page about configuring server debug logging (#146)
Jed Fox1cccf50defde
diff --git a/docs/Installing/Configuration.md b/docs/Installing/Configuration.mdindex b3f4ecc4aa..db36e3aed0 100644--- a/docs/Installing/Configuration.md+++ b/docs/Installing/Configuration.md@@ -4,6 +4,12 @@ title: Configuring the ServerWhen 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.+:::info++Running into issues with your configuration not being interpreted correctly? Check out our documentation for [troubleshooting the server](/Troubleshooting/Server) for information on how to enable debug logging to track down the issue.++:::+## `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` directory if it is present, or in the same directory as the `package.json` if `/data` is not present.@@ -46,20 +52,30 @@ The server will put all the budget files in this directory as binary blobs. If nIf 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.-## `bank-sync`-*config.js or env variables depending on how you are running Actual*--**Nordigen**-- After you have updated your fly.io version or deployed a new version, you will need to add your Nordigen SECRET ID and KEY by running a flyctl command.-*Run the following command in your terminal application, making sure to replace xxxxx with your SECRET ID and KEY from what you generated in Nordigen.*- `flyctl secrets set ACTUAL_NORDIGEN_SECRET_ID=xxxxx ACTUAL_NORDIGEN_SECRET_KEY=xxxxx`--- For all other installs you need to add your Nordigen SECRET KEY and ID to a config.json file in actual-server.-*If you don't already have this file, you will need to create it and add the following lines replacing xxxxx with your SECRET ID and KEY.*-- {- "nordigen": {- "secretId": "xxxx",- "secretKey": "xxxxx"- }- }+## Bank syncing++### Nordigen++The `nordigen` key of the config file is used to configure syncing using Nordigen. It should be an object with two keys:++- `secretId`: The ID of your Nordigen secret. (environment variable: `ACTUAL_NORDIGEN_SECRET_ID`)+- `secretKey`: The key of your Nordigen secret. (environment variable: `ACTUAL_NORDIGEN_SECRET_KEY`)++In the below examples, replace `xxxxx` with your secret ID / secret key.++Example with the `config.json`:++```json+{+ "nordigen": {+ "secretId": "xxxxx",+ "secretKey": "xxxxx"+ }+}+```++Example using environment variables on Fly.io:++```sh+flyctl secrets set ACTUAL_NORDIGEN_SECRET_ID=xxxxx ACTUAL_NORDIGEN_SECRET_KEY=xxxxx+```diff --git a/docs/Troubleshooting/Server.md b/docs/Troubleshooting/Server.mdnew file mode 100644index 0000000000..c87763546d--- /dev/null+++ b/docs/Troubleshooting/Server.md@@ -0,0 +1,5 @@+# Troubleshooting Server configuration issues++Actual uses the standard Node.js `debug` module to optionally log helpful debugging information to the console.++If your configuration options (set either in the config file or as environment variables) are not being applied, you can enable debug logging by adding an environment variable named `DEBUG` with the value `actual:config`. If you’re seeing issues with your HTTPS or Nordigen configuration, you can instead set the value to `actual:config,actual-sensitive:config` to log the actual values of the HTTPS and Nordigen secrets (which are obscured by default so they don’t get leaked unintentionally).diff --git a/sidebars.js b/sidebars.jsindex e2e1f58e97..22c4f21fe6 100644--- a/sidebars.js+++ b/sidebars.js@@ -254,6 +254,7 @@ const sidebars = {label: 'Troubleshooting',collapsed: true,items: [+ 'Troubleshooting/Server','Troubleshooting/SharedArrayBuffer','Troubleshooting/Troubleshooting-Edge',],