Repository navigation
Setting up ru RU
# клонируйте репозиторий bancho.py на вашу машину
git clone https://github.com/osuAkatsuki/bancho.py
# перейдите в новую директорию bancho.py
cd bancho.py
# установите docker для сборки/запуска образа приложения
sudo apt install -y docker.io docker-compose-v2
# опционально: установите uv для локального линтинга, проверки типов и юнит-тестов
curl -LsSf https://astral.sh/uv/install.sh | shвся настройка самого osu!-сервера (bancho.py) выполняется через файлы
.env и logging.yaml. мы предоставляем примеры обоих файлов — используйте
их как основу и изменяйте под свои нужды.
# создайте файл конфигурации из прилагаемого примера
cp .env.example .env
# создайте файл конфигурации логирования из прилагаемого примера
cp logging.yaml.example logging.yaml
# настройте приложение под свои нужды
# это обязательно для перехода к следующим шагам
nano .env
# при желании можно дополнительно настроить логирование,
# но большинству пользователей подойдут значения по умолчанию.
nano logging.yamlbancho.py полагается на обратный прокси для поддержки tls (https) и для удобства настройки. nginx — открытый и эффективный веб-сервер, который мы будем использовать в этом руководстве, но вы можете посмотреть и другие, например caddy или h2o.
# установите nginx
sudo apt install nginx
# установите конфигурацию nginx, используя значения из вашего .env
./scripts/install-nginx-config.shесли всё прошло успешно, вы сможете запустить сервер:
# соберите приложение
make build
# запустите приложение
make runтакже вам доступны следующие команды:
# запустить приложение в фоне
make run-bg
# посмотреть логи всех запущенных контейнеров
make logs
# запустить все автоматизированные тесты
make test
# запустить только юнит-тесты, без docker
make utest
# запустить форматтеры и линтеры
make lint
# запустить статическую проверку типов
make type-check
# удалить локальное виртуальное окружение uv
make uninstall
 |
 |
 |
 |
 |
|---|