PasarGuard README

The project's README from github.com/x4gpanell/PasarGuard. As one markdown file: README.md.

PasarGuard Panel – Railway Deploy

Deploy PasarGuard panel (https://github.com/PasarGuard/panel) on Railway.

Files

Quick start

  1. Push this repo to GitHub.
  2. Create a new Railway project → Deploy from GitHub repo.
  3. (Optional) Set SQLALCHEMY_DATABASE_URL env var to use Postgres/MySQL instead of SQLite.
  4. (Optional) Attach a Railway Volume mounted at /code if using SQLite, to persist data across redeploys.
  5. After the first successful deploy, open a shell (Railway CLI) and run: pasarguard cli admins --create <username>

See the Persian guide document for full details.

PasarGuard (x4gpanell/PasarGuard)

Searching Database…

What is this?This is a deployment wrapper for running the PasarGuard panel on Railway: it bundles a Dockerfile, a startup script, and a Railway config so you can deploy the panel to Railway's hosting platform.
Is this the PasarGuard panel itself, or just a deployment package?It is only the deployment glue, not the panel source. The Dockerfile builds PasarGuard from source and start-railway.sh maps Railway's dynamic $PORT to PasarGuard's UVICORN_PORT so it runs correctly on Railway.
How do I deploy this to Railway?Push this repo to GitHub, then in Railway create a new project and choose 'Deploy from GitHub repo'. After the first successful deploy, open a shell via the Railway CLI and run `pasarguard cli admins --create` to create an admin account.
Do I need a separate database?No, by default it runs on SQLite. You can optionally set the SQLALCHEMY_DATABASE_URL environment variable to use Postgres or MySQL instead.
Will my data survive a redeploy?Only if you're using SQLite and attach a Railway Volume mounted at /code; without that volume, SQLite data can be lost when the service redeploys.
Is this meant for Railway only, or can I run the Docker image elsewhere?The repo is specifically built for Railway, with a railway.toml for build/deploy config, though the underlying Dockerfile could in principle be adapted to other Docker hosts.
What does PasarGuard itself do?Not Stated In README — this repo only covers deploying the panel, not what the panel does.
Do I need the Railway CLI for anything beyond initial setup?Yes, it is used at least once after the first deploy to run the `pasarguard cli admins --create` command and set up an admin account.
What are similar projects?caprover, flyway, laradock, bunkerweb, strapi, chartdb, encore, migrate
Creator
x4gpanell
Size
<0.1 MB
Stars
429
Updated
CommitSep 19
Age
2mo
Commits · 90 Days