Quick install
The quick install bundles Augias, PHP, and a webserver into a single self-contained download. It is the fastest way to get a production-ready instance running and is the recommended install method for most users.
System requirementsβ
- 64-bit Linux (
x86_64orarm64) or macOS (Intel or Apple Silicon). - A database β SQLite works out of the box; MySQL, MariaDB, or PostgreSQL are also supported.
You do not need PHP, Composer, Nginx, Apache, or a separate cron job β the bundled webserver and worker handle all of it.
There is no native Windows build. Run the Linux binary inside WSL2 instead.
Download and runβ
- Linux
- macOS
One-liner install β downloads the binary and installs it to /usr/local/bin:
curl -fsSL https://raw.githubusercontent.com/herc-si/Augias/main/packaging/install.sh | sh
augias run
To also install a systemd service so Augias starts on boot:
curl -fsSL https://raw.githubusercontent.com/herc-si/Augias/main/packaging/install.sh | INSTALL_SERVICE=1 sh
Manual download β grab the binary for your architecture from the releases page, then make it executable and start it:
chmod +x augias
./augias run
Download the latest binary for your architecture from the releases page, then make it executable and start it:
chmod +x augias
./augias run
On first launch macOS may block the binary because it isn't notarised. Open System Settings β Privacy & Security and click Open anyway, or run xattr -d com.apple.quarantine ./augias first.
On macOS, Homebrew is the easiest way to install and keep Augias up to date.
The application starts on https://localhost:8765 with a self-signed certificate. Open the URL in your browser and continue with the first-run wizard.
Recurring tasks (such as recurring invoices) and async work (email sending) run automatically β there is no separate cron job or messenger consumer to set up.
SSLβ
The application uses Caddy under the hood, so HTTPS is enabled by default.
Self-signed (default)β
./augias run
Useful for local testing. Browsers will show a warning that you have to accept once.
Let's Encrypt (recommended for production)β
./augias run --domain=invoice.example.com --lets-encrypt
Issues and renews a free SSL certificate from Let's Encrypt automatically. Requirements:
- The domain's DNS
A/AAAArecord must point at the server's public IP. - Ports
80and443must be reachable from the public internet (Let's Encrypt validates ownership over them).
Custom certificateβ
./augias run \
--domain=invoice.example.com \
--ssl-cert=/etc/ssl/augias.pem \
--ssl-key=/etc/ssl/augias.key
Use this when you already have a certificate (wildcard, EV, or one issued by a corporate CA).
Behind a reverse proxyβ
./augias run --disable-https
Use when an upstream proxy (Cloudflare, Nginx, an ingress controller) terminates TLS for you. Augias listens over plain HTTP and trusts the proxy's X-Forwarded-* headers.
Available flagsβ
All flags below apply to the run command.
| Flag | Default | Description |
|---|---|---|
--domain <name> | (none) | Public hostname. Required for --lets-encrypt and --ssl-cert. |
--port <port> | 8765 | Port to listen on. |
--server-ip <ip> | (auto-detected) | Bind to a specific local IP. By default the server binds to all interfaces. |
--lets-encrypt | false | Issue and auto-renew a Let's Encrypt certificate. Requires --domain. |
--ssl-cert <path> | (none) | Path to a custom certificate (PEM). Requires --ssl-key and --domain. |
--ssl-key <path> | (none) | Path to the certificate's private key. Requires --ssl-cert and --domain. |
--disable-https | false | Serve plain HTTP. Use behind a reverse proxy. |
--worker-mode | false | Enable FrankenPHP worker mode for higher throughput (keeps PHP alive between requests). |
--worker-threads <n> | 2 | Number of FrankenPHP worker threads when --worker-mode is enabled. |
--messenger-workers <n> | 1 | Number of background async workers. Set to 0 to run no workers in this process. |
--log-format <format> | console | console for human-readable output, json for structured logs. |
--enable-metrics | false | Expose a Prometheus metrics endpoint at /metrics on a dedicated port. |
--metrics-port <port> | 9090 | Port for the metrics endpoint. |
--skip-intro | false | Suppress the boot banner. |
Other commandsβ
./augias console <command> # run any Symfony console command (e.g. cache:clear)
./augias worker --workers=2 # dedicated messenger worker process (e.g. for Kubernetes)
./augias version # print the version
./augias build-info # print build details
Health checkβ
curl http://localhost:8765/health
Returns OK (HTTP 200) when the application is running.
Updatingβ
Replace the binary with the latest release and restart it. Your data lives apart from the binary, so updates don't touch your invoices, clients, or settings:
| System | Configuration and SQLite database | Supporting documents |
|---|---|---|
| Linux | ~/.config/Augias/env | ~/.config/Augias/attachments |
| macOS | ~/Library/Application Support/Augias/env | ~/Library/Application Support/Augias/attachments |
| Windows | %AppData%\Augias\env | %AppData%\Augias\attachments |
These are the directories to back up. Set AUGIAS_CONFIG_DIR and AUGIAS_ATTACHMENTS_DIR to keep them elsewhere. ~/.Augias/ only holds the application the binary unpacks, one copy per version.
The 4.0.0 binary kept your data inside the unpacked application, under ~/.SolidInvoice/, in a directory that changes with every version. The first start of a newer binary copies it to the directories above and says so. The old copy is left in place; delete ~/.SolidInvoice/ once you have checked that everything is there.
Worker mode (high-traffic deployments)β
For instances handling sustained traffic, enable worker mode:
./augias run --worker-mode --worker-threads=4 --messenger-workers=5
Worker mode keeps PHP processes alive between requests, which significantly reduces request latency at the cost of higher memory use.