Expand README + tweak DOCKER_HUB.md for users not cloning the repo
README rewrite: - Two quick-start paths: 'no git clone' (curl docker-compose.yml + .env.example) and 'with git clone' for hackers/forkers - New 'Authentication' section with subsections per provider (Anthropic, OpenAI, Gemini, AWS Bedrock static, AWS Bedrock SSO). AWS SSO path documents the ~/.aws bind-mount. - Persistent state expanded: 5-row volume table + optional volumes table. Annotated what survives what. - Configuration reference: full .env table. - Versioning, building from source (with build args table), troubleshooting FAQ, related projects, license. - 11 kB total — comprehensive but readable. DOCKER_HUB.md tweaks: - Quick-start now has a 'no git clone' path (curl two files), pointing users at the gitea README for the full setup guide. The git-clone path was overkill for the 90% case (just want to docker run). - Explicit link to gitea README at the end of the quick-start block.
This commit is contained in:
+12
-7
@@ -13,24 +13,29 @@ Multi-arch: `linux/amd64`, `linux/arm64`.
|
||||
|
||||
## Quick start
|
||||
|
||||
One-shot, no persistence:
|
||||
|
||||
```bash
|
||||
docker run -it --rm \
|
||||
-v "$PWD":/workspace \
|
||||
-v "$HOME/.ssh":/home/developer/.ssh:ro \
|
||||
-e ANTHROPIC_API_KEY="$ANTHROPIC_API_KEY" \
|
||||
joakimp/pi-devbox:latest pi
|
||||
```
|
||||
|
||||
For persistent state (settings, bash history, neovim plugins, mempalace data) and a full dev workflow, use docker-compose:
|
||||
For a fully-configured environment with persistent settings, MemPalace memory, neovim plugins, and shell history surviving container recreation, use docker-compose. **You don't need to clone the repo** — just grab two template files:
|
||||
|
||||
```bash
|
||||
git clone https://gitea.jordbo.se/joakimp/pi-devbox
|
||||
cd pi-devbox
|
||||
cp .env.example .env # edit WORKSPACE_PATH, GIT_USER_NAME, GIT_USER_EMAIL, etc
|
||||
docker compose run --rm devbox
|
||||
# inside the container:
|
||||
pi
|
||||
mkdir -p ~/pi-devbox && cd ~/pi-devbox
|
||||
curl -O https://gitea.jordbo.se/joakimp/pi-devbox/raw/branch/main/docker-compose.yml
|
||||
curl -fsSL https://gitea.jordbo.se/joakimp/pi-devbox/raw/branch/main/.env.example -o .env
|
||||
# Edit .env — set WORKSPACE_PATH, an LLM API key (ANTHROPIC_API_KEY,
|
||||
# OPENAI_API_KEY, GEMINI_API_KEY, or AWS_*), and your git identity.
|
||||
docker compose run --rm devbox pi
|
||||
```
|
||||
|
||||
Full setup guide — authentication for each provider (Anthropic, OpenAI, Gemini, AWS Bedrock SSO + static), persistence model, configuration reference, build args, troubleshooting: **<https://gitea.jordbo.se/joakimp/pi-devbox#readme>**
|
||||
|
||||
## What's inside
|
||||
|
||||
Inherited from [opencode-devbox base](https://hub.docker.com/r/joakimp/opencode-devbox):
|
||||
|
||||
Reference in New Issue
Block a user