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
1671cd 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
2576In your ` configuration ` folder:
2677
27781 . Remove the default ` config.yml `
28792 . 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
59101The 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
72122View logs for all containers:
73123``` bash
74- docker- compose logs -f
124+ docker compose logs -f
75125```
76126
77127View 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
85135Docker 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- ```
0 commit comments