cschantz/Linux-Server-Management-Toolkit
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: Update to use wget instead of git for downloads

Browse Source 
- Replace git clone with wget tarball downloads
- Add three wget-based quick start options
- Show different URLs for main (production) vs dev (development)
- Update development workflow to use wget
- Update merge-to-production workflow for wget-based approach
- Emphasize correct wget URLs for each branch
This commit is contained in:
Developer
2026-03-19 19:46:50 -04:00
parent ef16e309cb
commit 24dd0974cb
1 changed files with 92 additions and 47 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+92 -47
View File
@@ -11,43 +11,79 @@
## 🚀 Quick Start: How to Get the Dev Branch
### Option 1: Clone the Dev Branch from Remote
### Option 1: Download Dev Branch via wget
```bash
# Clone the entire repository and check out dev branch
git clone https://git.mull.lol/cschantz/Linux-Server-Management-Toolkit.git /root/server-toolkit-beta
cd /root/server-toolkit-beta
git checkout dev
# Download dev branch tarball
cd /tmp
wget https://git.mull.lol/cschantz/Linux-Server-Management-Toolkit/archive/dev.tar.gz
# Verify you're on dev branch
git branch -vv
# Output should show: * dev adcb3b0 [origin/dev] dev: Add BETA branding...
# Extract to /root/server-toolkit-beta/
mkdir -p /root/server-toolkit-beta
tar -xzf dev.tar.gz -C /root/server-toolkit-beta --strip-components=1
rm dev.tar.gz
# Run the dev launcher
cd /root/server-toolkit-beta
./launcher.sh
# You'll see the YELLOW ⚠️ banner with "2.1.0-BETA"
```
### Option 2: Switch Existing Toolkit to Dev Branch
### Option 2: Download Main Branch (Production) and Switch to Dev
```bash
# If you already have the toolkit cloned
cd /root/server-toolkit
git fetch origin
git checkout dev
# Download production branch first
cd /tmp
wget https://git.mull.lol/cschantz/Linux-Server-Management-Toolkit/archive/main.tar.gz
mkdir -p /root/server-toolkit
tar -xzf main.tar.gz -C /root/server-toolkit --strip-components=1
rm main.tar.gz
# Verify
git branch -vv
# Then download and merge dev branch
cd /tmp
wget https://git.mull.lol/cschantz/Linux-Server-Management-Toolkit/archive/dev.tar.gz
mkdir -p /root/server-toolkit-beta
tar -xzf dev.tar.gz -C /root/server-toolkit-beta --strip-components=1
rm dev.tar.gz
cd /root/server-toolkit-beta
./launcher.sh # Run dev version
```
### Option 3: Use the Pre-Configured Dev Instance (This Directory)
### Option 3: Update Existing Dev Instance
```bash
# If you're already in /root/server-toolkit-beta/
git pull origin dev # Get latest dev changes
./launcher.sh # Run the dev version
# If you already have dev extracted, download latest
cd /tmp
wget https://git.mull.lol/cschantz/Linux-Server-Management-Toolkit/archive/dev.tar.gz
# Backup old version
mv /root/server-toolkit-beta /root/server-toolkit-beta.bak
# Extract new dev version
mkdir -p /root/server-toolkit-beta
tar -xzf dev.tar.gz -C /root/server-toolkit-beta --strip-components=1
rm dev.tar.gz
# Run updated version
cd /root/server-toolkit-beta
./launcher.sh
```
### ⚠️ Important: Different URLs for Each Branch
**Production (main branch)**:
```
https://git.mull.lol/cschantz/Linux-Server-Management-Toolkit/archive/main.tar.gz
```
**Development (dev branch)**:
```
https://git.mull.lol/cschantz/Linux-Server-Management-Toolkit/archive/dev.tar.gz
```
Make sure you use the **dev** URL to get the development branch with YELLOW banner!
---
## 📍 Quick Navigation
@@ -79,13 +115,21 @@ Both branches exist in the same remote repository but are completely isolated.
### Development Workflow
#### 1️⃣ Get the Latest Dev Code
#### 1️⃣ Get the Latest Dev Code (wget)
```bash
# Update your local dev branch with latest remote changes
cd /root/server-toolkit-beta
git fetch origin # Fetch all remote changes
git pull origin dev # Pull latest dev branch code
# Download latest dev branch tarball
cd /tmp
wget https://git.mull.lol/cschantz/Linux-Server-Management-Toolkit/archive/dev.tar.gz
# Backup old version (optional)
[ -d /root/server-toolkit-beta.old ] && rm -rf /root/server-toolkit-beta.old
[ -d /root/server-toolkit-beta ] && mv /root/server-toolkit-beta /root/server-toolkit-beta.old
# Extract new dev version
mkdir -p /root/server-toolkit-beta
tar -xzf dev.tar.gz -C /root/server-toolkit-beta --strip-components=1
rm dev.tar.gz
```
#### 2️⃣ Make Changes & Test
@@ -100,43 +144,44 @@ nano /root/server-toolkit-beta/modules/security/malware-scanner.sh
# You'll see YELLOW banner: "⚠️ 2.1.0-BETA"
```
#### 3️⃣ Commit Changes to Dev Branch
#### 3️⃣ Save Your Changes
```bash
# Option A: Backup your modified version (if not using git)
cp -r /root/server-toolkit-beta /root/server-toolkit-beta.modified
# Later you can reference what you changed in this backup
# Option B: If using git, commit and push changes
cd /root/server-toolkit-beta
# See what you changed
git status
git diff
# Stage and commit
git add modules/security/malware-scanner.sh
git commit -m "dev: Added feature XYZ to malware scanner"
# Push to remote dev branch
git push origin dev
```
#### 4️⃣ When Ready: Merge to Production
#### 4️⃣ When Ready: Deploy to Production (wget)
```bash
# First ensure dev is stable and tested
cd /root/server-toolkit-beta
git log --oneline -5 # View recent commits
# Download production (main branch)
cd /tmp
wget https://git.mull.lol/cschantz/Linux-Server-Management-Toolkit/archive/main.tar.gz
# Switch to production
cd /root/server-toolkit
git checkout main
# Backup current production
[ -d /root/server-toolkit.old ] && rm -rf /root/server-toolkit.old
[ -d /root/server-toolkit ] && mv /root/server-toolkit /root/server-toolkit.old
# Get latest dev changes
git fetch origin
# Extract fresh production version
mkdir -p /root/server-toolkit
tar -xzf main.tar.gz -C /root/server-toolkit --strip-components=1
rm main.tar.gz
# Merge dev into main
git merge origin/dev
# Review the merge carefully!
# Manually copy your tested changes from dev to production
# Example: copy the files you modified
cp /root/server-toolkit-beta/modules/security/malware-scanner.sh /root/server-toolkit/modules/security/
cp /root/server-toolkit-beta/launcher.sh /root/server-toolkit/launcher.sh
# Push to production
git push origin main
# Test the updated production version
/root/server-toolkit/launcher.sh
# Should show CYAN banner: "⚡ 2.1.0" (not BETA)
```
### Common Dev Commands