### Configure bancho.py Environment and Logging

Source: https://github.com/osuakatsuki/bancho.py/wiki/Setting-up

Copy example configuration files and edit them to customize your osu! server settings. The .env file is required, while logging.yaml is optional.

```sh
# create a configuration file from the sample provided
cp .env.example .env

# create a logging configuration file from the sample provided
cp logging.yaml.example logging.yaml

# configure the application to your needs
# this is required to move onto the next steps
nano .env

# you can additionally configure the logging if you'd like,
# but the default should work fine for most users.
nano logging.yaml
```

--------------------------------

### Clone and Install bancho.py

Source: https://github.com/osuakatsuki/bancho.py/wiki/Setting-up

Clone the bancho.py repository and install Docker, which is required for building the application image.

```sh
# clone bancho.py's repository onto your machine
git clone https://github.com/osuAkatsuki/bancho.py

# enter bancho.py's new directory
cd bancho.py

# install docker for building the application image
sudo apt install -y docker
```

--------------------------------

### Build and Run bancho.py Server

Source: https://github.com/osuakatsuki/bancho.py/wiki/Setting-up

Build the bancho.py application image and then run the server. This is the final step after successful setup and configuration.

```sh
# build the application
make build

# run the application
make run
```

--------------------------------

### Install Nginx Reverse Proxy

Source: https://github.com/osuakatsuki/bancho.py/wiki/Setting-up

Install Nginx, a web server used for TLS (HTTPS) support, and then install the Nginx configuration tailored to your bancho.py setup.

```sh
# install nginx
sudo apt install nginx

# install nginx configuration using values from your .env
./scripts/install-nginx-config.sh
```

--------------------------------

### Manage bancho.py Server and Development Tools

Source: https://github.com/osuakatsuki/bancho.py/wiki/Setting-up

A collection of make commands for managing the bancho.py server and development workflow, including running in the background, viewing logs, testing, linting, type checking, and cleaning up.

```sh
# run the application in the background
make run-bg

# view logs of all running containers
make logs

# run all automated tests
make test

# run formatters and linters
make lint

# run static type checking
make type-check

# remove all unused dependencies
make clean
```

--------------------------------

### Save Cloudflare Origin Certificate and Private Key

Source: https://github.com/osuakatsuki/bancho.py/wiki/Post-setup

After generating an origin certificate from Cloudflare, save the certificate content to a .pem file and the private key content to a .key file using the nano editor.

```sh
nano example.com.pem
# paste the content of the origin certificate

nano example.com.key
# paste the content of the private key
```

--------------------------------

### Generate Cloudflare DNS Records

Source: https://github.com/osuakatsuki/bancho.py/wiki/Post-setup

Use this script to generate DNS records for Cloudflare import. Navigate to the tools directory and execute the script, then return to the project root.

```sh
cd tools && ./generate_cf_dns_records.sh && cd..
```

--------------------------------

### Generate SSL Certificate with Certbot

Source: https://github.com/osuakatsuki/bancho.py/wiki/Post-setup

This command generates an SSL certificate for your domain using Certbot with manual DNS challenge. Ensure you replace placeholders for email and domain. This is for users managing their own SSL certificates.

```sh
# you'll need to change:
# - YOUR_EMAIL_ADDRESS
# - YOUR_DOMAIN

# generate an ssl certificate for your domain
sudo certbot certonly \
    --manual \
    --preferred-challenges=dns \
    --email YOUR_EMAIL_ADDRESS \
    --server https://acme-v02.api.letsencrypt.org/directory \
    --agree-tos \
    -d *.YOUR_DOMAIN
```

--------------------------------

### Renamed Mirror URL Environment Variables

Source: https://github.com/osuakatsuki/bancho.py/wiki/Breaking-changes

The MIRROR_URL environment variable has been split into MIRROR_SEARCH_ENDPOINT and MIRROR_DOWNLOAD_ENDPOINT. This change requires updating configurations to use the new, more specific variables.

```diff
-MIRROR_URL=https://api.chimu.moe/v1

+# Chimu: https://api.chimu.moe/cheesegull/search - https://api.chimu.moe/v1/download
+# Kitsu: https://kitsu.moe/api/search - https://kitsu.moe/d
+MIRROR_SEARCH_ENDPOINT=https://catboy.best/api/search
+MIRROR_DOWNLOAD_ENDPOINT=https://catboy.best/d
```

=== COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.