Skip to content

Commit

Permalink
Update Readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
kiwimato committed Jul 20, 2022
1 parent 3e59b3f commit 5491ed8
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,17 +17,20 @@ Of course, if you already have a SQL user you can use that or create one specifi
On the first run, self-signed certificates are automatically generated under this folder if they don't already exist.
You can either replace them with SWAG ones, or import the self signed certificates into your preferred browser. More in [SSL certificates](#SSL)

:warning: `APP_URL` variable MUST be set properly on the first run. If you have to change it for some reason, you will have to DROP the DB and recreate everything, so please make sure to set it up properly from start.
It must be a URL, for example: `https://superninja.com:8443`.
The automated self signed certificates are generated on this FQDN, but of course SWAG certificate must also match this, otherwise SSL errors will break the UI even if you ignore the certificate error.
:warning: `APP_URL` variable MUST be set properly on the first run. If you have to change it for some reason, you will have to DROP the DB and recreate everything, so please make sure to set it up properly from start. It must be a URL, for example: `https://superninja.com:8443`.

As long as these things above are kept in mind, this should work on the first run.

If anything is not clear enough, feel free to raise issues here.

## SSL
I found disabling HTTPS to be quite buggy, so there is a script which will auto generate SSL certificates in `certs/` folder in Storage: `/mnt/user/appdata/invoiceninjav5/storage/certs` on UnRAID level.

A certificate will be created with the `CN` = `$SSL_HOSTNAME` env variable, which has the default value of `Tower`: `invoiceninja.crt` and `invoiceninja.key`.
To properly use InvoiceNinja you'll have to import the certificate in your browser as a CA, otherwise I found requests to fail.

I strongly recommend using LetsEncrypt or SWAG on UnRAID and then you can simply create/overwrite `invoiceninja.crt` with `fullchain.pem` and also the same thing for the key, of course.
I strongly recommend using LetsEncrypt or SWAG on UnRAID and then you can simply create/overwrite `invoiceninja.crt` with `fullchain.pem` and also the same thing for the key, of course. Just to clarify, you don't need to route traffic through SWAG, even though you can. Personally, I just copy the certificates from SWAG.

Note: `APP_URL` env variable should be the form of `https://domain.com[:port]`. For example: `https://supercool.com:8443`

Personally, I use SWAG, and I just copy over the certifcates daily by using User Scripts UnRAID plugin:
Expand Down

0 comments on commit 5491ed8

Please sign in to comment.