mirror of
https://github.com/invoiceninja/dockerfiles.git
synced 2025-12-31 19:47:25 +01:00
90 lines
3.4 KiB
Markdown
90 lines
3.4 KiB
Markdown
|
|
[](https://hub.docker.com/r/invoiceninja/invoiceninja)
|
|
[](https://hub.docker.com/r/invoiceninja/invoiceninja)
|
|
|
|
# Docker for [Invoice Ninja](https://www.invoiceninja.com/)
|
|
|
|
:crown: **Features**
|
|
|
|
:lock: Automatic HTTPS (:heart: [Caddy](https://caddyserver.com/))
|
|
:fire: NGINX webserver support [NGINX](https://nginx.org/)
|
|
:hammer: Fully production-ready through docker-compose
|
|
:pencil: Adjustable to your needs via environment variable
|
|
|
|
## You want some Kubernetes + Helm with that?
|
|
[Helm Chat](https://github.com/Saddamus/invoiceninja-helm) by @Saddamus
|
|
[Kubernetes](https://github.com/invoiceninja/dockerfiles/issues/94) by @spacepluk
|
|
|
|
## Quickstart V5 Launch
|
|
|
|
The dockerfile has been revamped to make is easier to get started, by default the base image selected in 5 which will pull in the latest v5 stable image.
|
|
|
|
```bash
|
|
git clone https://github.com/invoiceninja/dockerfiles.git
|
|
cd dockerfiles
|
|
```
|
|
|
|
Instead of defining our environment variables inside our docker-compose.yml file we now define this in the ```env``` file, open this file up and insert your APP_URL and your APP_KEY
|
|
|
|
```
|
|
APP_URL=http://in.localhost:8003/
|
|
APP_KEY=<insert your generated key in here>
|
|
APP_DEBUG=true
|
|
MULTI_DB_ENABLED=false
|
|
DB_HOST1=db
|
|
DB_PORT1=3306
|
|
DB_USERNAME1=ninja
|
|
DB_PASSWORD1=ninja
|
|
DB_DATABASE1=ninja
|
|
PHANTOMJS_PDF_GENERATION=false
|
|
```
|
|
|
|
The ```APP_KEY``` can be generated by running
|
|
|
|
```
|
|
docker run --rm -it invoiceninja/invoiceninja php artisan key:generate --show
|
|
```
|
|
|
|
Copy the entire string and insert in the env file at ```APP_KEY=base64....```
|
|
|
|
To ensure folder permissions are correct when the container comes up for the first time it is important that you set the correct folder permissions on the ```docker``` folder.
|
|
|
|
From the terminal run
|
|
|
|
```sudo chown -R 1500:1500 docker/app```
|
|
|
|
## Updating the image when using `docker-compose`
|
|
|
|
As `docker-compose` does not support any form of version control, this git provide updates to `docker-compose.yml` directly.
|
|
|
|
To upgrade to a newer release image, please make sure to update the `docker-compose.yml` first by running
|
|
|
|
```bash
|
|
git pull
|
|
```
|
|
|
|
You may need to manually merge any changes that cannot be merged automatically by git.
|
|
|
|
### Note for people running the container locally on their PC ###
|
|
|
|
If you are running the container locally, then the container will need to resolve the host, to support this you will want to insert your LAN IP address and the host name in the hosts file located in ```config/hosts```
|
|
|
|
For example, lets say your APP_URL is ```http://in5.test:8000``` and your LAN IP is 192.168.0.124 the hosts file will have an entry looking like this:
|
|
|
|
|
|
```192.168.0.124 in5.test```
|
|
|
|
**Please note that PDF generation using local host your domain name MUST end in .test for your PDFs to generate correctly, this is a DNS resolver issue with chromium.
|
|
|
|
All that is left to do now is bring up the container
|
|
|
|
|
|
``` docker-compose up -d```
|
|
|
|
|
|
**Note: When performing the setup, the Database host is ```db```
|
|
|
|
## Support
|
|
|
|
If you discover a bug, please create and issue, if you query is general in nature please visit us on our [Forum ](https://forum.invoiceninja.com/)
|