Skip to content

README.md

Latest commit

 

History

History
211 lines (139 loc) · 4.38 KB

README.md

File metadata and controls

211 lines (139 loc) · 4.38 KB

← Back to Main README

🛠️ Auto Upgrader Setup Guide

This guide explains how to install and uninstall Auto Upgrader, the tool responsible for keeping your services up to date.

📑 Contents



🛠️ Installation

You can install the Auto Upgrader in one of three ways:

  • As a process (using PM2)
  • As a system service (using systemd)
  • As a container (using Docker)

▶️ Run as Process

  1. Set the execution method in .env:
SUBVORTEX_EXECUTION_METHOD=process
  1. Run the setup script:
./subvortex/auto_upgrader/deployment/process/auto_upgrader_process_setup.sh
  1. Start the Auto Upgrader:
./subvortex/auto_upgrader/deployment/process/auto_upgrader_process_start.sh
  1. Verify it's running:
pm2 list

You should see a process named subvortex-auto-upgrader.

To check logs:

pm2 log subvortex-auto-upgrader

🛡️ Run as Service

  1. Set the execution method in .env:
SUBVORTEX_EXECUTION_METHOD=service
  1. Run the setup script:
./subvortex/auto_upgrader/deployment/service/auto_upgrader_service_setup.sh
  1. Start the Auto Upgrader:
./subvortex/auto_upgrader/deployment/service/auto_upgrader_service_start.sh
  1. Check the service status:
systemctl status subvortex-auto-upgrader

You should see something like

Loaded: loaded (/etc/systemd/system/subvortex-auto-upgrader.service; enabled; vendor preset: enabled)
     Active: active (running) since Thu 2025-04-10 11:51:27 BST; 6s ago
   Main PID: 2229560 (python3)
      Tasks: 10 (limit: 28765)
     Memory: 57.9M
        CPU: 1.592s
     CGroup: /system.slice/subvortex-auto-upgrader.service
             └─2229560 /root/SubVortex.AutoUpgrader/subvortex/auto_upgrader/venv/bin/python3 -m subvortex.auto_upgrader.src.main

To view logs:

tail -f /var/log/subvortex-auto-upgrader/subvortex-auto-upgrader.log

🐳 Run as Container

⚠️ The Auto Upgrader is not yet available to run inside a Docker container. Please run it via service or process.

Before installing the Auto Upgrader as a container, be sure you have docker installed. If not, you can run

./scripts/docker/docker_setup.sh
  1. Set the execution method in .env:
SUBVORTEX_EXECUTION_METHOD=docker
  1. Run the setup script:
./subvortex/auto_upgrader/deployment/docker/auto_upgrader_docker_setup.sh
  1. Start the Auto Upgrader:
./subvortex/auto_upgrader/deployment/docker/auto_upgrader_docker_start.sh
  1. Confirm it's running:
docker ps

Look for a container named subvortex-auto-upgrader.

To follow logs:

docker logs -f subvortex-auto-upgrader

🧹 Uninstallation

❌ Remove Process

To stop and remove the Auto Upgrader running as a process:

./subvortex/auto_upgrader/deployment/process/auto_upgrader_process_teardown.sh

Confirm it's removed:

pm2 list

The subvortex-auto-upgrader process should no longer appear.

❌ Remove Service

To uninstall the Auto Upgrader running as a system service:

./subvortex/auto_upgrader/deployment/service/auto_upgrader_service_teardown.sh

Check that the service is removed:

systemctl status subvortex-auto-upgrader

You should see:

Unit subvortex-auto-upgrader.service could not be found.

❌ Remove Container

⚠️ The Auto Upgrader is not yet available to run inside a Docker container. Please run it via service or process.

To tear down the Auto Upgrader container:

./subvortex/auto_upgrader/deployment/docker/auto_upgrader_docker_teardown.sh

Verify it's gone:

docker ps

The subvortex-auto-upgrader container should no longer be listed.

Need help or want to chat with other SubVortex users?
Join us on Discord!