Skip to content

PUBLISHING.md

Latest commit

 

History

History
40 lines (28 loc) · 769 Bytes

PUBLISHING.md

File metadata and controls

40 lines (28 loc) · 769 Bytes

Publishing satsgate (clean repo)

This folder is an export from projects/satsgate/.

Quickstart (local)

python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt

cp .env.example .env
uvicorn app.main:app --reload --port 8000

Docker (recommended for servers)

cp .env.example .env
# edit .env and set SATSGATE_HOSTNAME, SATSGATE_MACAROON_SECRET, SATSGATE_LIGHTNING_ADDRESS, SATSGATE_DEV_MODE=0

docker compose up -d --build

Discovery

  • GET /.well-known/satsgate.json
  • GET /openapi.json

Publish to GitHub

git init
git add .
git commit -m "Initial public release"

# create a repo on GitHub, then:
# git remote add origin git@github.com:YOUR_USER/satsgate.git
# git push -u origin main