PasarGuard-Node README

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

PasarGuard Node – Railway Deploy (No VPS needed)

Deploys PasarGuard Node (https://github.com/PasarGuard/node) as a second Railway service, with a self-signed certificate baked into the image at build time so no external server is required to obtain the "Server CA" for the panel.

Setup

  1. Push this folder to its own GitHub repo.
  2. In your Railway project, click + New → GitHub Repo → select this repo. (Use the same Railway project as your PasarGuard panel, as a second service.)
  3. In this new service's Variables tab, add:
    • API_KEY = a UUID you generate yourself (e.g. uuidgen or any UUID generator). Example: 6d183b56-361e-4f9b-be2d-c571cdebae23
  4. In this service's Settings → Networking, enable TCP Proxy and set the target port to 62050. Railway will give you a public host:port pair.
  5. Deploy. Once it's running, open this service's Console/Shell and run:
    cat /app/certs/ssl_cert.pem
    
    Copy the whole output (including the BEGIN/END lines).
  6. Go to your PasarGuard panel dashboard → Nodes → Add Node:
    • Address: the TCP proxy host (without the port)
    • Port: the TCP proxy port
    • API Key: the same UUID you set in step 3
    • Server CA: paste the certificate from step 5

PasarGuard-Node (x4gpanell/PasarGuard-Node)

xray
Searching Database…

What is this?This repo deploys a 'PasarGuard Node' (a node for the PasarGuard proxy panel) as a second Railway service, with a self-signed TLS certificate baked into the Docker image at build time, so you don't need a separate VPS just to get a Server CA for the panel.
Is this a library or just a deployment template?It is a deployment template: a Docker image plus Shell scripts that you push to your own GitHub repo and deploy as a Railway service, not a package you install into code.
How do I get this node running?Push this folder to its own GitHub repo, create a new Railway service from that repo in the same Railway project as your PasarGuard panel, set an APIKEY variable to a UUID you generate, enable TCP Proxy on port 62050 in that service's Networking settings, and deploy.
Do I need a VPS or just Railway?You need a Railway account and an already-running PasarGuard panel (deployed as the first service in the same Railway project); no external VPS is required for TLS.
What steps can't be skipped?You must manually enable TCP Proxy and point it at target port 62050 in Railway's Networking settings, then copy the generated certificate from the service console into the panel's 'Server CA' field - missing either step leaves the node unreachable.
What is the PasarGuard panel this node connects to?It's a separate proxy panel service (deployed as the first Railway service) that this node registers with, using the Address, Port, API Key, and Server CA it provides.
Why bake a self-signed certificate into the image instead of using a real one?It lets the node obtain a usable Server CA for the panel without renting or configuring an external server with a public domain and TLS setup.
What is the APIKEY variable used for?It's a UUID you generate yourself that acts as the shared secret between the panel and this node, entered both as the Railway variable and as the API Key when adding the node in the panel.
Creator
x4gpanell
Size
<0.1 MB
Stars
407
Updated
CommitSep 19
Age
2mo
Commits · 90 Days