wululu_web/invoiceninja-docker
3
0
Fork 0
mirror of https://github.com/invoiceninja/dockerfiles.git synced 2025-12-31 19:47:25 +01:00
Code Issues Packages Projects Releases Wiki Activity

Readme formatting

Browse Source
This commit is contained in:
David Bomba
2024-11-23 14:24:14 +11:00
parent 8ff82909c8
commit 2b8bb21d04
1 changed files with 21 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
README.md
View File

@@ -8,10 +8,10 @@
:crown: **Features** :crown: **Features**
NGINX webserver support [NGINX](https://nginx.org/) NGINX webserver support [NGINX](https://nginx.org/)
Built-in Chrome for PDF generation and other features Built-in Chrome for PDF generation and other features
Saxon XLST 2 engine Saxon XLST 2 engine
OPcache OPcache
Multi language support Multi language support
## Get started with Docker Compose ## Get started with Docker Compose
@@ -33,9 +33,19 @@ IN_USER_EMAIL=
IN_PASSWORD= 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 ```bash
# If you haven't started the containers yet: # 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 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. **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 ### Todo
This is a new image which should provide much better support for all users, however there are some items left to complete This is a new image which should provide much better support for all users, however there are some items left to complete
[] Backup script
[] Backup script
[] Integrate soketi server
[] Add elastic search for site wide search