diff --git a/_docs/template-readme.md b/_docs/template-readme.md index c1369aa..c7c247d 100644 --- a/_docs/template-readme.md +++ b/_docs/template-readme.md @@ -33,7 +33,22 @@ Example: /data – persistent application storage /config – configuration files +## Network Notes + +Requires proxy network + ## Additional Notes / Gotchas Add any special information someone should know before running the project---quirks, caveats, network requirements, etc. + +## Dockhand Stack, Deploy from Git + +Cookbooks Repository +stackname: NAME_HERE +Compose file path: SERVICENAME/compose.yaml +Additional env file (optional): SERVICENAME/sample.env + +Then "Load" SERVICENAME/sample.env into the Environmental variables in dockhand + +Create the Stack \ No newline at end of file diff --git a/archivebox/README.md b/archivebox/README.md new file mode 100644 index 0000000..1670c92 --- /dev/null +++ b/archivebox/README.md @@ -0,0 +1,39 @@ +# 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` + +## 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 + +## 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 diff --git a/archivebox/compose.yaml b/archivebox/compose.yaml new file mode 100644 index 0000000..d08a9a9 --- /dev/null +++ b/archivebox/compose.yaml @@ -0,0 +1,20 @@ +# ARCHIVEBOX + +services: + archivebox: + image: ${ARCHIVEBOX_IMAGE:-archivebox/archivebox:stable} + restart: ${ARCHIVEBOX_RESTART:-unless-stopped} + volumes: + - ${VOL_PATH}/archivebox:/data + environment: + - ARCHIVEBOX_UID=1000 + - ARCHIVEBOX_GID=1000 + - PYTHONUNBUFFERED=1 + networks: + - proxy + command: server --quick-init 0.0.0.0:8000 + +networks: + proxy: + external: true +``` \ No newline at end of file diff --git a/archivebox/sample.env b/archivebox/sample.env new file mode 100644 index 0000000..5b48a95 --- /dev/null +++ b/archivebox/sample.env @@ -0,0 +1,8 @@ +# ARCHIVEBOX +VOL_PATH=./data +ARCHIVEBOX_IMAGE=archivebox/archivebox:stable +# ARCHIVEBOX_IMAGE=archivebox/archivebox:sha-1d49bee # locked example +ARCHIVEBOX_RESTART=unless-stopped +ARCHIVEBOX_UID=1000 +ARCHIVEBOX_GID=1000 +PYTHONUNBUFFERED=1 diff --git a/archivebox_dev/README.md b/archivebox_dev/README.md deleted file mode 100644 index c6bd476..0000000 --- a/archivebox_dev/README.md +++ /dev/null @@ -1,8 +0,0 @@ -# archivebox - -## Overview -Docker Hub: https://hub.docker.com/r/archivebox/archivebox/tags -Docker Compose Example: https://raw.githubusercontent.com/ArchiveBox/ArchiveBox/dev/docker-compose.yml -Project: https://archivebox.io/ -Proxy Port: 8000 - diff --git a/archivebox_dev/docker-compose.yml b/archivebox_dev/docker-compose.yml deleted file mode 100644 index cf39667..0000000 --- a/archivebox_dev/docker-compose.yml +++ /dev/null @@ -1,14 +0,0 @@ -services: - archivebox: - image: ${ARCHIVEBOX_IMAGE:-archivebox/archivebox:stable} - restart: unless-stopped - volumes: - - "archivebox-data:/data" - environment: - - ARCHIVEBOX_UID=1000 - - ARCHIVEBOX_GID=1000 - - PYTHONUNBUFFERED=1 - command: server --quick-init 0.0.0.0:8000 - -volumes: - archivebox-data: diff --git a/archivebox_dev/sample.env b/archivebox_dev/sample.env deleted file mode 100644 index baeeb11..0000000 --- a/archivebox_dev/sample.env +++ /dev/null @@ -1,2 +0,0 @@ -# ARCHIVEBOX -ARCHIVEBOX_IMAGE=archivebox/archivebox:sha-1d49bee