You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
chore: Consolidate compose files, update docs for S3/Garage, remove stale files
The repo had unnecessary docker-compose.prod.yml and docker-compose.local-test.yml
files. docker-compose.yml is now the single production-ready base (pulls published
GHCR image by default), and docker-compose.override.example.yml handles local dev
overrides. All MinIO references across 10+ docs updated to S3/Garage to match the
migration completed in usnavy13#90. Removed stale Reference/ directory and placeholder
AGENTS.md.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
API_IMAGE=ghcr.io/usnavy13/librecodeinterpreter:<tag> docker compose up -d
39
38
```
40
39
41
40
4.**Verify the API**
@@ -47,25 +46,25 @@ Most users should run the published Docker image from GHCR. You do not need to b
47
46
The API will be available at `http://localhost:8000`.
48
47
Visit `http://localhost:8000/docs` for the interactive API documentation.
49
48
50
-
To enable HTTPS with either compose file, set `PORT`, `ENABLE_HTTPS`, `SSL_CERTS_PATH`, `SSL_CERT_FILE`, and `SSL_KEY_FILE` in `.env`. `SSL_CERTS_PATH` is the host path mounted into the container at `/app/ssl`, while `SSL_CERT_FILE` and `SSL_KEY_FILE` must point to the certificate files inside the container. See [docs/CONFIGURATION.md](docs/CONFIGURATION.md#sslhttps-configuration).
49
+
To enable HTTPS, set `PORT`, `ENABLE_HTTPS`, `SSL_CERTS_PATH`, `SSL_CERT_FILE`, and `SSL_KEY_FILE` in `.env`. `SSL_CERTS_PATH` is the host path mounted into the container at `/app/ssl`, while `SSL_CERT_FILE` and `SSL_KEY_FILE` must point to the certificate files inside the container. See [docs/CONFIGURATION.md](docs/CONFIGURATION.md#sslhttps-configuration).
51
50
52
51
### Common Consumer Commands
53
52
54
53
```bash
55
54
# View API logs
56
-
docker compose -f docker-compose.prod.yml logs -f api
55
+
docker compose logs -f api
57
56
58
57
# Stop the stack
59
-
docker compose -f docker-compose.prod.yml down
58
+
docker compose down
60
59
61
60
# Update to the latest published image
62
-
docker compose -f docker-compose.prod.yml pull
63
-
docker compose -f docker-compose.prod.yml up -d
61
+
docker compose pull
62
+
docker compose up -d
64
63
```
65
64
66
65
### Published Image Channels
67
66
68
-
The project now publishes two app-image channels:
67
+
The project publishes two app-image channels:
69
68
70
69
-`ghcr.io/usnavy13/librecodeinterpreter`
71
70
- stable branch tags: `main`, `latest`
@@ -74,45 +73,42 @@ The project now publishes two app-image channels:
74
73
- development branch tags: `dev`, `latest`
75
74
- immutable build tags: `sha-<commit>`
76
75
77
-
`docker-compose.prod.yml`stays pinned to the stable package by default:
76
+
`docker-compose.yml`is pinned to the stable package by default:
If you want to pull the current `dev` image or build from your working tree without changing tracked compose files:
84
+
If you want to pull the current `dev` image or build from your working tree without changing tracked compose files, use a local override. Compose auto-merges `docker-compose.override.yml` on top of `docker-compose.yml`, so no extra `-f` flags are needed.
docker compose -f docker-compose.prod.yml -f docker-compose.override.yml up -d
95
+
docker compose pull
96
+
docker compose up -d
98
97
```
99
98
100
-
The checked-in example defaults to `ghcr.io/usnavy13/librecodeinterpreter-dev:latest`.
101
-
If you want to build from your local checkout instead, edit `docker-compose.override.yml`
102
-
and switch to the commented `build:` block in the example. In that case, skip the
103
-
`pull` step and run:
99
+
The checked-in example defaults to `ghcr.io/usnavy13/librecodeinterpreter-dev:latest`. To build from your local checkout instead, edit `docker-compose.override.yml` and switch to the commented `build:` block. In that case, skip `pull` and run:
104
100
105
101
```bash
106
-
docker compose -f docker-compose.prod.yml -f docker-compose.override.yml up --build -d
102
+
docker compose up --build -d
107
103
```
108
104
109
105
## Build From Source
110
106
111
-
If you are developing locally or need to customize the image, use the source-backed workflow instead:
107
+
If you are developing locally or need to customize the image:
API_IMAGE=code-interpreter:nsjail docker compose up -d
116
112
```
117
113
118
114
The Dockerfile keeps `runtime-core` and `runtime-r` as internal build stages, but only the unified `app` image is published for deployment.
@@ -125,7 +121,7 @@ A built-in admin dashboard is available at `http://localhost:8000/admin-dashboar
125
121
126
122
- **Overview**: Real-time execution metrics, success rates, and performance graphs
127
123
- **API Keys**: Create, view, and manage API keys with rate limiting
128
-
- **System Health**: Monitor Redis, MinIO, and sandbox pool status
124
+
- **System Health**: Monitor Redis, S3 storage, and sandbox pool status
129
125
130
126
The dashboard requires the master API key for authentication.
131
127
@@ -139,9 +135,9 @@ The dashboard requires the master API key for authentication.
139
135
- **Programmatic Tool Calling (PTC)**: Enables AI agents to execute code that invokes external tools mid-execution via `POST /exec/programmatic`, with multi-round continuation support
140
136
- **File Management**: Upload, download, and manage files within execution sessions
141
137
- **Session Management**: Redis-based session handling with automatic cleanup
142
-
- **S3-Compatible Storage**: MinIO integration for persistent file storage
138
+
- **S3-Compatible Storage**: Garage (S3-compatible) integration for persistent file storage
143
139
- **Authentication**: API key-based authentication for secure access
144
-
- **HTTPS/SSL Support**: Optional in-container SSL/TLS termination for both compose workflows
0 commit comments