mirror of
https://github.com/nickyeoman/docker-compose-cookbooks.git
synced 2026-09-03 18:36:22 +00:00
codeandClaude Fable 5
340866f9f4
Existing content preserved and reordered to the canonical section order; missing sections generated from each stack's compose data (ports, volumes, env vars, image links). Fixes copy-paste errors in Dockhand sections (qbittorrent pointed at archivebox; invokeai/thunderbird said SERVICENAME) and persistant->persistent typos in gatus. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
62 lines
1.6 KiB
Markdown
62 lines
1.6 KiB
Markdown
# ArchiveBox
|
||
|
||
## Overview
|
||
|
||
ArchiveBox is a self-hosted app that lets you preserve content from websites in a variety of formats.
|
||
|
||
## Project Details
|
||
|
||
- **Project Website:** [ARCHIVEBOX](https://archivebox.io/)
|
||
- **Container Image:** [Docker Hub](https://hub.docker.com/r/archivebox/archivebox/tags)
|
||
- **Compose Example:** [Compose](https://raw.githubusercontent.com/ArchiveBox/ArchiveBox/dev/docker-compose.yml)
|
||
- **Documentation:** [Docs](https://github.com/ArchiveBox/ArchiveBox/wiki)
|
||
- **Reverse Proxy Port:** `8000`
|
||
|
||
## Getting Started
|
||
|
||
1. Start the container: `docker compose up -d`
|
||
2. Open http://localhost:8000 in your browser
|
||
3. Follow the initial setup wizard to configure the application
|
||
|
||
## Environment Variable Notes
|
||
|
||
ARCHIVEBOX_IMAGE - you can lock the version like so: ```archivebox/archivebox:sha-1d49bee```
|
||
ARCHIVEBOX_UID - User 1000
|
||
ARCHIVEBOX_GID - Group 1000
|
||
PYTHONUNBUFFERED - Ensures logs are output in real-time
|
||
|
||
## Volume Notes
|
||
|
||
/data – just one volume
|
||
|
||
## Network Notes
|
||
|
||
Requires proxy network
|
||
|
||
## Docker Run
|
||
|
||
```bash
|
||
docker run -d \
|
||
--name archivebox \
|
||
-p 8000:8000 \
|
||
-v /data/archivebox:/data \
|
||
archivebox/archivebox:stable
|
||
```
|
||
|
||
See compose.yaml for the full set of environment variables.
|
||
|
||
## Additional Notes / Gotchas
|
||
|
||
Nothing specific to this stack so far.
|
||
|
||
## Dockhand Stack, Deploy from Git
|
||
|
||
Cookbooks Repository
|
||
stackname: archivebox
|
||
Compose file path: archivebox/compose.yaml
|
||
Additional env file (optional): archivebox/sample.env
|
||
|
||
Then "Load" archivebox/sample.env into the Environmental variables in dockhand
|
||
|
||
Create the Stack
|