22
33# ** SubVortex Auto Upgrader** <!-- omit in toc -->
44
5+ [ ![ Build & Push] ( https://github.com/eclipsevortex/SubVortex.AutoUpgrader/actions/workflows/docker-workflow.yml/badge.svg?branch=main )] ( https://github.com/eclipsevortex/SubVortex.AutoUpgrader/actions/workflows/docker-workflow.yml )
56[ ![ Discord Chat] ( https://img.shields.io/discord/308323056592486420.svg )] ( https://discord.gg/bittensor )
67[ ![ License: MIT] ( https://img.shields.io/badge/License-MIT-yellow.svg )] ( https://opensource.org/licenses/MIT )
78
89---
910
1011## Effortless Updates for Your Miner & Validator <!-- omit in toc -->
1112
12- [ Discord] ( https://discord.gg/bittensor ) • [ Network] ( https://taostats.io/ ) • [ Research] ( https://bittensor.com/whitepaper )
13+ [ Github ] ( ) [ Discord] ( https://discord.gg/bittensor ) • [ Network] ( https://taostats.io/ ) • [ Research] ( https://bittensor.com/whitepaper )
1314
1415---
1516
2728- [ Prerequisites] ( #prerequisites )
2829- [ How It Works] ( #how-it-works )
2930- [ Quick Start] ( #quick-start )
31+ - [ Quick Stop] ( #quick-stop )
3032- [ Installation] ( #installation )
3133 - [ Run as Process] ( #run-as-process )
3234 - [ Run as Service] ( #run-as-service )
@@ -53,6 +55,11 @@ Simple to set up. Easy to monitor. Zero stress upgrades.
5355
5456# ⚙️ Prerequisites <a id =" prerequisites " ></a >
5557
58+ > ⚠️ ** Architecture Notice**
59+ > The SubVortex Auto Upgrader currently supports only ** x86_64 (amd64)** servers.
60+ > ` arm64 ` support is not yet available but is a work in progress.
61+ > We’re actively collaborating with OTF to bring full compatibility as soon as possible.
62+
5663Before you begin, make sure you clone the Auto Upgrader repository:
5764
5865``` bash
@@ -61,7 +68,7 @@ git clone https://github.com/eclipsevortex/SubVortex.AutoUpgrader.git
6168
6269Then, configure your environment:
6370
64- 1 . Update the environment variables inside the ` environment/ ` folder.
71+ 1 . Update the environment variables inside the ` subvortex/auto_upgrader/ environment/` folder.
6572
6673 - For miners, edit files matching ` env.subvortex.miner.* `
6774 - For validators, edit files matching ` env.subvortex.validator.* `
@@ -100,14 +107,16 @@ When setting up the Auto Upgrader, you can choose from three execution modes: `p
100107🧩 Process & Service Modes
101108
102109In these modes, the Auto Upgrader checks GitHub every ** SUBVORTEX_CHECK_INTERVAL** seconds for new releases. When a new version is available, it:
110+
1031111 . Downloads and unzips the archive for your neuron type (** SUBVORTEX_EXECUTION_ROLE** ) into ** SUBVORTEX_WORKING_DIRECTORY**
104- 2 . Installs the new version
112+ 2 . Install the new version
1051133 . Updates the symlink to point to the new version
1061144 . Cleans up the previous version
107115
108116🐳 Docker Mode
109117
110118Here, the Auto Upgrader also checks GitHub every ** SUBVORTEX_CHECK_INTERVAL** seconds. When a new release is found:
119+
1111201 . It pulls the floating tag that matches your desired release type (** SUBVORTEX_PRERELEASE_TYPE** )
1121212 . It starts the updated container
113122
@@ -123,7 +132,19 @@ To install the Auto Upgrader in a quick way, you can run
123132./scripts/quick_start.sh
124133```
125134
126- It will install the Auto Upgrade as service which is the default mode.
135+ It will install and start the Auto Upgrader as service which is the default mode.
136+
137+ Use ` -h ` to see the options
138+
139+ # 🛑 Quick Stop <a id =" quick-stop " ></a >
140+
141+ To stop the Auto Upgrader in a quick way, you can run
142+
143+ ``` bash
144+ ./scripts/quick_stop.sh
145+ ```
146+
147+ It will stop and teardown the Auto Upgrader.
127148
128149Use ` -h ` to see the options
129150
0 commit comments