A server that handles incoming and outgoing spectator data, for active players looking to watch or broadcast to others.
To deploy this as part of a full osu! server stack deployment, this wiki page will serve as a good reference.
For advanced testing purposes.
| Envvar name | Description | Default value |
|---|---|---|
SAVE_REPLAYS |
Whether to save received replay frames from clients to replay files. 1 to enable, any other value to disable. |
"" (disabled) |
REPLAY_UPLOAD_THREADS |
Number of threads to use when uploading complete replays. Must be positive number. | 1 |
REPLAYS_PATH |
Local path to store complete replay files (.osr) to. Only used if FileScoreStorage is active. |
./replays/ |
S3_KEY |
An access key ID to use for uploading replays to AWS S3. Only used if S3ScoreStorage is active. |
"" |
S3_SECRET |
The secret access key to use for uploading replays to AWS S3. Only used if S3ScoreStorage is active. |
"" |
REPLAYS_BUCKET |
The name of the AWS S3 bucket to upload replays to. Only used if S3ScoreStorage is active. |
"" |
TRACK_BUILD_USER_COUNTS |
Whether to track how many users are on a particular build of the game and report that information to the database at DB_{HOST,PORT}. 1 to enable, any other value to disable. |
"" (disabled) |
CLIENT_CHECK_VERSION |
Whether to check whether users connecting to the server are on a build of the game that supports online play. | "" (disabled) |
CLIENT_CHECK_VERSION_EXEMPT_GROUPS |
Comma-delimited list of user group IDs. Users in this group will not have their client versions checked even if CLIENT_CHECK_VERSION is enabled. |
"" (empty set) |
SERVER_PORT |
Which port the server should listen on for incoming connections. | 80 |
REDIS_HOST |
Connection string to osu-web Redis instance. |
localhost |
DD_AGENT_HOST |
Hostname under which the Datadog agent host can be found. | localhost |
DB_HOST |
Hostname under which the osu-web MySQL instance can be found. |
localhost |
DB_PORT |
Port under which the osu-web MySQL instance can be found. |
3306 |
DB_USER |
Username to use when logging into the osu-web MySQL instance. |
osuweb |
SENTRY_DSN |
A valid Sentry DSN to use for logging application events. | null (required in production) |
SHARED_INTEROP_DOMAIN |
The root URL of the osu-web instance to which shared interop calls should be submitted | http://localhost:80 |
SHARED_INTEROP_SECRET |
The value of the same environment variable that the target osu-web instance specifies in .env. |
null (required) |
BANCHO_BOT_USER_ID |
The value of the same environment variable that the target osu-web instance specified in .env. |
3 |
MATCHMAKING_ROOM_ROUNDS |
The number of rounds in a matchmaking room. | 5 |
MATCHMAKING_HEAD_TO_HEAD_IS_BESTOF |
Whether to treat head-to-head matches (1v1) as best-of matches that end early when score is no longer attainable. | true |
MATCHMAKING_ALLOW_SKIP |
Whether users are allowed to skip matchmaking stages. | false |
MATCHMAKING_LOBBY_UPDATE_RATE |
The rate (in seconds) at which to update the matchmaking lobby | 5 |
MATCHMAKING_QUEUE_UPDATE_RATE |
The rate (in seconds) at which to update the matchmaking queues | 1 |
MATCHMAKING_RECENT_MATCHUP_TIMEOUT |
The timeout (in seconds) between pairings between two users. | 600 |
MATCHMAKING_POOL_SIZE |
The number of beatmaps per matchmaking room. | 50 |
MATCHMAKING_QUEUE_ALLOW_BANS |
Whether to issue bans from the matchmaking queue for abuse or recent matchups. | true |
MATCHMAKING_DEBUG_BEATMAPS |
Replaces matchmaking pool beatmaps with a debug set. | false |
MATCHMAKING_USE_DYNAMIC_BEATMAP_RATINGS |
Enables/disables the use of dynamic beatmap ratings for matchmaking pools. When disabled, ratings are still written to the database but not used for matches. | true |