Install CSCM
Choose your device below. The installer sets up storage and the web dashboard; public access is set up in the dashboard afterwards. It downloads CSCM from GitHub and starts it with Docker Compose.
macOS
- Install and start Docker Desktop for Mac. Install Git if it is not already available.
- If CSCM should run a Playit agent for public servers, enable Settings → Resources → Network → Enable host networking in Docker Desktop 4.34 or newer.
- Open Terminal and run:
curl -fsSL https://lephor.com/cscm/install.sh | shOpen source: read install.sh on GitHub ↗. The file on lephor.com is the same script.
Linux
- Install Docker Engine, the Compose plugin, Git and curl. Start Docker and ensure your user can run
docker info. - Open a terminal and run:
curl -fsSL https://lephor.com/cscm/install.sh | shOpen source: read install.sh on GitHub ↗. The file on lephor.com is the same script.
Windows
- Install WSL 2 with a Linux distribution and Docker Desktop for Windows.
- In Docker Desktop, enable WSL integration for your distribution. If you want the managed Playit agent, also enable Settings → Resources → Network → Enable host networking (Docker Desktop 4.34 or newer).
- In the WSL terminal, install Git and curl, confirm
docker infoworks, and run:
curl -fsSL https://lephor.com/cscm/install.sh | shOpen source: read install.sh on GitHub ↗. The file on lephor.com is the same script.
Use a path inside your WSL home directory when prompted for installation and server data. Open the dashboard at http://localhost:3000 in your Windows browser.
Confirm the defaults
The installer asks one question: install with the defaults? Press Enter to install into ~/cscm, keep worlds and backups in ~/cscm-data and run the dashboard on port 3000. Answer n to choose other folders or another port.
Create your account
Open the dashboard URL printed by the installer, usually http://localhost:3000. Create the administrator account, scan the authenticator QR code and enter one current six-digit code. Keep your authenticator and recovery access safe.
Finish the setup in the dashboard
Right after your account is created, the dashboard asks who should be able to join your servers:
- Only my local network: nothing else to set up.
- Anyone, over the internet: enter your Playit.gg account, then either let CSCM run a Playit agent (create or claim one in the Playit Docker setup and paste its
SECRET_KEY) or use an agent you already run. A custom domain through Cloudflare is optional.
Each step is saved as you go, so you can leave and continue later. The values are stored in the installation's .env. Change them any time with the settings button in the dashboard's top bar, or edit .env yourself and run docker compose restart api.
Want to check the installer before running it? Download it with curl -fsSL https://lephor.com/cscm/install.sh -o install.sh, read it, then run sh install.sh. To remove CSCM again later, follow the uninstall guide.
.env and data directories; see the migration section in the README.