diff --git a/README.md b/README.md index b0d0f66..fc022d3 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,17 @@ -[![Docker image, latest](https://img.shields.io/docker/image-size/invoiceninja/invoiceninja-debian/latest?label=latest)](https://hub.docker.com/r/invoiceninja/invoiceninja-debian) -[![Docker image, debian](https://img.shields.io/docker/image-size/invoiceninja/invoiceninja-debian/debian?label=debian)](https://hub.docker.com/r/invoiceninja/invoiceninja-debian) -[![Artifact HUB](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/invoiceninja)](https://artifacthub.io/packages/search?repo=invoiceninja) -[![Publish Image](https://github.com/invoiceninja/dockerfiles/blob/debian/.github/workflows/publish-image.yaml/badge.svg)]([https://github.com/invoiceninja/dockerfiles/actions/workflows/publish-image.yaml](https://github.com/invoiceninja/dockerfiles/blob/debian/.github/workflows/publish-image.yaml)) -[![Build Debian Image](https://github.com/invoiceninja/dockerfiles/blob/debian/.github/workflows/build-image-debian.yaml/badge.svg)]([https://github.com/invoiceninja/dockerfiles/actions/workflows/build-image-debian.yaml](https://github.com/invoiceninja/dockerfiles/blob/debian/.github/workflows/build-image-debian.yaml)) - - -[![Docker Image Size (debian)](https://img.shields.io/docker/image-size/invoiceninja/invoiceninja-debian/latest?label=debian)](https://hub.docker.com/r/invoiceninja/invoiceninja-debian) +[![Docker Image Size](https://img.shields.io/docker/image-size/invoiceninja/invoiceninja-debian?label=debian)](https://hub.docker.com/r/invoiceninja/invoiceninja-debian) [![Docker Pulls](https://img.shields.io/docker/pulls/invoiceninja/invoiceninja-debian)](https://hub.docker.com/r/invoiceninja/invoiceninja-debian) -[![Docker Stars](https://img.shields.io/docker/stars/invoiceninja/invoiceninja-debian)](https://hub.docker.com/r/invoiceninja/invoiceninja-debian) -[![Build Status](https://github.com/invoiceninja/debian-invoice-ninja/actions/workflows/build-image-debian.yaml/badge.svg)](https://github.com/invoiceninja/debian-invoice-ninja/actions/workflows/build-image-debian.yaml) -[![Publish Status](https://github.com/invoiceninja/debian-invoice-ninja/actions/workflows/publish-image.yaml/badge.svg)](https://github.com/invoiceninja/debian-invoice-ninja/actions/workflows/publish-image.yaml) +[![Publish Status](https://github.com/invoiceninja/dockerfiles/actions/workflows/publish-image.yaml/badge.svg)](https://github.com/invoiceninja/dockerfiles/actions/workflows/publish-image.yaml) +[![Build Status](https://github.com/invoiceninja/dockerfiles/actions/workflows/build-image-v5.yaml/badge.svg)](https://github.com/invoiceninja/dockerfiles/actions/workflows/build-image-v5.yaml) # Debian Docker for [Invoice Ninja](https://www.invoiceninja.com/) :crown: **Features** -:fire: NGINX webserver support [NGINX](https://nginx.org/) -:chrome: Built-in Chrome for PDF generation and other 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 ## Get started with Docker Compose @@ -38,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: @@ -50,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,3 +82,12 @@ It is recommended to perform a backup before updating. ### Support If you discover a bug, please create an issue. For general queries, visit our [Forum](https://forum.invoiceninja.com/) + + +### 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 +- [ ] Integrate soketi server +- [ ] Add elastic search for site wide search \ No newline at end of file diff --git a/debian/docker-compose.yml b/debian/docker-compose.yml index e1d57cb..8ba783c 100644 --- a/debian/docker-compose.yml +++ b/debian/docker-compose.yml @@ -8,8 +8,7 @@ x-logging: &default-logging services: app: - # image: deb40d:latest - image: invoiceninja/invoiceninja-debian:latest + image: invoiceninja/invoiceninja-debian:5 restart: unless-stopped env_file: - ./.env @@ -36,7 +35,7 @@ services: image: nginx:alpine restart: unless-stopped ports: - - "8013:80" + - "80:80" volumes: - ./nginx/conf.d:/etc/nginx/conf.d:ro - ./nginx/nginx.conf:/etc/nginx/nginx.conf:ro