pgs - self-host

A self hostable, static site hosting service using ssh.

features

• Fully manage static sites using ssh
• Unlimited projects, created instantly upon upload
• Deploy using rsync, sftp, sshfs, or scp
• Github Action
• Automatic TLS for all projects
• Promotion and rollback support
• Custom domains for projects
• Custom Redirects & Rewrites
• Custom Headers
• SPA support
• HTTP Caching (RFC-7234)
• Image manipulation API
• Prometheus integration

Important

We provide a fully managed version of this service at pgs.sh.

deps

• docker
• caddy (on-demand tls)
• imgproxy (image manipulation api, optional)

setup

Create .env file:

# required
PGS_DOMAIN=pgs.test # this should be your custom domain
FS_STORAGE_DIR=./data/storage
DATABASE_URL=./data/pgs.sqlite3
PGS_PROTOCOL=http
STORAGE_ADAPTER=fs

# the rest is optional

# defaults
USE_IMGPROXY=0
PGS_WEB_PORT=3000
PGS_SSH_PORT=2222
PGS_PROTOCOL=https
PGS_CACHE_TTL=600s # time.ParseDuration
PGS_CACHE_CONTROL=max-age=600

# imgproxy
USE_IMGPROXY=1
IMGPROXY_URL=http://imgproxy:8080
IMGPROXY_ALLOWED_SOURCES=local://
IMGPROXY_KEY=6465616462656566 # deadbeef
IMGPROXY_SALT=6465616462656566 # deadbeef

# cloudflare
CF_API_TOKEN=xxx

docker

This is the only recommended way to self-host pgs.

Important

We recommend using docker-compose: See our docker-compose.yml file.

docker run -d \
  --env-file=.env \
  -p 2222:2222 \
  -p 3000:3000 \
  -v $(pwd)/data:/app/data \
  ghcr.io/picosh/pgs:latest

docker compose

Our example docker-compose file assumes your DNS is managed by Cloudflare. If you want to verify your domains using some other caddy provider then go to the caddy docs to learn how to do that: https://github.com/caddy-dns

There are also a couple of important environment variables that are required inside our Caddyfile.

docker compose up -d

The default port for the SSH app is 2222 but you are free to change it to whatever you want, including 22.

setup user account

Copy your public key:

cat ~/.ssh/id_ed25519.pub
# pubkey: zzz

After the pgs container is running, create your user account:

docker compose exec -T pgs /app/pgs init {username} zzz

Now you should be able to copy files to the SSH app!

rsync -rv --delete ./public/ my.site:/about/

local dev

For local development you need to add host entries for each project. For example, add entries to /etc/hosts:

0.0.0.0 pgs.test
0.0.0.0 erock-project.pgs.test

usage

Important

For more in-depth usage, go to our managed service docs

rsync -e "ssh -p 2222" -rv ./public/ localhost:/project

curl http://erock-project.pgs.test:3000/