{"id":30043139,"url":"https://github.com/ppy/osu-server-beatmap-submission","last_synced_at":"2025-08-07T04:56:26.878Z","repository":{"id":263457327,"uuid":"887149159","full_name":"ppy/osu-server-beatmap-submission","owner":"ppy","description":null,"archived":false,"fork":false,"pushed_at":"2025-07-14T12:41:57.000Z","size":12322,"stargazers_count":16,"open_issues_count":3,"forks_count":4,"subscribers_count":10,"default_branch":"master","last_synced_at":"2025-08-06T06:52:14.773Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ppy.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-11-12T08:53:41.000Z","updated_at":"2025-07-14T11:31:19.000Z","dependencies_parsed_at":"2024-11-18T17:48:29.431Z","dependency_job_id":"e19b100a-d10c-4a85-b743-a3aecb2a5fb0","html_url":"https://github.com/ppy/osu-server-beatmap-submission","commit_stats":null,"previous_names":["ppy/osu-server-beatmap-submission"],"tags_count":9,"template":false,"template_full_name":null,"purl":"pkg:github/ppy/osu-server-beatmap-submission","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ppy%2Fosu-server-beatmap-submission","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ppy%2Fosu-server-beatmap-submission/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ppy%2Fosu-server-beatmap-submission/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ppy%2Fosu-server-beatmap-submission/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ppy","download_url":"https://codeload.github.com/ppy/osu-server-beatmap-submission/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ppy%2Fosu-server-beatmap-submission/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":269201301,"owners_count":24377459,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-07T02:00:09.698Z","response_time":73,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-08-07T04:56:24.534Z","updated_at":"2025-08-07T04:56:26.860Z","avatar_url":"https://github.com/ppy.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# osu-server-beatmap-submission\n\nHandles submitting new and updating existing beatmaps to the [osu! website.](https://osu.ppy.sh/)\n\n## Running\n\n### Development\n\nThis configuration permits full-stack integration testing with other local osu! services.\nTo run the project in this configuration, you must have a configured [`osu-web` instance](https://github.com/ppy/osu-web/blob/master/SETUP.md).\nAdditionally, to test beatmap downloads, you may want to set up a local beatmap mirror; see [`osu-beatmap-mirror-docker-runtime`](https://github.com/ThePooN/osu-beatmap-mirror-docker-runtime) for more information.\n\n1. [Set up a client key](https://github.com/ppy/osu-web/blob/master/SETUP.md#use-the-api-from-osu) that will be used to identify users. It should be the same client key that the osu!(lazer) client uses to communicate with `osu-web`.\n2. In [`launchSettings.json`](osu.Server.BeatmapSubmission/Properties/launchSettings.json), in the `fullstack` configuration, set the following environment variables:\n - Set `JWT_VALID_AUDIENCE` to the client ID assigned to the key created in step (1).\n - Set `LOCAL_BEATMAP_STORAGE_PATH` to a directory where submitted beatmaps should be placed.\n3. Copy the `osu-web` OAuth public key to the `osu.Server.BeatmapSubmission` project root:\n ```\n $ cp osu-web/storage/oauth-public.key osu-server-beatmap-submission/osu.Server.BeatmapSubmission/oauth-public.key\n ```\n4. Start the project in the `fullstack` configuration.\n5. The application will start at http://localhost:5089.\n - When interacting with endpoints which require authorisation, every request must include an `Authorization: Bearer \u003cTOKEN\u003e` header. That token must be a token issued by `osu-web` for the client key set up in step (1).\n\n## Environment variables\n\nFor advanced testing purposes.\n\nThis project supports three environment setups.\nThe choice of the environment is steered by the `ASPNETCORE_ENVIRONMENT` environment variable.\nDepending on environment, the configuration \u0026 config requirements change slightly.\n\n- `ASPNETCORE_ENVIRONMENT=Development`:\n - Developer exception pages \u0026 API docs (`/api-docs`) are enabled.\n - Sentry \u0026 Datadog integrations are optional.\n- `ASPNETCORE_ENVIRONMENT=Staging`:\n - Developer exception pages \u0026 API docs are disabled.\n - Sentry integration is mandatory.\n - Datadog integration is optional.\n- `ASPNETCORE_ENVIRONMENT=Production`:\n - Developer exception pages \u0026 API docs are disabled.\n - Sentry \u0026 Datadog integrations are mandatory.\n\n| Envvar name | Description | Mandatory? | Default value |\n|:------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------------------------:|:--------------|\n| `DB_HOST` | Hostname under which the `osu-web` MySQL instance can be found. | ❌ No | `localhost` |\n| `DB_PORT` | Port under which the `osu-web` MySQL instance can be found. | ❌ No | `3306` |\n| `DB_USER` | Username to use when logging into the `osu-web` MySQL instance. | ❌ No | `root` |\n| `DB_PASS` | Password to use when logging into the `osu-web` MySQL instance. | ❌ No | `\"\"` |\n| `DB_NAME` | Name of database to use on the indicated MySQL instance. | ❌ No | `osu` |\n| `JWT_VALID_AUDIENCE` | The value of the `aud` claim to use when validating incoming JWTs. Should be set to the client ID assigned to osu! in the `osu-web` target deploy. | ✔️ Yes | None |\n| `BEATMAP_STORAGE_TYPE` | Which type of beatmap storage to use. Valid values are `local` and `s3`. | ✔️ Yes | None |\n| `LOCAL_BEATMAP_STORAGE_PATH` | The path of a directory where the submitted beatmaps should reside. | ⚠️ If `BEATMAP_STORAGE_TYPE=local` | None |\n| `S3_ACCESS_KEY` | A valid Amazon S3 access key ID. | ⚠ If `BEATMAP_STORAGE_TYPE=s3` | None |\n| `S3_SECRET_KEY` | The secret key corresponding to the `S3_ACCESS_KEY`. | ⚠ If `BEATMAP_STORAGE_TYPE=s3` | None |\n| `S3_CENTRAL_BUCKET_NAME` | The name of the S3 bucket to use for storing beatmap packages and versioned files. | ⚠ If `BEATMAP_STORAGE_TYPE=s3` | None |\n| `S3_CENTRAL_BUCKET_REGION` | The name of the region for the `S3_CENTRAL_BUCKET_NAME` bucket. | ⚠ If `BEATMAP_STORAGE_TYPE=s3` | None |\n| `S3_BEATMAPS_BUCKET_NAME` | The name of the S3 bucket to use for storing .osu beatmap files. | ⚠ If `BEATMAP_STORAGE_TYPE=s3` | None |\n| `S3_BEATMAPS_BUCKET_REGION` | The name of the region for the `S3_BEATMAPS_BUCKET_NAME` bucket. | ⚠ If `BEATMAP_STORAGE_TYPE=s3` | None |\n| `SHARED_INTEROP_DOMAIN` | The root domain to which shared interop IO requests should be directed to. | ✔️ Yes | None |\n| `SHARED_INTEROP_SECRET` | The interop secret used for shared interop IO requests. Value should match same environment variable in target `osu-web` instance. | ✔️ Yes | None |\n| `PURGE_BEATMAP_MIRROR_CACHES` | Whether to request that beatmap mirror caches should be purged when a beatmap is updated. Set to `0` to disable. Turning this off is useful in configurations where the beatmap mirror cache is the same directory as `LOCAL_BEATMAP_STORAGE_PATH`. | ❌ No | `1` |\n| `SENTRY_DSN` | A valid Sentry DSN to use for logging application events. | ⚠ In staging \u0026 production environment | None | \n| `DD_AGENT_HOST` | A hostname pointing to a Datadog agent instance to which metrics should be reported. | ⚠ In production environment | None | \n| `USER_ALLOW_LIST` | A comma-delimited list of IDs of users who are allowed access to the service. If completely omitted, all users are allowed access. | ❌ No | None |","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fppy%2Fosu-server-beatmap-submission","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fppy%2Fosu-server-beatmap-submission","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fppy%2Fosu-server-beatmap-submission/lists"}