Skip to content

Commit 279a082

Browse files
l4rm4ndl4rm4nd
committed
add archivebox
1 parent 37037ec commit 279a082

File tree

4 files changed

+152
-0
lines changed

4 files changed

+152
-0
lines changed

‎README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -133,6 +133,7 @@ docker compose up
133133
- [Ombi](examples/ombi) - Ombi is a tool that enables users to manage requests for movies and TV shows on their Plex server. It provides an easy-to-use interface for users to request new content, leave notes and report issues. Ombi also offers notification and newsletter features, making it easier for server owners to manage user requests and share new content updates.
134134
- [LibrePhotos](examples/librephotos) - A self-hosted open source photo management service, with face recognition, geolocation, and more.
135135
- [Chevereto](examples/chevereto) - Ultimate image sharing software. Create your very own personal image hosting website in just minutes.
136+
- [Archivebox](examples/archivebox) - ArchiveBox is a powerful, self-hosted internet archiving solution to collect, save, and view websites offline.
136137

137138
### Document Management Systems (DMS)
138139
- [Paperless NGX](examples/paperless-ngx) - A community-supported supercharged version of paperless: scan, index and archive all your physical documents.
@@ -203,6 +204,7 @@ docker compose up
203204
- [Duplicati](examples/duplicati) - Duplicati is a backup client that securely stores encrypted, incremental, compressed remote backups of local files on cloud storage services and remote file servers.
204205
- [Duplicacy](examples/duplicacy) - A lock-free deduplication cloud backup tool.
205206
- [Syncthing](examples/syncthing) - Syncthing is a continuous file synchronization program. It synchronizes files between two or more computers.
207+
- [Archivebox](examples/archivebox) - ArchiveBox is a powerful, self-hosted internet archiving solution to collect, save, and view websites offline.
206208

207209
### Wiki & Knowledge Base
208210
- [Bookstack](examples/bookstack) - BookStack is a free and open-source wiki software aimed for a simple, self-hosted, and easy-to-use platform.

‎examples/archivebox/README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# References
2+
3+
- https://github.com/ArchiveBox/ArchiveBox
4+
- https://github.com/ArchiveBox/ArchiveBox/blob/dev/docker-compose.yml
5+
6+
# Notes
7+
8+
Before starting the compose stack, ensure that you have downloaded the sonic configuration file, if you plan on using the sonic container.
9+
10+
Place the config file in the bind volume mount path for sonic.
11+
12+
The default username and password are: archivebox

‎examples/archivebox/docker-compose.yml

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
version: "3.9"
2+
3+
services:
4+
archivebox:
5+
image: archivebox/archivebox:dev
6+
container_name: archivebox
7+
command: server --quick-init 0.0.0.0:8000
8+
restart: unless-stopped
9+
ports:
10+
- 8000:8000
11+
expose:
12+
- 8000
13+
volumes:
14+
- ${DOCKER_VOLUME_STORAGE:-/mnt/docker-volumes}/archivebox/data:/data # archivebox application data
15+
- ${DOCKER_VOLUME_STORAGE:-/mnt/docker-volumes}/archivebox/crontabs:/var/spool/cron/crontabs # archivebox crontab data for scheduled runs
16+
#- ${DOCKER_VOLUME_STORAGE:-/mnt/docker-volumes}/archivebox/source-code:/app/archivebox # bind mounts the archivebox source code for development
17+
environment:
18+
# see https://docs.archivebox.io/en/master/Configuration.html for more details
19+
- ADMIN_USERNAME=archivebox # your initial username
20+
- ADMIN_PASSWORD=archivebox # your initial password
21+
- ALLOWED_HOSTS=*
22+
- PUBLIC_INDEX=False
23+
- PUBLIC_SNAPSHOTS=False
24+
- PUBLIC_ADD_VIEW=False
25+
- PUID=1000
26+
- PGID=1000
27+
- SEARCH_BACKEND_ENGINE=sonic
28+
- SEARCH_BACKEND_HOST_NAME=sonic
29+
- SEARCH_BACKEND_PASSWORD=deport-silver-showcase-pusher-radiantly
30+
- MEDIA_MAX_SIZE=750m
31+
- TIMEOUT=60
32+
- CHECK_SSL_VALIDITY=False
33+
- SAVE_ARCHIVE_DOT_ORG=False
34+
#networks:
35+
# - proxy
36+
# - archivebox_default
37+
#labels:
38+
# - traefik.enable=true
39+
# - traefik.docker.network=proxy
40+
# - traefik.http.routers.archivebox.rule=Host(`archive.exmple.com`)
41+
# - traefik.http.services.archivebox.loadbalancer.server.port=8000
42+
# # Part for optional traefik middlewares
43+
# - traefik.http.routers.archivebox.middlewares=local-ipwhitelist@file
44+
45+
46+
### Example: To run the Sonic full-text search backend, first download the config file to sonic.cfg
47+
# $ curl -O https://raw.githubusercontent.com/ArchiveBox/ArchiveBox/master/etc/sonic.cfg
48+
# After starting, backfill any existing Snapshots into the full-text index:
49+
# $ docker-compose run archivebox update --index-only
50+
51+
sonic:
52+
image: valeriansaliou/sonic:latest
53+
container_name: archivebox-sonic
54+
expose:
55+
- 1491
56+
environment:
57+
- SEARCH_BACKEND_PASSWORD=deport-silver-showcase-pusher-radiantly
58+
volumes:
59+
# Example: To run the Sonic full-text search backend, first download the config file to sonic.cfg
60+
# curl https://raw.githubusercontent.com/ArchiveBox/ArchiveBox/master/etc/sonic.cfg -o /mnt/docker-volumes/archivebox/sonic/sonic.cfg
61+
# After starting, backfill any existing Snapshots into the full-text index:
62+
# $ docker-compose run archivebox update --index-only
63+
- ${DOCKER_VOLUME_STORAGE:-/mnt/docker-volumes}/archivebox/sonic/sonic.cfg:/etc/sonic.cfg:ro
64+
- ${DOCKER_VOLUME_STORAGE:-/mnt/docker-volumes}/archivebox/sonic/store:/var/lib/sonic/store
65+
#networks:
66+
# - archivebox_default
67+
68+
#networks:
69+
# proxy:
70+
# external: true
71+
# archivebox_default:
72+
# external: false

‎examples/archivebox/sonic.cfg

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
# Sonic
2+
# Fast, lightweight and schema-less search backend
3+
# Configuration file
4+
# Example: https://github.com/valeriansaliou/sonic/blob/master/config.cfg
5+
6+
7+
[server]
8+
9+
log_level = "warn"
10+
11+
12+
[channel]
13+
14+
inet = "0.0.0.0:1491"
15+
tcp_timeout = 300
16+
17+
auth_password = "${env.SEARCH_BACKEND_PASSWORD}"
18+
19+
[channel.search]
20+
21+
query_limit_default = 65535
22+
query_limit_maximum = 65535
23+
query_alternates_try = 10
24+
25+
suggest_limit_default = 5
26+
suggest_limit_maximum = 20
27+
28+
29+
[store]
30+
31+
[store.kv]
32+
33+
path = "/var/lib/sonic/store/kv/"
34+
35+
retain_word_objects = 100000
36+
37+
[store.kv.pool]
38+
39+
inactive_after = 1800
40+
41+
[store.kv.database]
42+
43+
flush_after = 900
44+
45+
compress = true
46+
parallelism = 2
47+
max_files = 100
48+
max_compactions = 1
49+
max_flushes = 1
50+
write_buffer = 16384
51+
write_ahead_log = true
52+
53+
[store.fst]
54+
55+
path = "/var/lib/sonic/store/fst/"
56+
57+
[store.fst.pool]
58+
59+
inactive_after = 300
60+
61+
[store.fst.graph]
62+
63+
consolidate_after = 180
64+
65+
max_size = 2048
66+
max_words = 250000

0 commit comments

Comments
 (0)