packaging: ship a markdown README.md in the docker dist bundle

Add a GitHub-flavored README.md alongside the existing README.txt in the
all-in-one docker distribution bundle, and have make_dist_bundle.sh stage it
so future builds include both.
Co-Authored-By: 's avatarClaude Opus 4.8 <noreply@anthropic.com>
parent 597f8b83
# CoderAI — Docker distribution
This bundle contains everything needed to run **CoderAI** from a prebuilt
all-in-one Docker image (server + API + admin UI + video editor + videogen
studio + township fighters, all behind one nginx port).
## Contents
| File | Purpose |
|------|---------|
| `install.sh` | Loads the image into Docker and installs the runner. |
| `coderai-docker` | The run wrapper (installed to your PATH by `install.sh`). |
| `coderai-dist.tar.gz` | The Docker image (gzip-compressed `docker save`). |
| `README.md` / `README.txt` | This file. |
## Requirements
- Docker (or Podman: set `CONTAINER_ENGINE=podman`).
- For GPU: NVIDIA Container Toolkit (`--nvidia`) or `/dev/dri` access (`--vulkan`).
## Install
```sh
./install.sh
```
Installs `coderai-docker` to:
- `/usr/local/bin` — when run as root.
- `~/.local/usr/bin` — when run as a normal user (added to PATH via `~/.bashrc`
if it isn't there already).
## Run
```sh
coderai-docker --nvidia # CUDA; or --vulkan (AMD/Intel) / --cpu
coderai-docker --help # all options
```
Then open <http://127.0.0.1:8776/admin>.
## Useful options (see `--help`)
| Option | Description |
|--------|-------------|
| `-p, --port PORT` | Host port (default `8776`). |
| `--data-dir PATH` | Where config/models/cache live (default `./coderai-runtime`). |
| `--local` | Run against your existing `~/.coderai` config. |
| `--map HOST[:CONT]` | Bind-mount a host dir at the same path (for absolute model paths in `models.json`), e.g. `--map /AI/guffcache`. |
| `--debug[=engine,ws,...]` | Run with coderai debug flags + a host-tailable file log. |
| `--log-file PATH` | In-container log path (default `/cache/logs/coderai.log`, visible on the host under the cache mount). |
| `--no-tools` | Disable the bundled demo tool web UIs (video editor, videogen, township). They're on by default. |
| `--enable-tool NAME` | Force-enable a demo tool (also turns on parler TTS, which is off by default). NAME: `video-editor` \| `videogen` \| `township` \| `parler`. Repeatable. |
| `--disable-tool NAME` | Disable a single demo tool. Repeatable. |
| `-d, --detach` | Run in the background. |
## Manual image load (without `install.sh`)
```sh
docker load < coderai-dist.tar.gz # restores the coderai:dist tag
```
...@@ -6,7 +6,7 @@ ...@@ -6,7 +6,7 @@
# install.sh loads the image + installs the runner (see dist-bundle/) # install.sh loads the image + installs the runner (see dist-bundle/)
# coderai-docker the run wrapper (run_oci.sh, image tag pinned) # coderai-docker the run wrapper (run_oci.sh, image tag pinned)
# coderai-dist.tar.gz the image (gzip-compressed `docker save`) # coderai-dist.tar.gz the image (gzip-compressed `docker save`)
# README.txt # README.txt / README.md
# #
# Output: $OUT_DIR/<NAME>.tar (not re-gzipped — the image is already compressed). # Output: $OUT_DIR/<NAME>.tar (not re-gzipped — the image is already compressed).
# #
...@@ -49,6 +49,7 @@ ln "$IMAGE_TAR" "$STAGE/coderai-dist.tar.gz" 2>/dev/null \ ...@@ -49,6 +49,7 @@ ln "$IMAGE_TAR" "$STAGE/coderai-dist.tar.gz" 2>/dev/null \
install -m 0755 "$HERE/run_oci.sh" "$STAGE/coderai-docker" install -m 0755 "$HERE/run_oci.sh" "$STAGE/coderai-docker"
install -m 0755 "$HERE/dist-bundle/install.sh" "$STAGE/install.sh" install -m 0755 "$HERE/dist-bundle/install.sh" "$STAGE/install.sh"
cp "$HERE/dist-bundle/README.txt" "$STAGE/README.txt" cp "$HERE/dist-bundle/README.txt" "$STAGE/README.txt"
cp "$HERE/dist-bundle/README.md" "$STAGE/README.md"
# Pin the runner's default image tag to exactly what we shipped, so it matches # Pin the runner's default image tag to exactly what we shipped, so it matches
# the tag restored by `docker load` regardless of the build's tag. # the tag restored by `docker load` regardless of the build's tag.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment