Installer options | Paybob Docs

Every option the installer accepts: database, proxy, ports, versions and unattended installs.

Every question the installer asks can be answered with an option instead, and a few options change how Paybob is set up. Pass options after bash -s --:

Terminal

curl -fsSL https://get.paybob.io/install.sh | sudo bash -s -- --url https://pay.example.com --db local

To see the list on your server, run the installer with --help.

Address

Option	What it does
`--url URL`	Paybob's address, for example `https://pay.example.com`: a host name only, with no path or port. Must be `https://` in production. Asked for when not given.
`--allow-http`	Allows an `http://` address. For testing only: passkeys and most payment gateways don't work over plain HTTP. The installation is marked as not for production, and every upgrade repeats the warning.

Option	What it does
`--db local`	Use the bundled MariaDB (default).
`--db remote`	Use your own MariaDB 10.6+ or MySQL 8.0+ server.
`--db-host HOST`	The database server's host name or IP address.
`--db-port PORT`	Its port (default `3306`).
`--db-name NAME`	The database name (default `paybob`).
`--db-user USER`	The database user (default `paybob`).
`--db-password-file FILE`	A file whose first line is the database password. Passing the password in a file keeps it out of your shell history.

Paybob runs inside Docker, so localhost or 127.0.0.1 would mean the container itself, not your server. For a MySQL or MariaDB server running on the same machine, use host.docker.internal as the host (the installer offers to switch to it if you enter localhost). The database server must also:

listen on Docker's network, with bind-address = 0.0.0.0 or 172.17.0.1 in its configuration;
allow your Paybob database user to connect from 172.28.0.0/16, Paybob's Docker network.

For example, with a password file:

Terminal

echo 'your-database-password' > /root/db-pass && chmod 600 /root/db-pass
curl -fsSL https://get.paybob.io/install.sh | sudo bash -s -- \
  --url https://pay.example.com \
  --db remote --db-host db.example.com --db-name paybob --db-user paybob \
  --db-password-file /root/db-pass
rm /root/db-pass

Use your own proxy

By default Paybob runs its own proxy (Caddy) on ports 80 and 443, which handles HTTPS certificates for you. If the server already runs a web server, or you want to manage HTTPS yourself, turn it off:

Option	What it does
`--no-proxy`	Don't run the built-in proxy. Paybob listens on `127.0.0.1:8080` for your own proxy.
`--app-port PORT`	Listen on this port instead of `8080`.
`--public-app-port`	Listen on all network interfaces instead of only `127.0.0.1`.

Point your proxy at Paybob's port, and make it forward the original Host header and X-Forwarded-Proto. For example, with nginx:

nginx

location / {
    proxy_pass http://127.0.0.1:8080;
    proxy_set_header Host $host;
    proxy_set_header X-Forwarded-Proto $scheme;
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
}

Ports published by Docker bypass the firewall

With --public-app-port, Paybob's port is reachable from the internet even if ufw or firewalld blocks it, because Docker writes its own firewall rules. Only use it when something outside the server, such as a load balancer, must connect directly. If Cloudflare connects to that port directly, add Cloudflare's IP ranges to TRUSTED_PROXIES in /opt/paybob/app.env so Paybob sees your visitors' real IP addresses.

Host

Option	What it does
`--install-docker`	Install Docker without asking if it's missing.
`--force-unsupported-os`	Continue on a Linux distribution that isn't officially supported. Docker must already be installed and working.
`--yes`	Accept every prompt: install missing tools, create swap, install Docker.

Version

Option	What it does
`--version VERSION`	Install this version instead of the latest, for example `--version 3.0.1`.

Unattended installs

Normally the first admin account and Brand are created in the browser with a one-time link. To create them during installation instead, for example from a provisioning script, pass all of these:

Option	What it does
`--admin-name NAME`	The admin's name.
`--admin-email EMAIL`	The admin's email address, used to sign in.
`--admin-password-file FILE`	A file whose first line is the admin's password (at least 8 characters).
`--brand NAME`	The first Brand's name.
`--currency CODE`	The Brand's currency, for example `USD`.
`--timezone ZONE`	The Brand's timezone, for example `Europe/London`.

A complete unattended install:

Terminal

echo 'a-strong-admin-password' > /root/admin-pass && chmod 600 /root/admin-pass
curl -fsSL https://get.paybob.io/install.sh | sudo bash -s -- \
  --url https://pay.example.com --db local --yes \
  --admin-name "Jane Doe" --admin-email [email protected] \
  --admin-password-file /root/admin-pass \
  --brand "Example Store" --currency USD --timezone Europe/London
rm /root/admin-pass

After a failed run

Option	What it does
`--resume`	Continue the previous, unfinished installation with its saved settings and secrets.
`--cleanup`	Remove what the unfinished installation created, so you can start over.

See If the installation stops.

Advanced settings

These environment variables change the installer's limits. Use them only if you know why you need them.

Variable	Default	Meaning
`PAYBOB_MIN_FREE_MB`	`5120`	Free disk space required for the installation, in MB.
`PAYBOB_MIN_DOCKER_FREE_MB`	`3072`	Free disk space required for Docker, in MB.
`PAYBOB_DIR`	`/opt/paybob`	Where the installation lives.

Set them for the installer like this:

Terminal

curl -fsSL https://get.paybob.io/install.sh | sudo PAYBOB_DIR=/srv/paybob bash