Skip to content

Commit 2f1f178

Browse files
committed
docs: update Docker image tags and examples to use :1
- Change all examples from :latest to :1 (major version tag) - Add comprehensive Docker tag documentation - Explain tag strategy: :1 (major), :1.4 (minor), :1.4.3 (specific) - Add recommendation to use :1 for production - Update Docker features list with sqlite3 and log routing
1 parent 86d42a4 commit 2f1f178

File tree

1 file changed

+19
-8
lines changed

1 file changed

+19
-8
lines changed

README.md

Lines changed: 19 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -244,7 +244,7 @@ docker run -d \
244244
-e PUID=1000 \
245245
-e PGID=1000 \
246246
-v ./config:/config \
247-
ghcr.io/bakerboy448/redditmodlog:latest
247+
ghcr.io/bakerboy448/redditmodlog:1
248248
249249
# 4. Using Docker Compose (recommended)
250250
docker compose up -d
@@ -270,7 +270,7 @@ docker run -d \
270270
-e REDDIT_PASSWORD=your_password \
271271
-e SOURCE_SUBREDDIT=yoursubreddit \
272272
-v ./config:/config \
273-
ghcr.io/bakerboy448/redditmodlog:latest
273+
ghcr.io/bakerboy448/redditmodlog:1
274274
```
275275
276276
### Docker Compose Example
@@ -280,7 +280,7 @@ version: '3.8'
280280
281281
services:
282282
redditmodlog-opensignups:
283-
image: ghcr.io/bakerboy448/redditmodlog:latest
283+
image: ghcr.io/bakerboy448/redditmodlog:1
284284
container_name: redditmodlog-opensignups
285285
restart: unless-stopped
286286
environment:
@@ -318,10 +318,20 @@ services:
318318
319319
### Docker Image
320320
321-
Pre-built images available at:
322-
- `ghcr.io/bakerboy448/redditmodlog:latest`
323-
- `ghcr.io/bakerboy448/redditmodlog:v1.4.x` (specific versions)
324-
- Multi-architecture: `linux/amd64`, `linux/arm64`
321+
Pre-built images available at GitHub Container Registry:
322+
323+
**Recommended Tags:**
324+
- `ghcr.io/bakerboy448/redditmodlog:1` - Major version (gets v1.x.x updates automatically)
325+
- `ghcr.io/bakerboy448/redditmodlog:1.4` - Minor version (gets v1.4.x patches only)
326+
- `ghcr.io/bakerboy448/redditmodlog:1.4.3` - Specific version (pinned, no updates)
327+
328+
**Other Tags:**
329+
- `ghcr.io/bakerboy448/redditmodlog:latest` - Always latest build (use with caution)
330+
- `ghcr.io/bakerboy448/redditmodlog:sha-<commit>` - Specific commit SHA
331+
332+
**Architectures:** `linux/amd64`, `linux/arm64`
333+
334+
**Recommendation:** Use `:1` for production to get automatic updates within v1 while avoiding breaking changes from v2.
325335
326336
### Docker Features
327337
@@ -330,8 +340,9 @@ Pre-built images available at:
330340
- ✅ Automatic config file updates on version upgrades
331341
- ✅ Single `/config` mount for all persistent data
332342
- ✅ Supports both config file and environment variable configuration
333-
- ✅ Built-in troubleshooting tools (htop, vim)
343+
- ✅ Built-in troubleshooting tools (htop, vim, sqlite3)
334344
- ✅ Health checks for monitoring
345+
- ✅ Proper log routing (INFO→stdout, errors→stderr)
335346
336347
## Systemd Service (Production)
337348

0 commit comments

Comments
 (0)