tiennm99/composes
1
0 Fork 0
mirror of https://github.com/tiennm99/composes.git synced 2026-10-04 02:12:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: give each service its own README

Browse Source 
Move the code-server details into code-server/README.md and reduce the
root README to shared conventions plus a table linking to each service.
This commit is contained in:
tiennm99 committed 2026-08-14 09:25:36 +07:00
1 parent 34591b7e27
commit 85b35e449d
3 files changed
+39 -21
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

CLAUDE.md
+7 -1
View File
@@ -1,7 +1,13 @@
# composes
Personal docker compose collection. One directory per service, each holding
`compose.yml`, a committed `.env.example`, and a gitignored `.env`.
`compose.yml`, its own `README.md`, a committed `.env.example`, and a
gitignored `.env`.
The root `README.md` is an index only — it covers the shared conventions and
links out to each service. Per-service detail (variables, ports, storage)
belongs in that service's README, not the root one. Adding a service means
adding its README and a row to the root table.
## Deployment target
README.md
+4 -20
View File
@@ -20,6 +20,7 @@ plain `docker compose` means adding whatever your setup needs.
```
<service>/
compose.yml # the service definition
README.md # what it is, its variables, how it's wired
.env.example # required variables, committed
.env # real values, gitignored
```
@@ -48,25 +49,8 @@ Never commit it — the root `.gitignore` covers `.env`/`*.env` and re-includes
## Services
### code-server
Each links to its own README for variables, ports, and storage.
[VS Code in the browser](https://github.com/linuxserver/docker-code-server),
from the LinuxServer image, set up as a full remote dev box.
Comes with Go, Node.js 24, Python 3, pnpm, and zsh via LinuxServer mods, plus
`gh`, `git`, `ffmpeg`, `imagemagick`, and other CLI tools through
`INSTALL_PACKAGES`. Git author/committer identity is injected from `.env`.
Everything lives in the `code-server-config` named volume mounted at `/config`;
the default workspace is `/config/workspace`. Removing the volume wipes your
files, settings, and extensions.
| Variable | Purpose |
| Service | What it is |
| --- | --- |
| `PASSWORD` | Web UI login, also the in-container sudo password. **A blank value disables authentication entirely.** |
| `GIT_NAME` / `GIT_EMAIL` | Git author and committer identity |
| `CODEX_ACCESS_TOKEN` | OpenAI Codex CLI auth; leave blank if unused |
Generate a password with `openssl rand -base64 24`.
Listens on `8443` — point the domain at that port in Coolify or Dokploy.
| [code-server](code-server/README.md) | VS Code in the browser, as a remote dev box |
code-server/README.md
+28
View File
@@ -0,0 +1,28 @@
# code-server
[VS Code in the browser](https://github.com/linuxserver/docker-code-server),
from the LinuxServer image, set up as a full remote dev box.
Comes with Go, Node.js 24, Python 3, pnpm, and zsh via LinuxServer mods, plus
`gh`, `git`, `ffmpeg`, `imagemagick`, and other CLI tools through
`INSTALL_PACKAGES`. Git author/committer identity is injected from `.env`.
## Environment
| Variable | Purpose |
| --- | --- |
| `PASSWORD` | Web UI login, also the in-container sudo password. **A blank value disables authentication entirely.** |
| `GIT_NAME` / `GIT_EMAIL` | Git author and committer identity |
Generate a password with `openssl rand -base64 24`.
## Networking
Listens on `8443`. No ports are published — point the domain at that port in
Coolify or Dokploy. See the [root README](../README.md) for why.
## Storage
Everything lives in the `code-server-config` named volume mounted at `/config`;
the default workspace is `/config/workspace`. Removing the volume wipes your
files, settings, and extensions.