From feaa582aa79b507838817d571bb39b82eb4b461a Mon Sep 17 00:00:00 2001 From: Jordan Crivelli-Decker Date: Tue, 10 Jun 2025 18:24:31 -0700 Subject: [PATCH] update README.md --- 07-ts-actual-server/README.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/07-ts-actual-server/README.md b/07-ts-actual-server/README.md index 361427f..5d58124 100644 --- a/07-ts-actual-server/README.md +++ b/07-ts-actual-server/README.md @@ -2,11 +2,17 @@ This has been tested on Synology DSM 7.2.2 and running Synology Container Manager. +Before getting started: + +1. Follow the Synology guide to enable remote access to your Synology NAS via Tailscale. Guide [here](https://tailscale.com/kb/1131/synology). +2. Enable HTTPS Certificates in the `DNS` tab in your Tailscale Admin Console. Guide [here](https://tailscale.com/kb/1153/enabling-https). +3. Create a Tailscale AuthKey for use in the container. Guide [here](https://tailscale.com/kb/1085/auth-keys). + Steps to get this working: 1. Create a new `Project` in Container Manager. Name it `actual-server` or something identifiable. 2. Under the `Yaml Configurations` tab, paste this `compose.yaml` file as is. -3. Modify the yaml and insert your own Tailscale AuthKey. +3. Modify the yaml and insert your own Tailscale AuthKey. Use the key generated in Step 3 of the `Before getting started` section. 4. Using the Synology File Station (or similar) make sure to create the correct folders so that the Docker files can save their data in the mounted volumes. 5. Copy up the `serve-config.json` into the `/config` folder volume mount as well. 6. If you haven't done so already, save and build the project. After a few minutes it should build and start the Actual Server container. @@ -17,5 +23,4 @@ Go and budget away! Please file a bug issue if you run into any problems with th Actual Server Docker info: - https://actualbudget.com/docs/install/docker -- Docker Compose file - https://github.com/actualbudget/actual/blob/master/packages/sync-server/docker-compose.yml - +- Docker Compose file - https://github.com/actualbudget/actual/blob/master/packages/sync-server/docker-compose.yml \ No newline at end of file