Add deployment instructions and site links to CLAUDE.md
This commit is contained in:
parent
7cded611e4
commit
2bf6515cbb
93
CLAUDE.md
Normal file
93
CLAUDE.md
Normal file
@ -0,0 +1,93 @@
|
|||||||
|
# Genpix SKYWALKER-1 USB 2.0 DBB-s card
|
||||||
|
SkyWalker-1 is a standalone advanced USB 2.0 DVB-s card.
|
||||||
|
|
||||||
|
Supported modulations:
|
||||||
|
|
||||||
|
DVB-S (QPSK)
|
||||||
|
Turbo-coded QPSK
|
||||||
|
Turbo-coded 8PSK
|
||||||
|
Digicipher II Combo
|
||||||
|
Digicipher II Split (I/Q)
|
||||||
|
Digicipher II Offset QPSK
|
||||||
|
DSS (QPSK)
|
||||||
|
|
||||||
|
DVB-S2 standard is not supported (incompatible FEC)
|
||||||
|
|
||||||
|
Symbol Rate: 256Ksps - 30Msps
|
||||||
|
|
||||||
|
|
||||||
|
RF specification
|
||||||
|
|
||||||
|
• Frequency range: 950-2150 MHz
|
||||||
|
• input connector: IEC F-type female
|
||||||
|
• LNB/switch control: 13/18V (or 14/19V), 22 kHz, Tone Burst, DiSEqC 1.0/1.2, Legacy switch commands, max. 750 mA *
|
||||||
|
|
||||||
|
* 750mA is maximum NON-continuous (for several minutes) allowable load. To avoid overheating, it's advisable not to exceed 450mA for permanent load.
|
||||||
|
|
||||||
|
# Documentation Site
|
||||||
|
|
||||||
|
Live at **https://skywalker-1.warehack.ing** — Astro Starlight, 37 pages, 9 sidebar groups.
|
||||||
|
|
||||||
|
## Deployment
|
||||||
|
|
||||||
|
Production runs on `warehack-ing@warehack.ing` via Docker + caddy-docker-proxy.
|
||||||
|
|
||||||
|
**Repo:** `git@git.supported.systems:warehack.ing/skywalker-1.git` (Gitea, private)
|
||||||
|
|
||||||
|
**Server layout:**
|
||||||
|
```
|
||||||
|
~/skywalker-1/ # git clone
|
||||||
|
site/
|
||||||
|
.env # not committed — see below
|
||||||
|
docker-compose.yml # caddy-docker-proxy labels
|
||||||
|
Dockerfile # multi-stage: dev (Astro HMR) / prod (Caddy static)
|
||||||
|
Makefile # shortcuts: make up, make prod, make logs
|
||||||
|
```
|
||||||
|
|
||||||
|
**`.env` on production server** (`~/skywalker-1/site/.env`):
|
||||||
|
```env
|
||||||
|
COMPOSE_PROJECT=skywalker-1-docs
|
||||||
|
APP_ENV=prod
|
||||||
|
APP_PORT=80
|
||||||
|
PUBLIC_DOMAIN=skywalker-1.warehack.ing
|
||||||
|
VITE_HMR_HOST=
|
||||||
|
```
|
||||||
|
|
||||||
|
**Deploy / update:**
|
||||||
|
```bash
|
||||||
|
ssh -A warehack-ing@warehack.ing
|
||||||
|
cd ~/skywalker-1 && git pull
|
||||||
|
cd site && make prod # rebuilds container with APP_ENV=prod, serves static via Caddy
|
||||||
|
make logs # verify startup
|
||||||
|
```
|
||||||
|
|
||||||
|
**First-time setup** (already done):
|
||||||
|
```bash
|
||||||
|
ssh -A warehack-ing@warehack.ing
|
||||||
|
ssh-keyscan -t ed25519 git.supported.systems >> ~/.ssh/known_hosts
|
||||||
|
git clone git@git.supported.systems:warehack.ing/skywalker-1.git ~/skywalker-1
|
||||||
|
# create site/.env as above
|
||||||
|
cd ~/skywalker-1/site && make prod
|
||||||
|
```
|
||||||
|
|
||||||
|
TLS is automatic via caddy-docker-proxy (ACME DNS challenge, Vultr API). New certs take ~2 min.
|
||||||
|
|
||||||
|
## Local Dev
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cd site
|
||||||
|
npm install
|
||||||
|
npm run dev # http://localhost:4321
|
||||||
|
```
|
||||||
|
|
||||||
|
Or with Docker (HMR via volume mounts):
|
||||||
|
```bash
|
||||||
|
cd site
|
||||||
|
# set APP_ENV=dev, APP_PORT=4321 in .env
|
||||||
|
make dev
|
||||||
|
```
|
||||||
|
|
||||||
|
# Links
|
||||||
|
- [Live Docs](https://skywalker-1.warehack.ing)
|
||||||
|
- [Gitea Repo](https://git.supported.systems/warehack.ing/skywalker-1)
|
||||||
|
- [Genpix Official Site](https://www.genpix-electronics.com/index.php?act=viewDoc&docId=9)
|
||||||
Loading…
x
Reference in New Issue
Block a user