sebys-hosting-scripts/README.md

137 lines
2.2 KiB
Markdown
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Sebys Hosting Scripts
Interactive installation scripts for **Calagopus Wings** nodes.
This script installs:
- Docker (optional, prompted)
- Certbot SSL (optional, prompted)
- Calagopus Wings (auto-detects x86_64 or ARM64)
- Systemd service (via `wings service-install`)
- Optional SSL configuration auto-wiring in `config.yml`
---
## 🚀 Quick Install (Copy & Paste)
```bash
curl -fsSL https://git.okseby.com/okseby/sebys-hosting-scripts/raw/branch/main/install-wings.sh | bash
```
> ⚠️ Make sure ports 80 and 443 are open if you plan to enable SSL.
---
## 📦 What the Script Does
### 1⃣ Docker
- Checks if Docker is installed
- Prompts to install if missing
- Default answer: **No**
### 2⃣ SSL (Optional)
If you choose to enable SSL:
- Installs `certbot`
- Runs:
```bash
certbot certonly --standalone -d yourdomain.com
```
- Automatically modifies:
`/etc/calagopus/config.yml`
From:
```yaml
ssl:
enabled: false
cert: ''
key: ''
```
To:
```yaml
ssl:
enabled: true
cert: /etc/letsencrypt/live/yourdomain.com/fullchain.pem
key: /etc/letsencrypt/live/yourdomain.com/privkey.pem
```
A backup of the config is created as:
```
/etc/calagopus/config.yml.bak
```
---
### 3⃣ Wings Binary
- Detects architecture:
- `x86_64`
- `aarch64`
- Downloads the correct release from:
https://github.com/calagopus/wings
Installed to:
```
/usr/local/bin/wings
```
---
### 4⃣ Configuration
Optionally runs:
```bash
wings configure --join-data <token>
```
Then optionally installs as a systemd service:
```bash
wings service-install
```
`service-install` automatically:
- Creates systemd unit
- Reloads daemon
- Enables service
- Starts service
---
## 🧱 Requirements
- Debian / Ubuntu based system
- `apt`
- Root or sudo access
- Ports 80/443 open (for SSL standalone mode)
---
## 🔐 Security Note
Always inspect remote scripts before running them:
```bash
curl -fsSL https://git.okseby.com/okseby/sebys-hosting-scripts/raw/branch/main/install-wings.sh
```
---
## 🛠 Manual Install Option
If you prefer not to pipe to bash:
```bash
curl -O https://git.okseby.com/okseby/sebys-hosting-scripts/raw/branch/main/install-wings.sh
chmod +x install-wings.sh
./install-wings.sh
```