Self-host install

Run Shingan on your own infrastructure.

Shingan is non-custodial and read-only: it never holds private keys and cannot move funds. You are responsible for securing your own server and secrets.

Get the download

Subscribe to the self-host plan in the bot (/subscribe selfhost), or if you already have it, send /selfhost to get your license key and download link. One instance per license — keep the key private.

Requirements

• A fresh Debian 12 host (a small VPS is enough), root access.
• A domain with A records for pay.<yourdomain> (and <yourdomain>, admin.<yourdomain> for the marketing site and admin portal).
• A Telegram bot token from @BotFather, an Alchemy key for transfers, and optionally an Etherscan key and an LLM key for /ask.

Provision

Unpack the tarball on the host and run, as root:

DOMAIN=example.com TLS_EMAIL=you@example.com scripts/provision.sh

This installs dependencies, creates the shingan system user, sets up Postgres (peer auth over the local socket — no DB password in config), builds and installs the binaries, installs hardened systemd units, fronts the checkout with Caddy + Let's Encrypt, enables ufw/fail2ban/unattended-upgrades, and adds a watchdog plus a nightly backup.

Configure

Edit /etc/shingan/shingan.conf and set at least BOT_TOKEN, ADMIN_CHAT, ALCHEMY_KEY, LICENSE_SECRET, your payment settings, and your LICENSE_KEY. Then:

systemctl restart shingand shingan-bot shingan-http shingan-admin
/usr/local/bin/shingan check-config
/usr/local/bin/shingan license-check

Updates

If you keep the source as a git repo, push to your host's bare repo and the post-receive hook builds, tests and deploys atomically. Otherwise unpack a new release over the source tree and re-run scripts/deploy.sh.

Backups

Backups are in-house: a nightly pg_dump plus config into /var/lib/shingan/backups (14 daily, first-of-month for 6 months) with a weekly restore drill. Mount a volume at /mnt/backup to keep a second copy.