A local-first personal finance app
Add reset password to cli tool docs (#726)
Michael Clark0f3716a20697
diff --git a/docs/install/cli-tool.md b/docs/install/cli-tool.mdindex 28eef47dcd..3ba37fae4a 100644--- a/docs/install/cli-tool.md+++ b/docs/install/cli-tool.md@@ -8,7 +8,7 @@ The Actual sync-server is available as an NPM package. The package is designed t### Installing the CLI tool-Node.js v18 or higher is required for the `@actual-app/sync-server` npm package+Node.js v20 or higher is required for the `@actual-app/sync-server` npm package**Install globally with npm:**@@ -35,6 +35,7 @@ actual-server [options]| `-h` or `--help` | Print this list and exit. || `-v` or `--version` | Print this version and exit. || `--config` | Path to the config file. |+| `--reset-password` | Reset your password |**Default values**@@ -61,6 +62,12 @@ Run with [Environment Variable Configuration](../config/index.md):ACTUAL_DATA_DIR=./custom-directory actual-server --config ./config.json```+Reset your password++```bash+actual-server --reset-password+```+### Updating the CLI toolThe sync server can be updated with a simple command.@@ -68,3 +75,11 @@ The sync server can be updated with a simple command.```bashnpm update -g @actual-app/sync-server```++### Uninstalling the CLI tool++The sync server can be uninstalled with a simple command.++```bash+npm uninstall -g @actual-app/sync-server+```diff --git a/docs/install/desktop-app.md b/docs/install/desktop-app.mdindex bb05897546..698ca9fff1 100644--- a/docs/install/desktop-app.md+++ b/docs/install/desktop-app.md@@ -37,11 +37,10 @@ Click **Start** to run the server.Upon starting the server, you’ll be prompted to create a password (if you haven’t already). Sign in to complete the configuration.-Once these steps are completed, your local server will be running, unlocking full server functionalities including Bank Sync and more.-## Connecting your local server to a mobile device+## Exposing your local server to the internet-You can access your local server from your mobile device. However, this requires a bit more setup since you’ll need a way to expose your local server to the internet. To achieve this you must set up a [Reverse Proxy](../config/reverse-proxies.md).+To access your local server from mobile devices or other networks, you'll need to expose it to the internet. This requires setting up a [Reverse Proxy](../config/reverse-proxies.md) to securely tunnel your local server connection.For a practical walkthrough, check out the [Ngrok guide](../config/reverse-proxies.md#ngrok). If you plan to use your mobile device regularly while the desktop app is running, consider configuring the reverse proxy to launch automatically with your computer.