Skip to main content

Installation

The service can be installed through the Portainer web interface. 

Learn about creating a new stack.

Docker Compose

Use the following code to install the service:

---
services:
    archivebox:
        image: archivebox/archivebox:latest
        ports:
            - 8820:8000
        network_mode: bridge
        restart: unless-stopped
        volumes:
            - /srv/archivebox:/data
        environment:
            - ADMIN_USERNAME=          # create an admin user on first run with the given user/pass combo
            - ADMIN_PASSWORD=
            - ALLOWED_HOSTS=*                   # restrict this to only accept incoming traffic via specific domain name
            - PUBLIC_INDEX=False                 # set to False to prevent anonymous users from viewing snapshot list
            - PUBLIC_SNAPSHOTS=False             # set to False to prevent anonymous users from viewing snapshot content
            - PUBLIC_ADD_VIEW=False             # set to True to allow anonymous users to submit new URLs to archive

            - PUID=911                        # set to your host user's UID & GID if you encounter permissions issues
            - PGID=911                        # UID/GIDs <500 may clash with existing users and are not recommended
            - MEDIA_MAX_SIZE=750m             # increase this filesize limit to allow archiving larger audio/video files
            - TIMEOUT=60                      # increase this number to 120+ seconds if you see many slow downloads timing out
            - CHECK_SSL_VALIDITY=True         # set to False to disable strict SSL checking (allows saving URLs w/ broken certs)
            - SAVE_ARCHIVE_DOT_ORG=True       # set to False to disable submitting all URLs to Archive.org when archiving