anthochamp/invoiceninja

By anthochamp

•Updated about 1 hour ago

Self-hosted Invoice Ninja

Image

10K+

Overview Tags

anthochamp/invoiceninja repository overview

⁠Self-hosted Invoice Ninja container images

Alternative to the official container images⁠.

Sources are available on GitHub⁠.

⁠Image tags

x.y.z-invoiceninjaA.B.C tags the x.y.z container image version, embedded with the Invoice Ninja A.B.C version.
edge-invoiceninjaA.B.C tags the container image built from the last repository commit, embedded with the Invoice Ninja A.B.C version.

Tags aliases :

x.y-invoiceninjaA.B.C aliases the latest patch version of the container image x.y major+minor version, embedded with the Invoice Ninja A.B.C version;
x-invoiceninjaA.B.C aliases the latest minor+patch version of the container image x major version, embedded with the Invoice Ninja A.B.C version;
x.y.z aliases the x.y.z container image version embedded with the latest Invoice Ninja version (Note: only the latest container image version gets updated);
x.y aliases the latest patch version of the container image x.y major+minor version, embedded with the latest Invoice Ninja release (Note: only the latest container image major+minor version gets updated);
x aliases the latest minor+patch version of the container image x major version, embedded with the latest Invoice Ninja version (Note: only the latest container image major version gets updated);
invoiceninjaA.B aliases the latest container image version, embedded with the latest patch version of the Invoice Ninja A.B major+minor version;
invoiceninjaA aliases the latest container image version, embedded with the latest minor+patch version of the Invoice Ninja A major version;
latest aliases the latest x.y.z-invoiceninjaA.B.C tag;
edge-invoiceninjaA.B aliases the container image built from the last repository commit, embedded with the latest patch version of the Invoice Ninja A.B major+minor version;
edge-invoiceninjaA aliases the container image built from the last repository commit, embedded with the latest minor+patch version of the Invoice Ninja A major version.
edge aliases the latest edge-invoiceninjaA.B.C tag;

⁠How to use this image

First, you'll need to generate an application key :

docker run --rm -it anthochamp/invoiceninja php artisan key:generate --show

Then, execute the following command :

docker run -p 1234:80 anthochamp/invoiceninja

And test it by opening a browser to http://localhost:1234⁠.

⁠Application configuration

As an alternative to passing sensitive information via environment variables, __FILE may be appended to any of the listed environment variables below, causing the initialization script to load the values for those variables from files present in the container.

In particular, this can be used to load values from Docker secrets stored in /run/secrets/<secret_name> files. For example : IN_INITIAL_ACCOUNT_PASSWORD__FILE=/run/secrets/initial_password.

⁠Initial account

⁠IN_INITIAL_ACCOUNT_EMAIL

Default: empty

⁠IN_INITIAL_ACCOUNT_PASSWORD

Default: empty

⁠Ninja

References:

config/ninja.php⁠

⁠Framework configuration

In particular, this can be used to load values from Docker secrets stored in /run/secrets/<secret_name> files. For example : MAIL_PASSWORD=/run/secrets/mail_password.

⁠Application

References:

config/app.php⁠

⁠APP_NAME

Default: Invoice Ninja

⁠APP_DEBUG

Default: false

⁠APP_URL

Default: http://localhost

⁠SERVER_TIMEZONE

Default: UTC

Refer to PHP documentation⁠ for possible values.

⁠DEFAULT_LOCALE

Default: en

⁠APP_KEY

Default: empty

Must be generated using the following command :

docker run --rm -it anthochamp/invoiceninja php artisan key:generate --show

⁠Broadcasting

References:

⁠BROADCAST_DRIVER

Default: log

Driver	Description	Parameters
`ably`	Ably⁠	See Third party > Ably⁠
`log`	Should only be used for local development and debugging.
`pusher`	Pusher Channels⁠	see Third party > Pusher Channels⁠
`redis`	Redis⁠	`REDIS_BROADCAST_CONNECTION`⁠

⁠REDIS_BROADCAST_CONNECTION

Default: default

Selects a Redis configuration⁠ for broadcasting.

⁠Cache

⁠CACHE_DRIVER

Default: file

Driver	Description	Parameters
`database`	Uses a database table for caching. The default database connection configuration specified in `DB_CONNECTION`⁠ will be used.	`CACHE_PREFIX`⁠, `DB_CONNECTION`⁠
`dynamodb`	Uses a AWS DynamoDB table for caching.	`CACHE_PREFIX`⁠, `DYNAMODB_CACHE_TABLE`⁠, and Third party > Amazon DynamoDB⁠
`file`	Uses local files stored in `framework/cache/data` for caching.
`memcached`	Uses a memcached instance for caching.	`CACHE_PREFIX`⁠, and Third party > memcached⁠
`redis`	Uses a Redis instance for caching.	`CACHE_PREFIX`⁠, `REDIS_CACHE_CONNECTION`⁠

⁠DYNAMODB_CACHE_TABLE

Default: cache

⁠REDIS_CACHE_CONNECTION

Default: cache

Selects a Redis configuration⁠ for caching.

⁠CACHE_PREFIX

Default: ${APP_NAME}_cache_ (with the slug version of APP_NAME)

⁠Database

References:

Available database connection configurations:

Configuration	Description	Parameters
`mysql`	MySQL / MariaDB database connection	`DB_HOST`⁠, `DB_PORT`⁠, `DB_DATABASE`⁠, `DB_USERNAME`⁠, `DB_PASSWORD`⁠
`pgsql`	Postgres database connection	`DB_HOST`⁠, `DB_PORT`⁠, `DB_DATABASE`⁠, `DB_USERNAME`⁠, `DB_PASSWORD`⁠
`sqlite`	SQLite database connection	`DB_DATABASE`⁠
`sqlsrv`	SQL Server database connection	`DB_HOST`⁠, `DB_PORT`⁠, `DB_DATABASE`⁠, `DB_USERNAME`⁠, `DB_PASSWORD`⁠

⁠DB_CONNECTION

Default: mysql

Selects the default database configuration.

⁠DB_HOST

Default: 127.0.0.1

⁠DB_PORT

Default:

Configuration	Default value
`mysql`	`3306`
`pgsql`	`5432`
`sqlsrv`	`1433`

⁠DB_DATABASE

Default:

Configuration	Default value
`mysql`, `pgsql` and `sqlsrv`	`invoiceninja`
`sqlite`	`database.sqlite`

⁠DB_USERNAME

Default: invoiceninja

⁠DB_PASSWORD

Default: empty

⁠File Storage

References:

⁠FILESYSTEM_DISK

Default: public

Available disk configurations:

Configuration	Description	Parameters
`public`	Stores in `app/public` directory
`s3`	Amazon S3	See Third party > Amazon S3⁠
`r2`	Cloudflare R2	Third party > Cloudflare R2⁠
`gcs`	Google Cloud Storage	Third party > Google Cloud Storage⁠

⁠Security

References:

⁠BCRYPT_ROUNDS

Default: 12

This value should depend on the allocated resource for the application.

References:

https://php.watch/versions/8.4/password_hash-bcrypt-cost-increase⁠
A detailed explanation for a generic case : https://security.stackexchange.com/questions/3959/recommended-of-iterations-when-using-pbkdf2-sha256/3993#3993⁠

⁠TRUSTED_PROXIES

Default: empty

⁠Logging

References:

Available logging channel configurations :

Configuration	Description	Parameters
`invoiceninja`	Logs records into `logs/invoiceninja.log` with a 7 days retention policy	`LOG_LEVEL`⁠
`invoiceninja-reminders`	Logs records into `logs/invoiceninja-reminders.log` with a 90 days retention policy	`LOG_LEVEL`⁠
`stack`	Multi-channel (configured for `single`)
`single`	Logs records into `logs/laravel.log`	`LOG_LEVEL`⁠
`daily`	Logs records into `logs/laravel.log` (rotated daily) with a 14 days retention policy	`LOG_LEVEL`⁠
`slack`	Logs records to a Slack account using Slack Webhooks. The Bot name is `Laravel Log`.	`LOG_LEVEL`⁠, `LOG_SLACK_WEBHOOK_URL`⁠
`papertrail`	Logs records to a remote Syslogd server.	`LOG_LEVEL`⁠, `PAPERTRAIL_URL`⁠, `PAPERTRAIL_PORTL`⁠
`stderr`	Logs records into the stderr PHP stream with an optional formatter.	`LOG_LEVEL`⁠, `LOG_STDERR_FORMATTER`⁠
`syslog`	Logs records to the syslog.	`LOG_LEVEL`⁠
`errorlog`	Logs records into the stderr PHP stream.	`LOG_LEVEL`⁠
`null`	No logs
`graylog`	Logs records to a Gelf server.	`GRAYLOG_SERVER`⁠

⁠LOG_CHANNEL

Default: errorlog

Sets the default logging channel configuration.

⁠LOG_LEVEL

Default:

Configuration	Default value
`invoiceninja`	`debug`
`invoiceninja-reminders`	`debug`
`stack`	-
`single`	`debug`
`daily`	`debug`
`slack`	`critical`
`papertrail`	`debug`
`stderr`	`debug`
`syslog`	`debug`
`errorlog`	`debug`
`null`	-
`graylog`	`debug` (hard-coded)

Available log levels follows RFC 5424 specification⁠ : emergency, alert, critical, error, warning, notice, info and debug.

⁠LOG_SLACK_WEBHOOK_URL

Default: empty

Relevant only for the slack configuration.

Slack Webhook URL.

⁠PAPERTRAIL_URL

Default: empty

Relevant only for the papertrail configuration.

Either IP/hostname or a path to a unix socket (PAPERTRAIL_PORT must be 0 then).

⁠PAPERTRAIL_PORT

Default: empty

Relevant only for the papertrail configuration.

Port number, or 0 if PAPERTRAIL_URL is a unix socket.

⁠LOG_STDERR_FORMATTER

Default: empty

Relevant only for the stderr configuration.

The fully qualified name of the monolog formatter⁠ class (eg. Monolog\Formatter\LineFormatter). Be aware of the \ character in shell, it is used for escaping. The actual environment value should be Monolog\\Formatter\\LineFormatter.

⁠GRAYLOG_SERVER

Default: 127.0.0.1

Relevant only for the graylog configuration.

IP/hostname of the Gelf server. Other transport parameters are hard-coded : UDP on remote port 12201.

⁠Mail

References:

Available mailer configurations :

Configuration	Description	Parameters
`smtp`	SMTP server	`MAIL_HOST`⁠, `MAIL_PORT`⁠, `MAIL_ENCRYPTION`⁠, `MAIL_USERNAME`⁠, `MAIL_PASSWORD`⁠, `MAIL_EHLO_DOMAIN`⁠, `MAIL_VERIFY_PEER`⁠
`ses`	Amazon SES	See Third party > Amazon SES⁠
`mailgun`	Mailgun⁠	See Third party > Mailgun⁠
`brevo`	Brevo⁠	See Third party > Brevo⁠
`postmark`	Postmark⁠	See Third party > Postmark⁠
`log`	Dry-send to log	`MAIL_LOG_CHANNEL`⁠
`gmail`	GMail⁠	See Third party > Google Mail⁠
`office365`	Office 365⁠	See Third party > Microsoft Office 365⁠
`failover`	Use `smtp` configuration by default or `log` on `smtp` failure