tiennm99/composes
1
0 Fork 0
mirror of https://github.com/tiennm99/composes.git synced 2026-10-11 03:13:16 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: revise install location and naming rules

Browse Source 
Workspace services install tools into the home volume unless the package
is more than a binary. Prefer official images and treat upstream compose
files as a starting point. Name volumes <service>-<content> and networks
<main service>-network.
This commit is contained in:
tiennm99 committed 2026-10-06 17:09:38 +07:00
1 parent d889338306
commit f38a3a2871
1 file changed
+23 -8
Download Patch File Download Diff File Expand all files Collapse all files
CLAUDE.md
+23 -8
View File
@@ -17,21 +17,36 @@ suffix naming its source — `code-server-lsio` for LinuxServer's code-server
so both can coexist. The suffix is a directory name only, forced by the so both can coexist. The suffix is a directory name only, forced by the
conflict; it is not a name to copy anywhere else. conflict; it is not a name to copy anywhere else.
Inside `compose.yml`, service, volume and network names follow the upstream Prefer each tool's official image, for the main service and for every
project's official Docker guide. Where the guide gives none, the main service supporting container alike. Upstream's official compose file or Docker guide
takes the image's own name (`code-server`, not `code-server-lsio`), and a is a starting point, not a spec: adapt it to the conventions in this file
supporting container may be named for its role instead — `db`, `database`, rather than copying its layout and names as they are.
`cache` and the like.
Inside `compose.yml`, a service is named after its image — `code-server`, not
`code-server-lsio`. A supporting container may instead be named for its role —
`db`, `database`, `cache` and the like — so the software behind it can be
swapped without renaming: Redis for Valkey, MySQL for MariaDB, or one SQL
database for PostgreSQL.
A volume is named `<service>-<what it holds>`, after the service that mounts it
and its mount point or meaning — `code-server-home`, `code-server-workspace`,
`db-data`. A network is named after the main service: `code-server-network`.
## Installing software in an image ## Installing software in an image
Follow the upstream project's own documented install method, or the one the Follow the upstream project's own documented install method, or the one the
community has settled on. In order of preference: the vendor's signed package community has settled on. Do not hand-roll a download, and do not take a stale
repository, the vendor's official tarball or install script, then a well-known
community installer. Do not hand-roll a download, and do not take a stale
distro package just because `apt install` is shorter — check what version it distro package just because `apt install` is shorter — check what version it
actually gives you first. actually gives you first.
Where it gets installed depends on the kind of service. In a workspace service
(see below), install tools into a location that survives a redeploy — the
container user's home volume, such as `~/.local/bin` — not into the image. The
exception is a system package that is more than a single binary — shared
libraries, a daemon, anything that hooks into `/etc` or the system paths. That
goes in the image, through the system package manager. Every other service
installs into the image.
## Comments in compose files, Dockerfiles and scripts ## Comments in compose files, Dockerfiles and scripts
This holds for every file in a service directory, not just the compose file. This holds for every file in a service directory, not just the compose file.