Skip to content

Commit 44e9c32

Browse files
docs: document the dependency bootstrap
The page claimed the installer checks that docker, git and curl are present, which undersold it now that it offers to install them, and the requirements page listed Docker as optional without saying the Docker deployment needs nothing else on the host.
1 parent 8ea4e0e commit 44e9c32

2 files changed

Lines changed: 20 additions & 3 deletions

File tree

website/docs/docker/setup.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,29 @@ curl -fsSL skyblock-installer.swofty.net | bash
1010

1111
This fetches the prebuilt `skyblock-installer` binary for your platform from the [latest release](https://github.com/Swofty-Developments/HypixelSkyBlock/releases/latest), caches it under `~/.cache/skyblock-installer`, and runs it. The installer will:
1212

13-
1. Verify its dependencies are present (`docker`, `git`, `curl`)
13+
1. Check its dependencies (`docker`, `docker compose` v2, a reachable daemon, `git`, `curl`) and offer to install anything missing
1414
2. Run a system requirements check
1515
3. Let you pick which server types and services to run
1616
4. Generate all configuration and Docker Compose files
1717
5. Build and start everything in the correct order
1818
6. Drop you into a management dashboard
1919

20-
:::alert note
21-
Requires **Docker** with **Compose v2** and a running Docker daemon your user can access. The installer itself is a self-contained Go binary — there are no other runtime dependencies to install.
20+
The installer itself is a self-contained Go binary with no runtime dependencies of its own.
21+
22+
### Dependencies
23+
24+
You do not need Docker installed beforehand. If anything is missing, the installer shows a **Missing dependencies** screen listing what is absent and the exact official commands for your distribution, and offers to run them for you:
25+
26+
- `i` runs the commands (they use `sudo`, so you will be prompted for your password)
27+
- `r` re-checks once you have finished
28+
- `Esc` goes back if you would rather run them yourself
29+
30+
You can reach the same screen any time from **Check dependencies** on the home menu.
31+
32+
The commands come straight from the [official Docker install docs](https://docs.docker.com/engine/install/) and are picked per distribution — the apt repository steps on Debian and Ubuntu, the `dnf` repository steps on Fedora and RHEL, `pacman` on Arch, `zypper` on openSUSE. On macOS, Docker Desktop cannot be installed unattended, so the installer prints the `brew install --cask docker` steps instead of running them.
33+
34+
:::alert warning
35+
Installing Docker adds your user to the `docker` group, and Linux only applies group membership at login. The installer will tell you to close your shell, open a new one, and run it again — this is expected and not a failure.
2236
:::
2337

2438
### What You'll See
@@ -27,6 +41,7 @@ The installer walks you through:
2741

2842
| Step | What It Does |
2943
|-------------------|---------------------------------------------------------------------------|
44+
| Dependencies | Checks for Docker, Compose v2, git and curl, and offers to install them |
3045
| System Check | Validates RAM, CPU, disk space, Docker version |
3146
| Configuration | Pick install directory, bind IP, online mode |
3247
| Server Selection | Choose from 14 SkyBlock servers and 10 minigame servers |

website/docs/requirements.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,8 @@ This project requires substantial resources to run properly. Make sure your syst
3636
| Docker | Containerized deployment | [Docker Desktop](https://www.docker.com/products/docker-desktop) |
3737
| MongoDB Compass | Database GUI | [MongoDB Compass](https://www.mongodb.com/products/compass) |
3838

39+
If you use the Docker deployment, Java, MongoDB and Redis all run in containers, so Docker with Compose v2 is the only thing you need on the host. The [installer](/docs/docker/setup) checks for it and offers to install it for you if it is missing.
40+
3941
## Network Requirements
4042

4143
The following ports are used by default:

0 commit comments

Comments
 (0)