github-starred/actual
2
0
Fork 0
mirror of https://github.com/actualbudget/actual.git synced 2026-04-30 10:14:53 -05:00
Code Issues 1.3k Packages Projects Releases 54 Wiki Activity

Update notes on self signed certificates for desktop app (#450)

Browse Source 
Notes on mkcert when used with desktop app. 

Should resolve future questions like this one:
https://discord.com/channels/937901803608096828/1281484103580909621/1284432537682317365

---------

Co-authored-by: Ruben Olsen Lærk <ruben@lku.no>
This commit is contained in:
Michael Clark
2024-09-14 14:08:28 +01:00
committed by GitHub
parent 84ecc7751e
commit 9c30602230
2 changed files with 12 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
.github/actions/spelling/allow/keywords.txt vendored
View File

@@ -14,6 +14,7 @@ CAGLESMM
Caju Caju
caniuse caniuse
Cardless Cardless
CAROOT
categorygroup categorygroup
Cembra Cembra
Certbot Certbot

11
docs/config/https.md
View File

@@ -39,5 +39,16 @@ If using a Docker container, this folder is `/data` within the container. If you
### Configuring with environment variables: ### 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. 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.
### Configuring the Desktop App:
To configure the desktop app, follow these steps on the _Where's the server?_ screen.
1. Enter your server URL and click OK.
2. If you see an error message asking you to select your certificate, choose the appropriate certificate and try again.
**Note:** If you have generated your certificate using [mkcert](https://github.com/FiloSottile/mkcert), specify the root CA certificate - not the certificate your server is pointing to. To do this:
1. Run the command ```mkcert -CAROOT``` to find the directory of the root certificate.
2. Navigate to that directory to locate the ```rootCA.pem``` certificate
3. Specify the ```rootCA.pem``` certificate in the desktop app.
## 3. Test HTTPS! ## 3. Test HTTPS!
Once you have acquired a certificate and configured Actual to use it, attempt to access your instance ensuring you are using `https`. It is recommended to also either re-enter the URL to your server or making a new tab/window instead of refreshing the page where you saw the error. Once you have acquired a certificate and configured Actual to use it, attempt to access your instance ensuring you are using `https`. It is recommended to also either re-enter the URL to your server or making a new tab/window instead of refreshing the page where you saw the error.