Skip to content

Commit 1db2135

Browse files
docs(website): promote one-line installer and revamp Docker docs
1 parent 445ec2d commit 1db2135

3 files changed

Lines changed: 108 additions & 58 deletions

File tree

website/.vitepress/config.ts

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,14 @@ export default defineConfig({
4444
],
4545
},
4646
{
47-
text: "Setup",
47+
text: "Docker (Recommended)",
48+
items: [
49+
{ text: "Quick Install", link: "/docs/docker/setup" },
50+
{ text: "Adding Servers", link: "/docs/docker/adding-servers" },
51+
],
52+
},
53+
{
54+
text: "Manual Setup",
4855
items: [
4956
{ text: "Proxy Setup", link: "/docs/setup/proxy" },
5057
{ text: "Game Servers", link: "/docs/setup/game-servers" },
@@ -53,13 +60,6 @@ export default defineConfig({
5360
{ text: "Forums Website", link: "/docs/setup/forums" },
5461
],
5562
},
56-
{
57-
text: "Docker",
58-
items: [
59-
{ text: "Docker Setup", link: "/docs/docker/setup" },
60-
{ text: "Adding Servers", link: "/docs/docker/adding-servers" },
61-
],
62-
},
6363
{
6464
text: "Reference",
6565
items: [

website/docs/docker/setup.md

Lines changed: 87 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,68 @@
11
# Docker Setup
22

3-
Docker provides an automated way to deploy the entire stack with minimal configuration.
3+
## Quick Install (Linux)
44

5-
## Prerequisites
5+
The fastest way to get running. A single command launches an interactive installer that handles everything:
66

7-
- [Docker Desktop](https://www.docker.com/products/docker-desktop) installed
8-
- Git installed
7+
```bash
8+
curl -fsSL skyblock-installer.swofty.net | bash
9+
```
10+
11+
The installer will:
12+
1. Check and install dependencies (Docker, `gum`, `figlet`)
13+
2. Run a system requirements check
14+
3. Let you pick which server types and services to run
15+
4. Generate all configuration and Docker Compose files
16+
5. Build and start everything in the correct order
17+
6. Drop you into a management dashboard
18+
19+
:::alert note
20+
Requires **Linux** with **Docker** installed. The installer will guide you through Docker setup if it's missing.
21+
:::
22+
23+
### What You'll See
24+
25+
The installer walks you through:
26+
27+
| Step | What It Does |
28+
|------|-------------|
29+
| System Check | Validates RAM, CPU, disk space, Docker version |
30+
| Configuration | Pick install directory, bind IP, online mode |
31+
| Server Selection | Choose from 14 SkyBlock servers and 10 minigame servers |
32+
| Service Selection | Pick which microservices to run (DataMutex and Party are required) |
33+
| Build & Launch | Builds Docker images, starts containers in order, waits for health checks |
34+
35+
### Management Dashboard
36+
37+
After installation, manage your server anytime:
38+
39+
```bash
40+
~/.hypixel-skyblock/install.sh --manage
41+
```
42+
43+
The dashboard provides:
44+
45+
- **Start/Stop All** - Control all containers at once
46+
- **Restart Container** - Restart individual containers
47+
- **View Logs** - Tail logs from any container
48+
- **Make Admin** - Promote a player to staff rank via the database
49+
- **Check for Updates** - Pull latest JARs and rebuild
50+
- **Watch Mode** - Live health monitoring with auto-refresh
51+
52+
You can also run the health monitor directly:
53+
54+
```bash
55+
~/.hypixel-skyblock/install.sh --watch
56+
```
57+
58+
## Manual Setup
959

10-
## Quick Start
60+
If you prefer to set things up manually or aren't on Linux, you can use Docker Compose directly.
61+
62+
### Prerequisites
63+
64+
- [Docker](https://docs.docker.com/engine/install/) with Docker Compose v2
65+
- Git
1166

1267
### 1. Clone the Repository
1368

@@ -16,83 +71,69 @@ git clone https://github.com/Swofty-Developments/HypixelSkyBlock.git
1671
cd HypixelSkyBlock
1772
```
1873

19-
### 2. Add World Files
20-
21-
Download the [world files](https://files.catbox.moe/of7snu.zip) and extract them directly into the `configuration/` folder. The zip already contains the correct folder structure.
22-
23-
### 3. Configure config.yml
74+
### 2. Configure
2475

2576
In your `configuration` folder:
2677

2778
1. Remove the default `config.yml`
2879
2. Rename `config.docker.yml` to `config.yml`
2980

30-
### 4. Build and Run
81+
### 3. Build and Run
3182

3283
```bash
33-
docker-compose up --build
84+
docker compose up --build
3485
```
3586

36-
For detached mode (background):
37-
38-
```bash
39-
docker-compose up --build -d
40-
```
87+
For detached mode:
4188

42-
:::alert note
43-
After the first build, you can skip `--build` for faster startup:
4489
```bash
45-
docker-compose up
90+
docker compose up --build -d
4691
```
47-
:::
4892

49-
### 5. Stop Containers
93+
### 4. Stop Containers
5094

5195
```bash
52-
docker-compose down
96+
docker compose down
5397
```
5498

55-
Or use the stop button in Docker Desktop.
56-
5799
## What Gets Started
58100

59101
The Docker Compose setup starts:
60102

61-
| Container | Purpose |
62-
|----------------|---------------------|
63-
| MongoDB | Database |
64-
| Redis | Caching & messaging |
65-
| Velocity Proxy | Player connections |
66-
| NanoLimbo | Connection queue |
67-
| Game Servers | Gameplay instances |
68-
| Services | Microservices |
103+
| Container | Purpose |
104+
|-----------|---------|
105+
| MongoDB | Database |
106+
| Redis | Caching & messaging |
107+
| Velocity Proxy | Player connections |
108+
| NanoLimbo | Connection queue |
109+
| Game Servers | Gameplay instances |
110+
| Services | Microservices (API, Auctions, Bazaar, etc.) |
111+
112+
## Connecting
113+
114+
Once everything is running, connect with your Minecraft client to:
115+
116+
```
117+
localhost:25565
118+
```
69119

70120
## Logs and Debugging
71121

72122
View logs for all containers:
73123
```bash
74-
docker-compose logs -f
124+
docker compose logs -f
75125
```
76126

77127
View logs for a specific container:
78128
```bash
79-
docker-compose logs -f proxy
80-
docker-compose logs -f hypixelcore_island
129+
docker compose logs -f hypixel_proxy
130+
docker compose logs -f hypixelcore_skyblock_hub
81131
```
82132

83133
## Data Persistence
84134

85135
Docker volumes persist data between restarts:
86136

87-
- MongoDB data
137+
- MongoDB data (player profiles, auctions, etc.)
88138
- Configuration files
89139
- World saves
90-
91-
## Rebuilding
92-
93-
If you make changes to the codebase:
94-
95-
```bash
96-
docker-compose down
97-
docker-compose up --build
98-
```

website/index.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@ hero:
66
tagline: A 1.21.11 recreation of Hypixel SkyBlock with a properly abstracted, scalable codebase
77
actions:
88
- theme: brand
9+
text: Quick Install (Linux)
10+
link: /docs/docker/setup
11+
- theme: alt
912
text: Get Started
1013
link: /docs/introduction
1114
- theme: alt
@@ -16,16 +19,22 @@ hero:
1619
link: https://discord.gg/ZaGW5wzUJ3
1720

1821
features:
22+
- icon:
23+
title: One-Line Install
24+
details: Get a full server running with a single command. The TUI installer handles Docker, configuration, and startup automatically.
1925
- icon: 🚀
2026
title: High Performance
2127
details: Built on Minestom for maximum performance with multi-threaded architecture and virtual threads support.
2228
- icon: 🏗️
2329
title: Microservices Architecture
24-
details: Modular design with 8 independent services handling auctions, bazaar, parties, and more.
30+
details: Modular design with 9 independent services handling auctions, bazaar, parties, and more.
2531
- icon: 🌐
2632
title: Scalable
27-
details: Run multiple game servers across 13 different server types with Redis-based communication.
33+
details: Run multiple game servers across 24 different server types with Redis-based communication.
2834
- icon: 🐳
29-
title: Docker Ready
30-
details: Full Docker Compose support for easy deployment and scaling.
35+
title: Fully Dockerized
36+
details: Everything runs in Docker containers. No need to install Java, MongoDB, or Redis on your host.
37+
- icon: 🛠️
38+
title: Management Dashboard
39+
details: Built-in CLI dashboard for starting, stopping, restarting containers, viewing logs, and promoting admins.
3140
---

0 commit comments

Comments
 (0)