archivst/cli-webui repository overview

Archivst is a archival cloud storage service, allowing very low cost cloud backup addressing key concerns of keeping archival costs to a minimum. Being configurable to not backup changes or minimize versioning and compress large images.

This image is a self-contained implementation of our CLI tool with a web UI for creating a backupset for configuration backups over mounted folders. This acts as a companion for Archivst applications allowing easy execution in container enabled system. Envisioned for use on NAS devices and will be primarily supported for that.

⁠Mounting Folders for Backup

Folders you want backed up will need to be added to the container, you can also add a permanent config folder, you must secure this so the api key is safe.

./ValuableData maps to /ValuableData inside the container

./config maps to /config (a store for the backupset file)

⁠Docker Run

docker run -d --name arc -p 8080:8080 archivst/cli-webui

⁠Docker Arguments

docker run -d \
  -p 8080:8080 \
  -e ARCHIVST_API_KEY="$ARCHIVST_API_KEY" \
  -e WEBUI_API_KEY="$WEBUI_API_KEY" \
  -e BACKUPSET_FILE=/config/defaultset.json \
  -v "${PATH1}/ValuableData:/ValuableData:ro" \
  -v "${PATH2}/config:/config" \
  archivst/cli-webui

⁠Compose Quick Start

⁠Create file docker-compose.yml

services:
   webui:
     image: archivst/cli-webui
     ports:
       - "8080:8080"
     environment:
       ARCHIVST_API_KEY_FILE: /run/secrets/ARCHIVST_API_KEY
     secrets:
       - ARCHIVST_API_KEY
     volumes:
       - {YourPathToBackupData}:/ValuableData:ro
       - ./config:/config # backupset/config files
secrets:
  ARCHIVST_API_KEY:
    environment: ARCHIVST_API_KEY

⁠Run

1. Put your Archivst API key (Archivst.com → Account → ApiKey) in your environment: export ARCHIVST_API_KEY=CopyFromSite
2. Ensure backup folders and config folder are add in a docker-compose.yml file
3. Run Compose: docker compose up -d
4. http://localhost:8080⁠
5. Configure your backup if you do not have a defaultset.json already