A local-first personal finance app
Update Unraid docs with steps to generate certificates (#98)
Paulefb0305ecf6d
diff --git a/docs/Installing/Unraid.md b/docs/Installing/Unraid.mdindex 89e8152eb9..60335237a9 100644--- a/docs/Installing/Unraid.md+++ b/docs/Installing/Unraid.md@@ -4,26 +4,31 @@ title: 'Unraid'## Hosting Actual with [Unraid](https://unraid.net/)-This guide assumes you already have the [Community Apps (CA) plugin](https://forums.unraid.net/topic/38582-plug-in-community-applications/)-installed and don't yet have Actual-Server installed. If you don't have the CA plugin installed,-install it now. Please read through all of the instructions before starting.-As always, backup your data by exporting from the web interface prior to making any configuration-changes.+## Initial setup+### Using Community Apps+1. If you don't have the CA plugin installed, install it now. Please read through all of the instructions before starting.+As always, backup your data by exporting from the web interface prior to making any configuration changes.The current Actual Unraid CA was defined and maintained by hofq. Problems specifically with theunraid template (not Actual itself) should be addressed to that repo, which can be found [here](https://github.com/hofq/docker-templates/issues/new/choose).--## Initial setup-1. Search for "actualserver" in [Community Apps](https://unraid.net/community/apps?q=actualserver) andselect the one by Kippenhof (the only one at this time).1. Click Install.++### Using Docker without Community Apps++1. Create a new image and follow the guidelines below to configure the parameters+This image is not very complex, and can easily be configured in the web interface.+Follow the instructions below to configure the Repository, Data volume, WebUI port, and HTTPS keys necessary for running the image.++## Setting up data persistence-To avoid losing data when updating your image, you may wish to setup a persistent volume.+To avoid losing data when updating your image, it is recommended to setup a persistent volume.+This step is also necessary for sharing the HTTPS key/cert combination into the image.1. Towards the bottom the template, select `Add another Path, Variable, Label or Device`,1. In the popup, fill in the following details - changing your host location to match your setup:@@ -42,6 +47,7 @@ the other guides.(Note: It's generally wise to have a manual backup strategy just in case. Two is one, one is none!)+## Changing the image sourceIf you'd like to point the Actual Community App to a different image, it's simple to do so.@@ -51,12 +57,36 @@ instructions.1. On the settings page for the Actual CA, locate the `repository` field.1. Update this value to point to the dockerhub image of your choice. Eg, to use the official image- change this value to [`jlongster/actual-server`](https://hub.docker.com/r/jlongster/actual-server)+ change this value to [`jlongster/actual-server`](https://hub.docker.com/r/jlongster/actual-server) or [`ghcr.io/actualbudget/actual-server:latest`](https://ghcr.io/actualbudget/actual-server)1. Confirm that the correct image is pulled. The `By:` section should read `By:-jlongster/actual-server` (or whichever image source you have chosen to use).+ghcr.io/actualbudget/actual-server:latest` (or whichever image source you have chosen to use).+## Advanced+### Creating HTTPS Certificates++New versions of Actual depend on HTTPS to be enabled (see [Enabling SharedArrayBuffer Access](/Troubleshooting/SharedArrayBuffer)). To create your own certificate on Unraid, open up a terminal into your server to follow these steps:++1. Change directory into your shared data folder (see "Setting up data persistence" above)+1. Create a new folder, "keys"+1. Change directory into the "keys" folder+1. Generate a certificate and private key combo by running `openssl req -x509 -nodes -days 365 -newkey rsa:2048 -keyout actual.key -out actual.crt`+1. In the Docker settings on the WebUI, create a new Variable `ACTUAL_HTTPS_KEY` and set the value to the path of the newly created key, `/data/keys/actual.key` (note: this is the value of the path _inside_ the docker container)+1. Similarly to step 5, create a new Variable `ACTUAL_HTTPS_CERT` and set the value to `/data/keys/actual.crt`+1. The next time the Actual Docker container is started, access the WebUI and accept the self-signed certificate.+++### Map WebUI Port to container++Assuming the default port of 5006, map TCP host port 5006 to Docker port 5006.+++### Add WebUI URL++By default, Actual server runs on port 5006. To enable the WebUI button on the Docker page, go into the advanced Docker settings and set the WebUI to value `https://[IP]:[PORT:5006]/`++### If you already had an alternate image running:1. BACKUP YOUR DATA. Safety first!