Installation and Updates #

Deploy from Pre-compiled Binary (Recommended) #

Download the binary file for your platform from the Release page.

Create a config.toml file in the extracted directory, refer to the Configuration Guide to edit the configuration file.

Run:

chmod +x saveany-bot
./saveany-bot

Daemon #

systemd (Regular Linux)

Create a file /etc/systemd/system/saveany-bot.service and write the following content:

[Unit]
Description=SaveAnyBot
After=systemd-user-sessions.service

[Service]
Type=simple
WorkingDirectory=/yourpath/
ExecStart=/yourpath/saveany-bot
Restart=always

[Install]
WantedBy=multi-user.target

Enable startup on boot and start the service:

systemctl enable --now saveany-bot

procd (OpenWrt)

Add Boot Autostart Service

Create a file /etc/init.d/saveanybot, refer to wrt_init and modify as needed:

#!/bin/sh /etc/rc.common

#This is the OpenWRT init.d script for SaveAnyBot

START=99 
STOP=10
description=&#34;SaveAnyBot&#34;

WORKING_DIR=&#34;/mnt/mmc1-1/SaveAnyBot&#34;
EXEC_PATH=&#34;$WORKING_DIR/saveany-bot&#34;
start() {
    echo &#34;Starting SaveAnyBot...&#34;
    cd $WORKING_DIR
    $EXEC_PATH &amp;
}
stop() {
    echo &#34;Stopping SaveAnyBot...&#34;
    killall saveany-bot
}
reload() {
    stop
    start
}

Set permissions:

chmod +x /etc/init.d/saveanybot

Then copy the file to /etc/rc.d and rename it to S99saveanybot, also set permissions:

chmod +x /etc/rc.d/S99saveanybot

Add Shortcut Commands

Create a file /usr/bin/sabot, refer to wrt_bin and modify as needed. Note that the file encoding here only supports ANSI 936. Then set permissions:

chmod +x /usr/bin/sabot

Deploy Using Docker #

Docker Compose #

Download the docker-compose.yml file, create a new config.toml file in the same directory, refer to config.example.toml to edit the configuration file.

Start:

docker compose up -d

Docker #

docker run -d --name saveany-bot \
    -v /path/to/config.toml:/app/config.toml \
    -v /path/to/downloads:/app/downloads \
    ghcr.io/krau/saveany-bot:latest

About Docker image variants
Default: Includes all features and dependencies, larger in size. Use this if you don't have special requirements.
micro: Slimmed-down image with some optional dependencies removed, smaller in size.
pico: Minimal image containing only core features, smallest in size.
You can pull different variants by specifying tags, for example: ghcr.io/krau/saveany-bot:micro
For more details about the variants, see the Dockerfile in the project root.

Updates #

If you deployed from pre-compiled binaries, use the following CLI command to update:

./saveany-bot up

(upgrade is also available as an alias.)

The command replaces the binary in place; a running bot keeps the old version until it is restarted. You can also send /update to the bot: it downloads the new version, replaces its own binary and restarts itself in place (on Windows it exits instead, and the service manager starts the new version).

If you deployed with Docker, use the following commands to update:

docker:

docker pull ghcr.io/krau/saveany-bot:latest
docker restart saveany-bot

docker compose:

docker compose pull
docker compose restart