Skip to main content

Distribution package

The distribution package is a pre-built archive of Augias that you serve from an existing PHP webserver. Choose this method when you can't use the quick install β€” for example on shared hosting, on a managed PHP host, or when company policy requires you to use a specific webserver.

warning

This is the most involved install method. You're responsible for the webserver, PHP, the database, the cron job, and the async worker. If you have a choice, the quick install, Homebrew, or Docker installs handle all of this for you.

Skip the setup entirely

This method assumes you already run a PHP webserver and are comfortable maintaining it.

System requirements​

  • PHP 8.4 or higher with the following extensions enabled: curl, gd, intl, json, openssl, pdo, soap, xsl. You'll also need a pdo driver for your database (pdo_mysql, pdo_pgsql, or pdo_sqlite).
  • A webserver β€” Nginx (recommended) or Apache with mod_rewrite.
  • A supported database (MySQL, MariaDB, PostgreSQL, or SQLite).
  • The ability to run a cron job and a long-running PHP process on the host.

1. Download​

Download the archive of the latest version from the releases page, for example:

VERSION=4.0.0

# Zip
curl -LO "https://github.com/herc-si/Augias/releases/download/${VERSION}/Augias-${VERSION}.zip"

# Or tar.gz
curl -LO "https://github.com/herc-si/Augias/releases/download/${VERSION}/Augias-${VERSION}.tar.gz"

Extract it to a directory served by your webserver, for example /opt/augias.

info

On shared hosting with FTP-only access, download the archive locally, extract it, and upload the extracted files to your hosting account.

2. Configure the webserver​

Point your webserver at the public/ directory inside the extracted archive.

server {
server_name yourdomain.com www.yourdomain.com;
root /opt/augias/public;

location / {
# try to serve file directly, fallback to index.php
try_files $uri /index.php$is_args$args;
}

location ~ ^/index\.php(/|$) {
fastcgi_pass unix:/var/run/php-fpm.sock;
fastcgi_split_path_info ^(.+\.php)(/.*)$;
include fastcgi_params;
fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
fastcgi_param HTTPS off;
}

error_log /var/log/nginx/augias_error.log;
access_log /var/log/nginx/augias_access.log;
}
warning

The exact paths (PHP-FPM socket, log directories) differ by operating system and PHP version. Adjust to match your environment.

Open your browser at the URL the webserver is serving and finish setup with the first-run wizard β€” it walks you through the database connection, the admin user, and the basic application settings.

3. Run the background worker​

Augias uses a single background worker for both async messages (emails, webhook dispatch) and scheduled tasks (recurring invoices, reminders, overdue checks). The worker runs bin/console messenger:consume --all in a loop.

Follow the cron job setup guide β€” it covers systemd, cron, cPanel, Plesk, and Windows Task Scheduler.

warning

Without the worker running, async features and scheduled tasks won't fire β€” emails won't send and recurring invoices won't generate.

Useful environment variables​

The first-run wizard configures everything you need to get started. The variables below are useful when you want to override settings, automate deployment, or configure things the wizard doesn't ask about. Set them in .env.local (or your webserver's environment).

VariableDescription
AUGIAS_ENVApplication environment. Use prod in production.
AUGIAS_DEBUGEnable verbose error pages. Set to 0 in production.
AUGIAS_APP_SECRETLong random string used to sign cookies and CSRF tokens.
AUGIAS_APPLICATION_URLPublic URL of the installation, e.g. https://invoice.example.com.
AUGIAS_DATABASE_URLDatabase DSN. The first-run wizard can also write this for you.
AUGIAS_MAILER_DSNDefault outbound mail transport (SMTP, Mailgun, SendGrid, etc.), used by every company that has not set its own under Settings > E-mail. See Sending emails.
AUGIAS_MAILER_SENDERThe From: address Augias sends mail from. Overrides the address configured in the UI.
AUGIAS_LOCALEDefault locale (e.g. en).
AUGIAS_DEFAULT_CURRENCYThe currency a new company starts in. EUR by default.
AUGIAS_CURRENCIESThe currencies offered for companies and clients, comma-separated (e.g. EUR,CHF,GBP). Empty by default: every currency is offered. Supplier bills may always be in any currency.
AUGIAS_TELEMETRY_URLWhere anonymous usage figures are sent. Empty by default, and Augias ships no collector of its own: leave it empty and nothing is ever sent anywhere.
AUGIAS_ENABLE_TELEMETRYSet to 1 to send those figures to the collector above. Off by default, and it does nothing on its own β€” both variables have to be set.

Telemetry, if you turn it on, reports your version, operating system, PHP version, database engine and install type, plus named lifecycle events such as "an invoice was created". It never carries your data, your clients or your figures.

Other integrations (Meilisearch, Google OAuth, SUPER PDP) have their own environment variables and are documented on their respective pages.

Updating​

  1. Stop the messenger worker: sudo systemctl stop augias-worker.service (or comment out the cron entry).
  2. Back up your database and the project directory.
  3. Download the new archive and replace the project files, keeping your .env.local and any custom changes.
  4. Run bin/console cache:clear --env=prod and bin/console doctrine:migrations:migrate --env=prod --no-interaction.
  5. Restart the worker.