pppy/osu-web

osu!web镜像说明

镜像概述

本镜像为音乐游戏osu!的浏览器端组件，专注于非开发环境（如staging、production）的部署，提供完整的网页服务能力，可与MySQL、Redis、Elasticsearch等服务集成，实现osu!网页平台的搭建与运行。

核心功能

• 提供osu!游戏的网页界面访问入口
• 支持MySQL数据库交互，存储用户数据、游戏信息等
• 集成Redis用于缓存管理和消息队列处理
• 利用Elasticsearch实现高效搜索功能
• 处理HTTP请求（通过octane服务）、异步任务（队列）和定时任务（cron）

使用场景

• 搭建osu!游戏的私有服务器或测试环境
• 部署osu!相关的网页服务平台

配置说明

1. 创建网络与基础服务

创建专用网络

bash
docker network create osu-web

启动MySQL并配置用户

bash
docker run -d --name osu-web-mysql -e MYSQL_ALLOW_EMPTY_PASSWORD=yes --network osu-web mysql/mysql-server:8.0
while ! (docker exec osu-web-mysql mysql); do echo "等待MySQL启动..."; sleep 3; done && curl https://raw.githubusercontent.com/ppy/osu-web/master/docker/development/db_user.sql | docker exec -i osu-web-mysql mysql

启动Redis

bash
docker run -d --name osu-web-redis redis:latest

启动Elasticsearch

bash
docker run -d --name osu-web-elasticsearch -e action.auto_create_index=false -e discovery.type=single-node -e ES_JAVA_OPTS="-Xms512m -Xmx512m" --network osu-web docker.elastic.co/elasticsearch/elasticsearch:7.17.6

2. 生成OAuth密钥

bash
docker run --name passport_keys pppy/osu-web:latest artisan passport:keys
docker cp passport_keys:/app/storage/oauth-public.key .
docker cp passport_keys:/app/storage/oauth-private.key .
docker rm passport_keys

3. 配置环境变量

复制https://raw.githubusercontent.com/ppy/osu-web/master/.env.example%E5%88%B0%E6%9C%AC%E5%9C%B0%EF%BC%8C%E8%B0%83%E6%95%B4%E5%85%B3%E9%94%AE%E5%8F%98%E9%87%8F%EF%BC%9A

• 运行docker run --rm pppy/osu-web:latest artisan key:generate --show获取APP_KEY并设置
• 将PASSPORT_PUBLIC_KEY和PASSPORT_PRIVATE_KEY设置为上述生成的密钥内容
• 设置APP_URL为访问网址（如http://localhost:8000%EF%BC%89
• 设置APP_DEBUG为false
• 设置DB_HOST为osu-web-mysql
• 设置REDIS_HOST、CACHE_REDIS_HOST、NOTIFICATION_REDIS_HOST为osu-web-redis
• 设置ES_HOST为osu-web-elasticsearch

4. 填充数据库

bash
docker run --rm -it --network osu-web --env-file .env pppy/osu-web:latest artisan db:create
docker run --rm -it --network osu-web --env-file .env pppy/osu-web:latest artisan migrate
docker run --rm -it --network osu-web --env-file .env pppy/osu-web:latest artisan es:index-documents
docker run --rm -it --network osu-web --env-file .env pppy/osu-web:latest artisan es:create-search-blacklist
docker run --rm -it --network osu-web --env-file .env pppy/osu-web:latest artisan es:index-wiki --create-only

（可选）填充测试数据（需设置OSU_API_KEY）：

bash
docker run --rm -it --network osu-web --env-file .env pppy/osu-web:latest artisan db:seed --force

创建第一个用户：

bash
docker run --rm -it --network osu-web --env-file .env pppy/osu-web:latest artisan tinker
>>> (new App\Libraries\UserRegistration(["username" => "你的用户名", "user_email" => "你的邮箱", "password" => "你的密码"]))->save();

5. 启动服务

启动Octane（HTTP服务）

bash
docker run -d --name osu-web-octane --network osu-web --env-file .env -p 127.0.0.1:8000:8000 pppy/osu-web:latest octane

启动队列任务

bash
docker run -d --name osu-web-jobs --network osu-web --env-file .env pppy/osu-web:latest queue:work --queue=notification,default,beatmap_high,beatmap_default,store-notifications --tries=3

启动定时任务

bash
docker run -d --name osu-web-cronjobs --network osu-web --env-file .env pppy/osu-web:latest schedule:work

完成后，可通过[***]

Kubernetes部署

如需Kubernetes部署，参考官方Helm chart：https://github.com/ppy/helm-charts/tree/master/osu/osu-web

许可证

osu!web基于AGPL v3或更高版本许可，详情见https://github.com/ppy/osu-web/blob/master/LICENCE%E3%80%82