You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+38-2Lines changed: 38 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -32,6 +32,7 @@
32
32
-[Introduction](#introduction)
33
33
-[Prerequisites](#prerequisites)
34
34
-[How It Works](#how-it-works)
35
+
-[Quick Setup](#quick-setup)
35
36
-[Quick Start](#quick-start)
36
37
-[Quick Stop](#quick-stop)
37
38
-[Quick Upgrade](#quick-upgrade)
@@ -42,6 +43,8 @@
42
43
-[Miner](#installation-miner)
43
44
-[Validator](#installation-validator)
44
45
-[Other](#installation-other)
46
+
-[Tools](#tools)
47
+
-[Wandb](#tool-wandb)
45
48
-[Good to Know](#good-to-know)
46
49
-[Troubleshooting](#troubleshooting)
47
50
-[License](#license)
@@ -89,7 +92,7 @@ Here's a breakdown of the key variables:
89
92
Set to `true` if you want the Auto Upgrader to apply both releases and pre-releases. Default is `false`.
90
93
91
94
-**SUBVORTEX_EXECUTION_METHOD**:
92
-
Defines how the neuron and its componentswill be installed by the Auto Upgrader. Options are `process`, `service`, or `container`. Default is `service`.
95
+
Defines how the neuron and its components will be installed by the Auto Upgrader. Options are `process`, `service`, or `container`. Default is `service`.
93
96
94
97
-**SUBVORTEX_PRERELEASE_TYPE**:
95
98
Specifies a single prerelease identifier you want to be notified about. Options are `alpha` (**use ONLY in DEVNET**) or `rc` (**use ONLY in TESTNET**). Remove this variable to receive notifications from `latest` (**use in MAINNET**) prerelease types. Default is an empty string, which disables prerelease notifications.
@@ -120,7 +123,7 @@ Here's a breakdown of the key variables:
120
123
- For miners, edit files matching `env.subvortex.miner.*`
121
124
- For validators, edit files matching `env.subvortex.validator.*`
122
125
123
-
3. Update the templates inside the `subvortex/auto_upgrader/template` folder.
126
+
3. Update the templates inside the `subvortex/auto_upgrader/template` folder. Recommended to keep as it is.
124
127
125
128
<br />
126
129
@@ -137,6 +140,9 @@ In these modes, the Auto Upgrader checks GitHub every **SUBVORTEX_CHECK_INTERVAL
137
140
3. Updates the symlink to point to the new version
138
141
4. Cleans up the previous version
139
142
143
+
➡️ The execution directory for SubVortex will now be located under `$HOME/subvortex`, with each version in its own subdirectory and a symlink pointing to the current version.
144
+
You no longer need to clone the SubVortex repository manually — and can safely remove any old local copies you previously cloned.
145
+
140
146
🐳 Docker Mode
141
147
142
148
Here, the Auto Upgrader also checks GitHub every **SUBVORTEX_CHECK_INTERVAL** seconds. When a new release is found:
@@ -167,6 +173,20 @@ Then, copy that token as value of `SUBVORTEX_GITHUB_TOKEN` in the main Auto Upgr
167
173
168
174
<br />
169
175
176
+
# 🚀 Quick Setup <aid="quick-setup"></a>
177
+
178
+
To setup the Auto Upgrader in a quick way, you can run
0 commit comments