Skip to content

Commit fbb24e9

Browse files
eclipsevortexeclipsevortex
committed
update docs
1 parent acfb3d4 commit fbb24e9

5 files changed

Lines changed: 47 additions & 102 deletions

File tree

‎subvortex/miner/neuron/README.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,17 @@ systemctl status subvortex-miner-neuron
102102
You should see something like
103103

104104
```bash
105+
● subvortex-miner-neuron.service - SubVortex Miner Neuron
106+
Loaded: loaded (/etc/systemd/system/subvortex-miner-neuron.service; disabled; vendor preset: enabled)
107+
Active: active (running) since Tue 2025-05-06 18:58:12 CEST; 1s ago
108+
Main PID: 2545963 (python3)
109+
Tasks: 8 (limit: 19116)
110+
Memory: 62.9M
111+
CPU: 1.854s
112+
CGroup: /system.slice/subvortex-miner-neuron.service
113+
└─2545963 /root/SubVortex2/subvortex/miner/neuron/venv/bin/python3 -m subvortex.miner.neuron.src.main --subtensor.network local --use.local.workdir --wallet.hotkey default --axon.ip 127.0.0.1 --axon.port 8091 --net>
105114

115+
May 06 18:58:12 vmi1561561.contaboserver.net systemd[1]: Started SubVortex Miner Neuron.
106116
```
107117

108118
## As docker container <a id="installation-as-container"></a>
@@ -116,6 +126,8 @@ If you are not using the Auto Upgrader, you have to prefix all these commands by
116126
export SUBVORTEX_FLOATTING_FLAG=latest
117127
```
118128

129+
For testnet, you can use `latest` (release) or `stable` (release candidate).
130+
119131
To build the Miner, you can run
120132

121133
```bash

‎subvortex/validator/neuron/README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,8 @@ If you are not using the Auto Upgrader, you have to prefix all these commands by
121121
export SUBVORTEX_FLOATTING_FLAG=latest
122122
```
123123

124+
For testnet, you can use `latest` (release) or `stable` (release candidate).
125+
124126
To build the Validator, you can run
125127

126128
```bash

‎subvortex/validator/redis/README.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,29 @@ May 05 17:25:56 vmi1610615.contaboserver.net systemd[1]: Starting SubVortex Vali
115115
May 05 17:25:57 vmi1610615.contaboserver.net systemd[1]: Started SubVortex Validator Redis.
116116
```
117117

118+
If you have these kind of logs
119+
120+
```bash
121+
⚙️ Setting up for 'process' mode...
122+
🔧 Setting up subvortex-validator-redis...
123+
🚀 Installing Redis server if not already installed...
124+
✅ redis-server already installed.
125+
📂 Preparing redis directory...
126+
✅ No redis binary or config changes detected — skipping redis.conf update.
127+
🔐 Redis password already up-to-date — no changes made.
128+
📄 Forcing logfile to stdout/stderr (logfile "")...
129+
🚫 Masking default redis-server systemd service...
130+
📁 Ensuring Redis data directory exists: /var/lib/redis
131+
✅ Validator Redis setup completed successfully.
132+
✅ Process setup complete.
133+
```
134+
135+
With a lot of `no changed detected`, you can remove the checksums in order to reinstall everything from scratch
136+
137+
```bash
138+
rm -rf /var/tmp/subvortex.checksums/*
139+
```
140+
118141
## As docker container <a id="installation-as-container"></a>
119142
120143
> **IMPORTANT** <br />
@@ -126,6 +149,8 @@ If you are not using the Auto Upgrader, you have to prefix all these commands by
126149
export SUBVORTEX_FLOATTING_FLAG=latest
127150
```
128151
152+
For testnet, you can use `latest` (release) or `stable` (release candidate).
153+
129154
To build the Validator Redis, you can run
130155
131156
```bash

‎subvortex/validator/redis/deployment/process/redis_process_setup.sh‎

Lines changed: 4 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -68,54 +68,7 @@ if [[ ! -f "$TEMPLATE_CONF" ]]; then
6868
fi
6969
checksum_changed "$TEMPLATE_CONF" "redis.conf.template" && CONF_CHANGED=true || CONF_CHANGED=false
7070

71-
### Phase 3: Pre-Deployment Checks
72-
73-
# Determine working Redis password
74-
# determine_working_password() {
75-
# local env_pass conf_pass
76-
77-
# env_pass="${SUBVORTEX_REDIS_PASSWORD:-}"
78-
# if [[ -f "$REDIS_CONF" ]]; then
79-
# conf_pass=$(grep -E '^\s*requirepass\s+' "$REDIS_CONF" | awk '{print $2}' || true)
80-
# else
81-
# conf_pass=""
82-
# fi
83-
84-
# try_passwords=()
85-
86-
# [[ -n "$env_pass" ]] && try_passwords+=("$env_pass")
87-
# [[ -n "$conf_pass" && "$conf_pass" != "$env_pass" ]] && try_passwords+=("$conf_pass")
88-
89-
# for pass in "${try_passwords[@]}"; do
90-
# if redis-cli -a "$pass" PING 2>/dev/null | grep -q PONG; then
91-
# echo "$pass"
92-
# return 0
93-
# fi
94-
# done
95-
96-
# # Try unauthenticated (empty password)
97-
# if redis-cli PING 2>/dev/null | grep -q PONG; then
98-
# echo ""
99-
# return 0
100-
# fi
101-
102-
# return 1 # No working password
103-
# }
104-
105-
# echo "🔍 Testing available Redis passwords..."
106-
# if REDISCLI_AUTH="${SUBVORTEX_REDIS_PASSWORD:-}"; then
107-
# export REDISCLI_AUTH
108-
# if [[ -n "$REDISCLI_AUTH" ]]; then
109-
# echo "✅ Found working Redis password"
110-
# else
111-
# echo "✅ Redis allows unauthenticated access"
112-
# fi
113-
# else
114-
# echo "❌ Failed to connect to Redis using provided or config password"
115-
# exit 1
116-
# fi
117-
118-
### Phase 4: Data Preservation
71+
### Phase 3: Data Preservation
11972

12073
if [[ "$REDIS_CHANGED" == true || "$CONF_CHANGED" == true ]]; then
12174
# echo "📤 Dumping Redis data..."
@@ -126,7 +79,7 @@ if [[ "$REDIS_CHANGED" == true || "$CONF_CHANGED" == true ]]; then
12679
sudo systemctl disable redis-server || true
12780
fi
12881

129-
### Phase 5: Configuration Deployment
82+
### Phase 4: Configuration Deployment
13083

13184
# Prepare /etc/redis directory
13285
echo "📂 Preparing redis directory..."
@@ -171,13 +124,13 @@ else
171124
echo 'logfile ""' | sudo tee -a "$REDIS_CONF" > /dev/null
172125
fi
173126

174-
### Phase 6: Systemd Unit Deployment
127+
### Phase 5: Systemd Unit Deployment
175128

176129
# Mask default redis-server systemd service
177130
echo "🚫 Masking default redis-server systemd service..."
178131
sudo systemctl mask redis-server || true
179132

180-
### Phase 7: Post-Deployment Verification
133+
### Phase 6: Post-Deployment Verification
181134

182135
# Ensure Redis data directory exists and has correct permissions
183136
REDIS_DATA_DIR=$(grep -E '^\s*dir\s+' "$REDIS_CONF" | awk '{print $2}')

‎subvortex/validator/redis/deployment/service/redis_service_setup.sh‎

Lines changed: 4 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -76,54 +76,7 @@ if [[ ! -f "$TEMPLATE_SERVICE" ]]; then
7676
fi
7777
checksum_changed "$TEMPLATE_SERVICE" "systemd.unit.template" && UNIT_CHANGED=true || UNIT_CHANGED=false
7878

79-
### Phase 3: Pre-Deployment Checks
80-
81-
# Determine working Redis password
82-
# determine_working_password() {
83-
# local env_pass conf_pass
84-
85-
# env_pass="${SUBVORTEX_REDIS_PASSWORD:-}"
86-
# if [[ -f "$REDIS_CONF" ]]; then
87-
# conf_pass=$(grep -E '^\s*requirepass\s+' "$REDIS_CONF" | awk '{print $2}' || true)
88-
# else
89-
# conf_pass=""
90-
# fi
91-
92-
# try_passwords=()
93-
94-
# [[ -n "$env_pass" ]] && try_passwords+=("$env_pass")
95-
# [[ -n "$conf_pass" && "$conf_pass" != "$env_pass" ]] && try_passwords+=("$conf_pass")
96-
97-
# for pass in "${try_passwords[@]}"; do
98-
# if redis-cli -a "$pass" PING 2>/dev/null | grep -q PONG; then
99-
# echo "$pass"
100-
# return 0
101-
# fi
102-
# done
103-
104-
# # Try unauthenticated (empty password)
105-
# if redis-cli PING 2>/dev/null | grep -q PONG; then
106-
# echo ""
107-
# return 0
108-
# fi
109-
110-
# return 1 # No working password
111-
# }
112-
113-
# echo "🔍 Testing available Redis passwords..."
114-
# if REDISCLI_AUTH="${SUBVORTEX_REDIS_PASSWORD:-}"; then
115-
# export REDISCLI_AUTH
116-
# if [[ -n "$REDISCLI_AUTH" ]]; then
117-
# echo "✅ Found working Redis password"
118-
# else
119-
# echo "✅ Redis allows unauthenticated access"
120-
# fi
121-
# else
122-
# echo "❌ Failed to connect to Redis using provided or config password"
123-
# exit 1
124-
# fi
125-
126-
### Phase 4: Data Preservation
79+
### Phase 3: Data Preservation
12780

12881
if [[ "$REDIS_CHANGED" == true || "$CONF_CHANGED" == true ]]; then
12982
# echo "📤 Dumping Redis data..."
@@ -134,7 +87,7 @@ if [[ "$REDIS_CHANGED" == true || "$CONF_CHANGED" == true ]]; then
13487
sudo systemctl disable redis-server || true
13588
fi
13689

137-
### Phase 5: Configuration Deployment
90+
### Phase 4: Configuration Deployment
13891

13992
# Prepare /etc/redis directory
14093
echo "📂 Preparing redis directory..."
@@ -184,7 +137,7 @@ else
184137
echo "✅ Log directory ready and owned by $REDIS_USER:$REDIS_GROUP"
185138
fi
186139

187-
### Phase 6: Systemd Unit Deployment
140+
### Phase 5: Systemd Unit Deployment
188141

189142
# Mask default redis-server systemd service
190143
echo "🚫 Masking default redis-server systemd service..."
@@ -202,7 +155,7 @@ fi
202155
echo "🔧 Reloading systemd daemon..."
203156
sudo systemctl daemon-reload
204157

205-
### Phase 7: Post-Deployment Verification
158+
### Phase 6: Post-Deployment Verification
206159

207160
# Ensure Redis data directory exists and has correct permissions
208161
REDIS_DATA_DIR=$(grep -E '^\s*dir\s+' "$REDIS_CONF" | awk '{print $2}')

0 commit comments

Comments
 (0)