From 2b8bb21d04d686741417522b801aaf7fd555b28b Mon Sep 17 00:00:00 2001 From: David Bomba Date: Sat, 23 Nov 2024 14:24:14 +1100 Subject: [PATCH] Readme formatting --- README.md | 29 +++++++++++++++++++++-------- 1 file changed, 21 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index e7bdaaa..cb026e5 100644 --- a/README.md +++ b/README.md @@ -8,10 +8,10 @@ :crown: **Features** NGINX webserver support [NGINX](https://nginx.org/) -Built-in Chrome for PDF generation and other features -Saxon XLST 2 engine -OPcache -Multi language support +Built-in Chrome for PDF generation and other features +Saxon XLST 2 engine +OPcache +Multi language support ## Get started with Docker Compose @@ -33,9 +33,19 @@ IN_USER_EMAIL= IN_PASSWORD= ``` -If `IN_USER_EMAIL` and `IN_PASSWORD` is not set the default user email and password is "admin@example.com" and "changeme!" respectively. You will use this for the initial login, thereafter, you can delete these two environment variables. +## Initial account setup -The `APP_KEY` can be generated by running +### Primary account setup +Prior to starting the container for the first time, open the .env file and update the IN_USER_EMAIL and IN_PASSWORD variables with your primary account. + +This will take care of the initial account setup. You can later remove these .env variables. + +> ⚠️ **Warning** +> If `IN_USER_EMAIL` and `IN_PASSWORD` is not set the default user email and password is "admin@example.com" and "changeme!" respectively. You will use this for the initial login, thereafter, you can delete these two environment variables. + +### Generate a APP_KEY + +The `APP_KEY` can be generated by running: ```bash # If you haven't started the containers yet: @@ -45,7 +55,7 @@ docker run --rm -it invoiceninja/invoiceninja-debian php artisan key:generate -- docker-compose exec app php artisan key:generate --show ``` -Copy the entire string and insert in the env file at `APP_KEY=base64....` +Copy the entire string and insert in the .env file at `APP_KEY=base64....` **Note: For PDF generation using localhost, your domain name MUST end in .test for PDFs to generate correctly due to Chrome's DNS resolver. @@ -77,4 +87,7 @@ If you discover a bug, please create an issue. For general queries, visit our [F ### Todo This is a new image which should provide much better support for all users, however there are some items left to complete -[] Backup script \ No newline at end of file + +[] Backup script +[] Integrate soketi server +[] Add elastic search for site wide search \ No newline at end of file