Setup
Get the server
Section titled “Get the server”To get started with Swamp, first download the latest release from the downloads page. Docker is the recommended way to run the server, but you can also download the binaries for your platform.
Run the server
Section titled “Run the server”Just run the server and it will start listening on port 8080 by default.
To change the port, use the PORT environment variable.
Please note that you need applications uses http/https ports, so you need to specify a the port (http: 80, https: 443) if you want to use these ports or use a reverse proxy like nginx or apache.
To run the server in https mode, you need to create a certs folder in the same directory (make sure to add a volume if you are using docker) and add your server.key (private key) and server.crt (certificate) files there.
Configuration
Section titled “Configuration”You can configure certain aspects of the server using environment variables:
| Variable | Description | Default |
|---|---|---|
SWAMP_DESCRIPTION | A description of the server, visible in the info endpoint. | "" |
SWAMP_MAX_PLAYERS | The maximum number of concurrent connections allowed. | 256 |
SWAMP_NO_DARK_ROOMS | Set to true to disable the creation of “dark rooms” (rooms with limited visibility). | false |