summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorPaul Buetow <paul@buetow.org>2026-07-07 16:42:47 +0300
committerPaul Buetow <paul@buetow.org>2026-07-07 16:42:47 +0300
commit0fe33b3c40cb2dee247a8f2db098d49cfcbafd73 (patch)
tree2cf82ef5966b07322d82d7d004cc16c4c34bb2e2 /README.md
parent3815ead9b67669a01a630624c444aaa62695a824 (diff)
docs: move f3s/k8s deployment details out to homelab skill
Remove all f3s/k3s/cluster-specific deployment content from README.md, AGENTS.md, and ychat/DOCKER.md. The DB-backed build's deployment status, live URL, image tag, PVC, Helm chart, and ArgoCD app details now live in the private homelab skill's references/ychat.md sub-reference instead of this public repo. - README.md: drop the 'Deploying to the f3s k3s cluster' section and the 'Deployed to f3s' table note; genericize the emptyDir log note. - AGENTS.md: drop the explicit f3s skill name from the deployment section; keep only a generic out-of-scope pointer to the homelab skill. - ychat/DOCKER.md: remove the 'still running live on the f3s k3s cluster' History mention, the 'Not yet deployed to f3s' block, and the entire 'Deploying to the f3s k3s cluster' section.
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 3 insertions, 16 deletions
diff --git a/README.md b/README.md
index 16b949a..a981058 100644
--- a/README.md
+++ b/README.md
@@ -6,7 +6,7 @@ are kept here as historical/revival code.
| Subproject | What it is | Status |
|------------|------------|--------|
-| [`./ychat`](ychat/) | An HTTP-based web chat server (browsers are the clients; CSS/HTML/JS only). | **Revived, builds in Docker with a mandatory embedded-SQLite backend** (real, persistent registered accounts) — see [`ychat/DOCKER.md`](ychat/DOCKER.md). **Deployed to f3s** (`https://ychat.f3s.lan.buetow.org/`) with a persistent volume backing `/app/data`, image tag `67babb2`. |
+| [`./ychat`](ychat/) | An HTTP-based web chat server (browsers are the clients; CSS/HTML/JS only). | **Revived, builds in Docker with a mandatory embedded-SQLite backend** (real, persistent registered accounts) — see [`ychat/DOCKER.md`](ychat/DOCKER.md). |
| [`./yhttpd`](yhttpd/) | A tiny standalone http server derived from ychat's socket/threading engine. | Builds and serves reliably in Docker (verified under concurrent load) — not deployed. See [`./yhttpd/DOCKER.md`](yhttpd/DOCKER.md). |
| [`./ycurses`](ycurses/) | A curses front-end experiment. | Builds and runs in Docker (a demo, not a service, so nothing to deploy) — see [`./ycurses/BUILD.md`](ycurses/BUILD.md). |
@@ -101,8 +101,8 @@ podman rm -f ychat
in-memory, and unregistered `chat.enableguest=true` guest chatters are
wiped on restart same as before — only the accounts table persists.
- **Logs** go to `/app/log/` inside the container (`access_log`, `system_log`,
- `rooms/<room>`). They're an `emptyDir` in k8s and a container-local dir
- locally, so they don't persist after `rm`.
+ `rooms/<room>`). They're a container-local dir locally, so they don't
+ persist after `rm`.
- **Configuration** is `ychat/etc/ychat.conf`, baked into the image at
`/app/etc/ychat.conf`. You can override any config key at runtime with
`-o <key> <value>` (the image already does this for
@@ -116,19 +116,6 @@ podman rm -f ychat
---
-## Deploying to the f3s k3s cluster
-
-Deploying ychat to a homelab k3s cluster (image build/push, Helm chart,
-ArgoCD Application, PVC requirements) is homelab-specific and **not**
-documented in this public repo. **The DB-backed build described in this README is now
-deployed** — the live LAN URL (**https://ychat.f3s.lan.buetow.org/**) serves
-image tag `67babb2` with a persistent volume (`ychat-data-pvc`, hostPath-backed
-NFS share) mounted at `/app/data`, so registered accounts survive pod
-restarts. Chart/manifests live in the `conf` repo under
-`f3s/ychat/helm-chart/`.
-
----
-
## License
GPL-2.0 (see [`./ychat/COPYING`](ychat/COPYING)). Source: