Installing (planned)
Planned. Self-hosted deployment is not available yet. Commands starting with
./install.shorprovantixare the planned installer interface and may change; the files, settings and system commands around them are as written.
The install has two stages. The first changes nothing; the second does the work. Run both on the machine from the readiness checklist.
Before you start
You need your activation key (one use, issued by Provantix for your deployment), the hostname and certificate from Domains and TLS, and, if you use your own database, its connection string.
1. Download and verify
Each release is an archive with a checksum file and a detached signature. The installer verifies the signature against a public key printed in these docs and embedded in the installer; verify it yourself too.
curl -fsSLO https://get.provantix.tech/releases/<version>/provantix-<version>-linux-x86_64.tar.gz
curl -fsSLO https://get.provantix.tech/releases/<version>/SHA256SUMS
curl -fsSLO https://get.provantix.tech/releases/<version>/SHA256SUMS.sig
sha256sum -c SHA256SUMS --ignore-missing # expect: ...tar.gz: OK
The signature check uses our published release key; the exact command is printed on the release page. Do not run an installer whose signature you have not checked. You can do all of this on another machine and copy the archive across, or mirror it inside your network.
tar -xzf provantix-<version>-linux-x86_64.tar.gz
cd provantix-<version>
2. Preflight (changes nothing)
sudo ./install.sh preflight --public-url https://<your-domain>
It reports pass, warn or fail for the operating system, CPU, memory, disk, clock, ports, database, access to Provantix (through your proxy if you set one), and DNS and certificate readiness. It saves a report you can send to support. Fix every fail and rerun.
If you need an outbound proxy:
sudo ./install.sh preflight --public-url https://<your-domain> --proxy http://proxy.corp.example:3128
3. Install
sudo ./install.sh install \
--public-url https://<your-domain> \
--activation-key pvx_act_xxxxxxxx \
--data-dir /var/lib/provantix
It will say what it is about to install and ask before it changes anything. It then:
- installs missing packages (PostgreSQL with the
vectorextension, unless you supplied your own database); - creates the service user, the data directory and the databases;
- writes the settings file (see below) and generates the secrets in it;
- creates the deployment's signing key on the machine, in the data directory, readable only by the service user. It never leaves the machine;
- registers that key with Provantix using your activation key. The key works once;
- runs the database migrations;
- starts the service under systemd and asks you to create the first administrator;
- closes self sign-up, so only people an administrator invites can sign in.
4. The settings file
The installer writes /etc/provantix/env (planned location). You can read it, and later change it, then restart the service. These are the settings the product reads:
| Setting | Meaning |
|---|---|
LEDGER_DEPLOYMENT=customer |
Marks this as a customer-run install: no Provantix staff domain, a host-only session cookie, no Razorpay or Cloudflare, your own contacts. |
LEDGER_PUBLIC_URL |
The address people and agents use, on your own domain: https://<your-domain> (a placeholder for your real hostname). Used in links, sign-in redirects and agent setup commands. |
PLATFORM_DATABASE_URL |
The PostgreSQL connection string. |
LEDGER_PLATFORM_SECRET |
Secret that organization tokens are derived from. Generated once. Back it up with the data directory. |
LEDGER_CREDENTIAL_KEY |
Optional, 16 characters or more. The key that encrypts the credentials of destination connections (for example the Razorpay key pair) at rest. Without it, LEDGER_PLATFORM_SECRET is used. There is no random fallback: with neither set, a destination credential is refused. Back it up with the settings file. See Connect Razorpay as a destination. |
LEDGER_DATA_DIR |
Where keys, exports and per-organization state live. |
PORT, HOST |
The port (default 8787) and the address to listen on (default 127.0.0.1). |
LEDGER_SIGNUP=invite |
Only invited people can create accounts. |
LEDGER_TRUSTED_PROXIES |
Addresses of your reverse proxy, so client addresses are read correctly. See Domains and TLS. |
SMTP_HOST, SMTP_PORT, SMTP_USER, SMTP_PASS, SMTP_FROM |
Your mail relay. See Email. |
| (outbound access) | A destination connection reads the provider's own API (api.razorpay.com) over HTTPS every five minutes. If your network restricts outbound traffic, allow that host. Nothing else is added. |
LEDGER_INTERNAL_HOSTS |
The internal hosts and networks the platform may reach (chat, tickets, your identity provider). Default: none. See Alerts. |
LEDGER_SUPPORT_EMAIL |
The address shown to your people for help. Yours, not ours. |
LEDGER_DOCS_URL |
Where the in-app Docs link points. Defaults to the public docs, which needs your browsers to reach them. |
LEDGER_VERSION |
Set by the installer; reported in the beacon. |
Treat the file as a secret: it is owned by root, readable by the service user only.
5. Check it
systemctl status provantix # active (running)
curl -sS http://127.0.0.1:8787/health # {"ok":true,"mode":"saas"}
curl -sS http://127.0.0.1:8787/api/licence # health should become "ok" after the first beacon
journalctl -u provantix -n 50 --no-pager # no errors; "platform migrations applied" on first start
The first beacon is sent shortly after start. Until it is answered, the licence reads "blocked" because the deployment is registered but has no answer yet; the first answer clears it. If it does not clear within a few minutes, see Licensing.
6. Self-test
The installer finishes with a self-test: it signs in, sends a test batch, verifies the result with the offline verifier, and confirms an entitlement was received. You can run it again at any time:
sudo provantix self-test
Next
Licensing, then Domains and TLS, Sign-in and SSO and Email.