anthochamp/invoiceninja

自托管Invoice Ninja容器镜像

官方容器镜像的替代方案，源代码托管于https://github.com/anthochamp/container-invoiceninja%E3%80%82

• 镜像标签
• 如何使用本镜像
• 应用配置
  • 初始账户
  • Ninja配置
• 框架配置
  • 应用基本设置
  • 广播配置
  • 缓存配置
  • 数据库配置
  • 文件存储配置
  • 安全配置
  • 日志配置
  • 邮件配置
  • 队列配置
  • 会话配置
• 第三方集成
  • Ably
  • Amazon（通用）
  • Amazon DynamoDB
  • Amazon S3
  • Amazon SES
  • Amazon SQS
  • Brevo
  • Cloudflare R2
  • GoCardless（原Nordigen）
  • Google Cloud（通用）
  • Google Cloud Storage
  • Google Mail
  • Mailgun
  • Microsoft Office 365
  • memcached

镜像标签

• x.y.z-invoiceninjaA.B.C：容器镜像版本为x.y.z，嵌入Invoice Ninja版本A.B.C。
• edge-invoiceninjaA.B.C：基于仓库最新提交构建的容器镜像，嵌入Invoice Ninja版本A.B.C。

标签别名：

• x.y-invoiceninjaA.B.C：别名容器镜像x.y主版本+次版本的最新补丁版本，嵌入Invoice Ninja版本A.B.C；
• x-invoiceninjaA.B.C：别名容器镜像x主版本的最新次版本+补丁版本，嵌入Invoice Ninja版本A.B.C；
• x.y.z：别名嵌入最新Invoice Ninja版本的x.y.z容器镜像版本（注：仅最新容器镜像版本会更新）；
• x.y：别名容器镜像x.y主版本+次版本的最新补丁版本，嵌入最新Invoice Ninja版本（注：仅最新容器镜像主版本+次版本会更新）；
• x：别名容器镜像x主版本的最新次版本+补丁版本，嵌入最新Invoice Ninja版本（注：仅最新容器镜像主版本会更新）；
• invoiceninjaA.B：别名最新容器镜像版本，嵌入Invoice Ninja A.B主版本+次版本的最新补丁版本；
• invoiceninjaA：别名最新容器镜像版本，嵌入Invoice Ninja A主版本的最新次版本+补丁版本；
• latest：别名最新的x.y.z-invoiceninjaA.B.C标签；
• edge-invoiceninjaA.B：别名基于仓库最新提交构建的容器镜像，嵌入Invoice Ninja A.B主版本+次版本的最新补丁版本；
• edge-invoiceninjaA：别名基于仓库最新提交构建的容器镜像，嵌入Invoice Ninja A主版本的最新次版本+补丁版本；
• edge：别名最新的edge-invoiceninjaA.B.C标签。

如何使用本镜像

首先，需要生成应用密钥：

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

然后执行以下命令：

shell
docker run -p 1234:80 anthochamp/invoiceninja

通过浏览器访问 http://localhost:1234 进行测试。

应用配置

除了通过环境变量传递敏感信息外，可在以下任一环境变量后添加__FILE，使初始化脚本从容器内的文件加载变量值。

尤其适用于从Docker密钥（存储在/run/secrets/<secret_name>文件中）加载值，例如：IN_INITIAL_ACCOUNT_PASSWORD__FILE=/run/secrets/initial_password。

初始账户

IN_INITIAL_ACCOUNT_EMAIL

默认值：空

初始账户***。

IN_INITIAL_ACCOUNT_PASSWORD

默认值：空

初始账户密码。

Ninja配置

参考：

• https://github.com/invoiceninja/invoiceninja/blob/v5-stable/config/ninja.php

框架配置

除了通过环境变量传递敏感信息外，可在以下任一环境变量后添加__FILE，使初始化脚本从容器内的文件加载变量值。

尤其适用于从Docker密钥（存储在/run/secrets/<secret_name>文件中）加载值，例如：MAIL_PASSWORD=/run/secrets/mail_password。

应用基本设置

参考：

• https://github.com/invoiceninja/invoiceninja/blob/v5-stable/config/app.php

APP_NAME

默认值：Invoice Ninja

应用名称。

APP_DEBUG

默认值：false

是否开启调试模式。

APP_URL

默认值：http://localhost

应用访问URL。

SERVER_TIMEZONE

默认值：UTC

服务器时区，可能值参考PHP文档。

DEFAULT_LOCALE

默认值：en

默认语言 locale。

APP_KEY

默认值：空

必须使用以下命令生成：

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

广播配置

参考：

• https://github.com/invoiceninja/invoiceninja/blob/v5-stable/config/broadcasting.php
• Laravel广播文档

BROADCAST_DRIVER

默认值：log

REDIS_BROADCAST_CONNECTION

默认值：default

选择用于广播的Redis配置。

缓存配置

参考：

• https://github.com/invoiceninja/invoiceninja/blob/v5-stable/config/cache.php
• Laravel缓存文档

CACHE_DRIVER

默认值：file

DYNAMODB_CACHE_TABLE

默认值：cache

DynamoDB缓存表名称。

REDIS_CACHE_CONNECTION

默认值：cache

选择用于缓存的Redis配置。

CACHE_PREFIX

默认值：${APP_NAME}_cache_（使用APP_NAME的slug形式）

缓存键前缀。

数据库配置

参考：

• https://github.com/invoiceninja/invoiceninja/blob/v5-stable/config/database.php
• Laravel数据库文档

可用数据库连接配置：

DB_CONNECTION

默认值：mysql

选择默认数据库配置。

DB_HOST

默认值：127.0.0.1

数据库主机地址。

DB_PORT

默认值：

数据库端口。

DB_DATABASE

默认值：

数据库名称（SQLite为文件路径）。

DB_USERNAME

默认值：invoiceninja

数据库用户名。

DB_PASSWORD

默认值：空

数据库密码。

文件存储配置

参考：

• https://github.com/invoiceninja/invoiceninja/blob/v5-stable/config/filesystems.php
• Laravel文件存储文档

FILESYSTEM_DISK

默认值：public

可用存储磁盘配置：

安全配置

参考：

• https://github.com/invoiceninja/invoiceninja/blob/v5-stable/config/hashing.php
• https://github.com/invoiceninja/invoiceninja/blob/v5-stable/config/ninja.php

BCRYPT_ROUNDS

默认值：12

密码哈希迭代次数，应根据应用资源配置调整。

参考：

• <[***]>
• 通用场景详细解释：<[***]>

TRUSTED_PROXIES

默认值：空

受信任代理服务器。

日志配置

参考：

• https://github.com/invoiceninja/invoiceninja/blob/v5-stable/config/logging.php
• Laravel日志文档

可用日志通道配置：

LOG_CHANNEL

默认值：errorlog

设置默认日志通道配置。

LOG_LEVEL

默认值：

可用日志级别遵循RFC 5424规范：emergency、alert、critical、error、warning、notice、info和debug。

LOG_SLACK_WEBHOOK_URL

默认值：空

仅slack配置相关，Slack Webhook URL。

PAPERTRAIL_URL

默认值：空

仅papertrail配置相关，IP/主机名或unix socket路径（此时PAPERTRAIL_PORT必须为0）。

PAPERTRAIL_PORT

默认值：空

仅papertrail配置相关，端口号，若PAPERTRAIL_URL为unix socket则为0。

LOG_STDERR_FORMATTER

默认值：空

仅stderr配置相关，https://github.com/Seldaek/monolog/blob/main/doc/02-handlers-formatters-processors.md#formatters%E7%B1%BB%E7%9A%84%E5%AE%8C%E5%85%A8%E9%99%90%E5%AE%9A%E5%90%8D%EF%BC%88%E4%BE%8B%E5%A6%82%60Monolog%5CFormatter%5CLineFormatter%60%EF%BC%89%E3%80%82%E6%B3%A8%E6%84%8Fshell%E4%B8%AD%E7%9A%84%60%5C%60%E9%9C%80%E8%BD%AC%E4%B9%89%EF%BC%8C%E5%AE%9E%E9%99%85%E7%8E%AF%E5%A2%83%E5%8F%98%E9%87%8F%E5%80%BC%E5%BA%94%E4%B8%BA%60Monolog%5C%5CFormatter%5C%5CLineFormatter%60%E3%80%82

GRAYLOG_SERVER

默认值：127.0.0.1

仅graylog配置相关，Gelf服务器的IP/主机名。传输参数硬编码为UDP，远程端口***。

邮件配置

参考：

• [config/mail.php](https://github.com/invoicenin