From a8925ef6503a33162a61e2d5383f8bb96bc0df1f Mon Sep 17 00:00:00 2001 From: denis0001-dev Date: Thu, 16 Jul 2026 00:12:01 +0300 Subject: [PATCH] Add note in README --- README.md | 48 +++++++++++++++++++++++++++++++++++------------- 1 file changed, 35 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index f29991f..245b5e5 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ # FromChat Deployment -One-click installer for a production FromChat stack on Debian-based Linux. +_Написано ИИ. Могут быть ошибки._ + +One-click installer and classic (build-on-your-PC) deploy tooling for a production FromChat stack on Debian-based Linux. ## Quick install @@ -8,14 +10,14 @@ One-click installer for a production FromChat stack on Debian-based Linux. curl -fsSL https://l.fromchat.ru/install|sudo bash ``` -The installer: +The installer (`install.sh`): 1. Installs Docker + Compose plugin if missing -2. Downloads the published `compose.yml` (`restart: always` on all services) -3. Runs the backend `.env` generator into `~/fromchat-server/.env` -4. Prints next steps (configure Caddyfile, then `docker compose up -d`) +2. Downloads the published `compose.yml` (GitHub, with Gitea fallback) +3. Clones backend enough to run `generate:env` into `~/fromchat-server/.env` +4. Prints next steps (configure Caddyfile / edge, then `docker compose up -d`) -No systemd unit — containers use Docker `restart: always`. +Containers use Docker `restart: always` — no systemd unit. Short links on `l.fromchat.ru`: @@ -36,22 +38,42 @@ docker compose --env-file .env up -d ``` ~/fromchat-server/ - compose.yml # published production stack - .env # from generate:env + compose.yml # published production stack (do not edit by hand; regenerated by CI/publish) + .env # from backend generate:env compliance_keypair.txt # keep the private key offline data/prod/ # runtime data (Caddy ACME under data/prod/caddy/) - firebase-cert.json # optional; empty placeholder created by installer + firebase-cert.json # optional; empty placeholder may be created by installer ``` -## Classic deploy (offline, build on your PC) +## Classic deploy (offline / build on your PC) -For developers who build images **locally** and transfer them to a server via SSH + `docker pussh`: +For developers who build images **locally** and transfer them via SSH + `docker pussh`: ```bash cd deployment ./deploy.sh user@host ~/fromchat-server linux/arm64 --tag latest +# optional: +./deploy.sh user@host ~/fromchat-server linux/amd64 \ + --components backend,frontend,caddy,updater --tag v1.0 ``` -Syncs `compose.yml` + `.env` to the server, pushes images via `docker pussh`, then runs `docker compose up -d` remotely (containers use `restart: always` — no systemd unit). +- Interactive component menu if `--components` is omitted +- Syncs `compose.yml` + `.env` to the server, pushes images, then `docker compose up -d` +- Sibling checkouts expected (or set env): `../backend`, `../Web`, `../updater` + overrides: `FROMCHAT_BACKEND_DIR`, `FROMCHAT_WEB_DIR`, `FROMCHAT_UPDATER_DIR` -Publish multi-arch images with `./publish.sh`. CI regenerates root `compose.yml` from the latest published release. +Publish multi-arch images to registries: + +```bash +./publish.sh +``` + +CI regenerates root `compose.yml` from the latest published release (`scripts/sync-published-compose.py`). + +Python helpers live under `scripts/deploy/` (`requirements-deploy.txt`: rich, etc.). Prefer the backend `.venv` or create one for deployment scripts. + +## Related + +- [Backend](https://github.com/fromchat-messenger/backend) — `generate:env`, `compose.yml` / `compose.prod.yml` +- [Updater](https://github.com/fromchat-messenger/updater) — pulls newer Hub tags into a running stack +- [Web](https://github.com/fromchat-messenger/web) • [Android](https://github.com/fromchat-messenger/android)