ArchiveBox is a powerful, self-hosted internet archiving solution to collect, save, and view sites you want to preserve offline. You can feed it URLs one at a time, or schedule regular imports from browser bookmarks or history, feeds like RSS, bookmark services like Pocket/Pinboard, and more. It saves snapshots of the URLs you feed it in several formats: HTML, PDF, PNG screenshots, WARC, and more out-of-the-box, with a wide variety of content extracted and preserved automatically (article text, audio/video, git repos, etc.). The goal of ArchiveBox is to sleep soundly knowing the part of the internet you care about will be automatically preserved in durable, easily accessible formats for decades after it goes down. In this step by step guide I will show you how to install ArchiveBox on your Synology NAS using Docker & Portainer.

💡Note: This guide works perfectly with the latest version of ArchiveBox v.0.7.2

• STEP 1

Please Support My work by Making a Donation.

• STEP 2

Install Portainer using my step by step guide. If you already have Portainer installed on your Synology NAS, skip this STEP. Attention: Make sure you have installed the latest Portainer version.

• STEP 3

Make sure you have a synology.me Wildcard Certificate. Follow my guide to get a Wildcard Certificate. If you already have a synology.me Wildcard certificate, skip this STEP.

• STEP 4

Go to Control Panel / Login Portal / Advanced Tab / click Reverse Proxy. Follow the instructions in the image below.

• STEP 5

Now click the “Create” button. Follow the instructions in the image below.

• STEP 6

After you click the Create button, the window below will open. Follow the instructions in the image below.

On the General area, set the Reverse Proxy Name description: type in ArchiveBox. After that, add the following instructions:

Source:
Protocol: HTTPS
Hostname: archivebox.yourname.synology.me
Port: 443

Check Enable HSTS

Destination:
Protocol: HTTP
Hostname: localhost
Port: 8460

• STEP 7

On the Reverse Proxy Rules click the Custom Header tab. Click Create and then, from the drop-down menu, click WebSocket. After you click on WebSocket, two Header Names and two Values will be automatically added. Click Save. Follow the instructions in the image below.

• STEP 8

Go to Control Panel / Network / Connectivity tab/ Check Enable HTTP/2 then click Apply. Follow the instructions in the image below.

• STEP 9

Go to Control Panel / Security / Advanced tab/ Check Enable HTTP Compression then click Apply. Follow the instructions in the image below.

• STEP 10

Go to File Station and open the docker folder. Inside the docker folder, create one new folder and name it archivebox. Follow the instructions in the image below.
Note: Be careful to enter only lowercase, not uppercase letters.

• STEP 11

Log into Portainer using your username and password. On the left sidebar in Portainer, click on Stacks then + Add stack. Follow the instructions in the image below.

• STEP 12

In the Name field type in archivebox. Follow the instructions in the image below.

Note: Copy Paste the code below in the Portainer Stacks Web editor.

version: '3.9'
services:
    archivebox:
        image: archivebox/archivebox:dev
        container_name: ArchiveBox
        hostname: archivebox
        healthcheck:
         test: curl -f http://localhost:8000/ || exit 1
        command: server --quick-init 0.0.0.0:8000
        ports:
           - 8460:8000
        environment:
           - ALLOWED_HOSTS=*
           - MEDIA_MAX_SIZE=2000m
           - PUID=1026
           - PGID=100
           - PUBLIC_INDEX=False             # set to False to prevent anonymous users from viewing snapshot list. Or set to True.
           - PUBLIC_SNAPSHOTS=False         # set to False to prevent anonymous users from viewing snapshot content. Or set to True.
           - PUBLIC_ADD_VIEW=False           # set to True to allow anonymous users to submit new URLs to archive.
          # - 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
        volumes:
            - /volume1/docker/archivebox:/data
        restart: on-failure:5

Note: Before you paste the code above in the Web editor area below, change the value numbers for PUID and PGID with your own PUID and PGID values. (Follow my step by step guide on how to do this.) 1026 is my personal PUID value and 100 is my personal PGID value. You have to type in your own values.

• STEP 13

Scroll down on the page until you see a button named Deploy the stack. Click on it. Follow the instructions in the image below. The installation process can take up to a few minutes. It will depend on your Internet speed connection.

• STEP 14

If everything goes right, you will see the following message at the top right of your screen: “Success Stack successfully deployed“.

• STEP 15

On the left sidebar in Portainer, click Containers. Identify your ArchiveBox instance, then click on the little terminal icon. Follow the instructions in the image below.

• STEP 16

After you click on the little terminal icon at STEP 15, a new page will open. Click Connect. Follow the instructions in the image below.

• STEP 17

After you click Connect at STEP 16, a Console will open. Copy paste the code below and confirm by pressing Enter on your keyboard. Follow the instructions in the image below.

su archivebox

• STEP 18

After you press Enter on your Keyboard at STEP 17, copy paste the code below and confirm by pressing Enter on your keyboard. Follow the instructions in the image below.

archivebox manage createsuperuser

• STEP 19

After you press Enter on your Keyboard at STEP 18, you will be asked to type in your own Username. Type in your own username and confirm by pressing Enter on your keyboard. Follow the instructions in the image below.

• STEP 20

After you press Enter on your Keyboard at STEP 19, you will be asked to type in your own Email Address. Type in your own Email Address and confirm by pressing Enter on your keyboard. Follow the instructions in the image below.

• STEP 21

After you press Enter on your Keyboard at STEP 20, you will be asked to type in your own Password. Type in your own Password and confirm by pressing Enter on your keyboard. Follow the instructions in the image below.

• STEP 22

After you press Enter on your Keyboard at STEP 21, you will be asked to type in your Password again. Type in your Password again and confirm by pressing Enter on your keyboard. Follow the instructions in the image below.

• STEP 23

After a few seconds you will get a message in the terminal that says: “Superuser created successfully.“.

• STEP 24

Go back to STEP 1 or you will deal with karma 🙂.

• STEP 25

Now open your browser and type in your HTTPS/SSL certificate like this https://archivebox.yourname.synology.me that you have previously created at STEP 6. In my case it’s https://archivebox.mariushosting.synology.me If everything goes right, you will see the ArchiveBox Login page. Type in your own Username and Password that you have previously created at STEP 19 and STEP 21, respectively. Click Log in. Follow the instructions in the image below.

• STEP 26

Click ADD+ to add your first website. Follow the instructions in the image below.

• STEP 27

Add new URLs to your archive. Follow the instructions in the image below.

• STEP 28

Scroll down the page then click Add URLs and archive +. Follow the instructions in the image below.

• STEP 29

Wait a few minutes.

• STEP 30

Your ArchiveBox at a glance!

Enjoy ArchiveBox!

🆘TROUBLESHOOTING

If you encounter issues by using this container, make sure to check out the Common Docker issues article.

Note: Can I run Docker on my Synology NAS? See the supported models.
Note: Find out how to update the ArchiveBox container with the latest image.
Note: How to Back Up Docker Containers on your Synology NAS.
Note: How to Free Disk Space on Your NAS if You Run Docker.
Note: How to Schedule Start & Stop For Docker Containers.
Note: How to Activate Email Notifications.
Note: How to Add Access Control Profile on Your NAS.
Note: How to Change Docker Containers Restart Policy.
Note: How to Use Docker Containers With VPN.
Note: Convert Docker Run Into Docker Compose.
Note: How to Clean Docker.
Note: How to Clean Docker Automatically.
Note: Best Practices When Using Docker and DDNS.
Note: Some Docker Containers Need WebSocket.
Note: Find out the Best NAS Models For Docker.
Note: Activate Gmail SMTP For Docker Containers.

This post was updated on Saturday / February 24th, 2024 at 6:15 AM