Merge pull request #20 from eclipsevortex/release/1.1.1

Implement new scripts (#19)

Author: eclipsevortex

README.md

@@ -10,7 +10,7 @@
 
 ## Effortless Updates for Your Miner & Validator <!-- omit in toc -->
 
-[Github]() [Discord](https://discord.gg/bittensor) • [Network](https://taostats.io/) • [Research](https://bittensor.com/whitepaper)
+[Github SubVortex](https://github.com/eclipsevortex/SubVortex) • [Discord Bittensor](https://discord.gg/eRPTJqPa) • [Discord SubVortex](https://discord.gg/sqr83szC)
 
 ---
 
@@ -31,13 +31,14 @@
 
 - [Introduction](#introduction)
 - [Prerequisites](#prerequisites)
-- [How It Works](#how-it-works)
-- [Log Locations](#log-locations)
+- [Release Channels](#release-channels)
 - [Quick Setup](#quick-setup)
 - [Quick Start](#quick-start)
-- [Quick Stop](#quick-stop)
+- [How It Works](#how-it-works)
+- [Monitoring & Logs](#monitoring--logs)
 - [Quick Upgrade](#quick-upgrade)
 - [Quick Restart](#quick-restart)
+- [Quick Stop](#quick-stop)
 - [Quick Clean](#quick-clean)
 - [Installation](#installation)
   - [Auto Upgrader](#installation-auto-upgrader)
@@ -48,6 +49,7 @@
   - [Wandb](#tool-wandb)
 - [Good to Know](#good-to-know)
 - [Troubleshooting](#troubleshooting)
+- [Support Scope](#support-scope)
 - [License](#license)
 
 <br />
@@ -128,6 +130,47 @@ Here's a breakdown of the key variables:
 
 <br />
 
+# 🧪 Release Channels <a id="release-channels"></a>
+
+| Release Type | Description                     | Recommended Usage |
+| ------------ | ------------------------------- | ----------------- |
+| `alpha`      | Experimental, unstable builds   | DEVNET only       |
+| `rc`         | Release Candidates (pre-launch) | TESTNET only      |
+| _(empty)_    | Latest stable public release    | MAINNET only      |
+
+<br />
+
+# 🚀 Quick Setup <a id="quick-setup"></a>
+
+⚠️ Note: This step is usually not required. The Auto Upgrader automatically handles setup for you.
+Use this only if you encounter issues or need to manually prepare a specific version.
+
+To setup the Auto Upgrader in a quick way, you can run
+
+```bash
+./scripts/quick_setup.sh --neuron validator --release v3.0.1
+```
+
+It will download and unzip the neuron's assets of the SubVortex for the requested version.
+
+Use `-h` to see the options
+
+<br />
+
+# 🚀 Quick Start <a id="quick-start"></a>
+
+To install the Auto Upgrader in a quick way, you can run
+
+```bash
+./scripts/quick_start.sh --execution <EXECUTION_METHOD>
+```
+
+It will install and start the Auto Upgrader using the `EXECUTION_METHOD`, which defaults to `service`.
+
+Use `-h` to see the options
+
+<br />
+
 # 🔧 How It Works <a id="how-it-works"></a>
 
 When setting up the Auto Upgrader, you can choose from three execution modes: `process`, `service`, or `container`. The default mode is `service`
@@ -155,61 +198,77 @@ Note: In Docker mode, the Auto Upgrader only runs if the neuron isn’t installe
 
 <br />
 
-# 📁 Log Locations <a id="log-locations"></a>
+# 📈 Monitoring & Logs <a id="monitoring-and-logs"></a>
 
-You can monitor the Auto Upgrader using logs. Their location depends on the `SUBVORTEX_EXECUTION_METHOD`:
+You can monitor the Auto Upgrader's behavior through logs, which vary depending on the `SUBVORTEX_EXECUTION_METHOD` you chose during setup:
 
-- **`service`**: logs are in `/var/log/subvortex-auto-upgrader/` and accessible via `tail -f <SERVICE_PATH>` e.v `tail -f /var/log/subvortex-auto-upgrader/subvortex-miner-neuron.log`
-- **`process`**: logs are in `/root/.pm2/logs/` and accessible via `pm2 log <PROCESS_NAME>` e.g `pm2 log subvortex-miner-neuron`
-- **`container`**: use `docker logs subvortex-auto-upgrader` (add `-f` to follow in real time) and accessible via `docker logs <CONTAINER_NAME>` e.g `docker logs subortex-miner-neuron`
+- **🔧 `service` mode**  
+  Logs are stored in:
 
-<br />
+  ```
+  /var/log/subvortex-auto-upgrader/
+  ```
 
-# 🔑 Personal Access Token <a id="personal-access-token"></a>
+  View logs in real time with:
 
-To allow the system to pull Docker images and release assets from GitHub, you need to generate a GitHub Personal Access Token (PAT).
+  ```bash
+  tail -f /var/log/subvortex-auto-upgrader/subvortex-auto-upgrader.log
+  ```
 
-1. Go to [GitHub Settings → Developer Settings → Personal Access Tokens](https://github.com/settings/tokens).
-2. Choose **Fine-grained tokens** (recommended) or **Classic** (still supported).
-3. Create a new token with at least the following permissions:
+- **🧩 `process` mode (PM2)**  
+  Logs are managed by PM2 and located at:
 
-   - **read:packages**
-   - **read:org** (required if the repository is under an organization)
-   - **public_repo** (sometimes required for public repositories)
+  ```
+  /root/.pm2/logs/
+  ```
 
-4. Set the token to **read-only access** where possible.
-5. Copy and save the token securely.
+  To follow logs:
 
-Then, copy that token as value of `SUBVORTEX_GITHUB_TOKEN` in the main Auto Upgrader `.env` file.
+  ```bash
+  pm2 log subvortex-auto-upgrader
+  ```
 
-<br />
+- **🐳 `container` mode (Docker)**  
+  Logs are available via Docker:
+  ```bash
+  docker logs subvortex-auto-upgrader -f
+  ```
+  Or for specific components (e.g., miner neuron):
+  ```bash
+  docker logs subvortex-auto-upgrader -f
+  ```
 
-# 🚀 Quick Setup <a id="quick-setup"></a>
+### 🔍 Tips
 
-⚠️ Note: This step is usually not required. The Auto Upgrader automatically handles setup for you.
-Use this only if you encounter issues or need to manually prepare a specific version.
+- Add `| grep ERROR` or `| grep WARN` to quickly identify issues.
+- For persistent monitoring, consider integrating with systemd journal, a log aggregator, or Prometheus log exporters.
+- Always ensure your logs are rotated or cleared periodically to avoid storage bloat.
 
-To setup the Auto Upgrader in a quick way, you can run
+<br />
+
+# 🔄 Quick Upgrade <a id="quick-upgrade"></a>
+
+To upgrade the Auto Upgrader when a new release has been deployed, you can run
 
 ```bash
-./scripts/quick_setup.sh --neuron validator --release v3.0.1
+./scripts/auto_upgrader/auto_upgrader_upgrade.sh --execution <EXECUTION_METHOD>
 ```
 
-It will download and unzip the neuron's assets of the SubVortex for the requested version.
+It will upgrade and restart the Auto Upgrader using the `EXECUTION_METHOD`, which defaults to `service`.
 
 Use `-h` to see the options
 
 <br />
 
-# 🚀 Quick Start <a id="quick-start"></a>
+# 🔄 Quick Restart <a id="quick-restart"></a>
 
-To install the Auto Upgrader in a quick way, you can run
+To stop/start the Auto Upgrader workspace and/or dumps in a quick way. Optionally to remove the current version.
 
 ```bash
-./scripts/quick_start.sh --execution <EXECUTION_METHOD>
+./scripts/quick_restart.sh --execution <EXECUTION_METHOD>
 ```
 
-It will install and start the Auto Upgrader using the `EXECUTION_METHOD`, which defaults to `service`.
+It will restart the Auto Upgrader using the `EXECUTION_METHOD`, which defaults to `service`.
 
 Use `-h` to see the options
 
@@ -229,43 +288,34 @@ Use `-h` to see the options
 
 <br />
 
-# 🔄 Quick Upgrade <a id="quick-upgrade"></a>
+# 🧹 Quick Clean <a id="quick-clean"></a>
 
-To upgrade the Auto Upgrader when a new release has been deployed, you can run
+To clean the Auto Upgrader workspace and/or dumps. Optionally to remove the current version.
 
 ```bash
-./scripts/auto_upgrader/auto_upgrader_upgrade.sh --execution <EXECUTION_METHOD>
+./scripts/quick_clean.sh
 ```
 
-It will upgrade and restart the Auto Upgrader using the `EXECUTION_METHOD`, which defaults to `service`.
-
 Use `-h` to see the options
 
 <br />
 
-# 🔄 Quick Restart <a id="quick-restart"></a>
-
-To stop/start the Auto Upgrader workspace and/or dumps in a quick way. Optionally to remove the current version.
-
-```bash
-./scripts/quick_restart.sh --execution <EXECUTION_METHOD>
-```
-
-It will restart the Auto Upgrader using the `EXECUTION_METHOD`, which defaults to `service`.
-
-Use `-h` to see the options
+# 🔑 Personal Access Token <a id="personal-access-token"></a>
 
-<br />
+To allow the system to pull Docker images and release assets from GitHub, you need to generate a GitHub Personal Access Token (PAT).
 
-# 🧹 Quick Clean <a id="quick-clean"></a>
+1. Go to [GitHub Settings → Developer Settings → Personal Access Tokens](https://github.com/settings/tokens).
+2. Choose **Fine-grained tokens** (recommended) or **Classic** (still supported).
+3. Create a new token with at least the following permissions:
 
-To clean the Auto Upgrader workspace and/or dumps. Optionally to remove the current version.
+   - **read:packages**
+   - **read:org** (required if the repository is under an organization)
+   - **public_repo** (sometimes required for public repositories)
 
-```bash
-./scripts/quick_clean.sh
-```
+4. Set the token to **read-only access** where possible.
+5. Copy and save the token securely.
 
-Use `-h` to see the options
+Then, copy that token as value of `SUBVORTEX_GITHUB_TOKEN` in the main Auto Upgrader `.env` file.
 
 <br />
 
@@ -302,7 +352,7 @@ For each of them, the same structure applies:
 
 <br />
 
-# Tools <a id="tools"></a>
+# 🛠️ Tools <a id="tools"></a>
 
 ## Wandb <a id="tool-wandb"></a>
 
@@ -399,6 +449,34 @@ subvortex/
 
 <br />
 
+# 🤝 Support Scope <a id="support-scope"></a>
+
+SubVortex only provides support for components related to SubVortex mining and validating activities.
+
+This includes:
+
+- Auto Upgrader installation and usage
+- SubVortex Miner and Validator management
+- Logging, upgrades, and troubleshooting SubVortex-specific services
+
+⚠️ Node Support Disclaimer
+We do not offer support for general Subtensor node operations. SubVortex is designed to scale nodes, not maintain them. As such, we cannot guarantee reliability or provide assistance with node-specific issues like syncing, peering, or Subtensor registration.
+
+If you need help with Subtensor nodes, try one of the following resources:
+
+- Bittensor [`#general`](https://discord.com/channels/799672011265015819/799672011814862902) channel on Discord
+- Bittensor [`#faq`](https://discord.com/channels/799672011265015819/1215386737661055056) channel on Discord
+- Church of Rao [`#subtensor`](https://discord.com/channels/1120750674595024897/1245487232928714863) channel on Discord
+
+If new user, join us first
+
+- Bittensor - [Join us](https://discord.gg/eRPTJqPa)
+- Church of Rao - [Join us](https://discord.gg/TVCKjNmR)
+
+Thank you for understanding!
+
+<br />
+
 # 🪪 License
 
 This repository is licensed under the MIT License.

VERSION

@@ -1 +1 @@
-1.1.0
+1.1.1