Skip to content
/ uro Public

Provides functionality needed to run your V-Sekai backend. It will serve custom game content, support content caching, and provide a user authentication system

License

Notifications You must be signed in to change notification settings

V-Sekai/uro

Folders and files

NameName
Last commit message
Last commit date

Latest commit

a761d1e · Apr 17, 2025
Apr 6, 2025
Jul 16, 2024
Apr 14, 2025
Apr 17, 2025
Apr 16, 2025
Oct 25, 2024
Apr 14, 2025
May 19, 2024
Jun 8, 2024
Apr 16, 2025
Jul 1, 2024
Feb 10, 2025
Apr 6, 2025
Oct 25, 2024
Jul 2, 2024
Mar 10, 2025
Apr 14, 2025
May 11, 2020
Feb 13, 2025
Jul 2, 2024
Apr 14, 2025
Oct 25, 2024
Oct 25, 2024
Jul 21, 2020
Apr 14, 2025
Apr 14, 2025

Repository files navigation

Uro Server

Docker Quick Setup

To run the entire stack locally with Docker, use these commands:

Windows/Mac

Add these lines to your hosts file

0.0.0.0 vsekai.local
0.0.0.0 uro.v-sekai.cloud

then

mv frontend/.env.example frontend/.env
mv .env.example .env
docker compose up

Linux

# From repository root
mv frontend/.env.example frontend/.env
mv .env.example .env

# Setup hosts file on Linux
# Server runs on 0.0.0.0 port 80 and 443
# Frontend server
sudo bash -c 'echo "0.0.0.0 vsekai.local" >> /etc/hosts'

# Point V-Sekai game to your local server
sudo bash -c 'echo "0.0.0.0 uro.v-sekai.cloud" >> /etc/hosts'

# Run frontend and backend server
docker compose up

Server will be available at http://vsekai.local

Auto generated root CA will be in ./caddy/data/caddy/pki/authorities/local/root.crt after you run docker compose up.

Contributing

Setup

To run the entire stack locally with Docker in development mode, use the command:

docker compose -f docker-compose.development.yml up

By default, the stack uses Caddy as a reverse proxy and is accessible at http://vsekai.local. You can adjust the values by setting the ROOT_ORIGIN, URL, and FRONTEND_URL environment variables in .env and NEXT_PUBLIC_ORIGIN, NEXT_PUBLIC_API_ORIGIN in frontend/.env. Also you will need to set it in Caddyfile.

If you want to configure captcha for registration, you need to set TURNSTILE_SECRET_KEY and NEXT_PUBLIC_TURNSTILE_SITEKEY (Cloudflare Turnstile)

Once configured, access the application at:

OpenAPI Specification

When making changes to Uro, update the OpenAPI specification by running:

mix uro.apigen

This command generates the OpenAPI specification in frontend/src/__generated/openapi.json. The Uro API serves this specification at http://vsekai.local/api/v1/openapi, with documentation available at http://vsekai.local/api/v1/docs.

Once you have updated the OpenAPI specification, to regenerate the client in the frontend (and your editor), run:

docker compose -f docker-compose.development.yml up nextjs --build

About

Provides functionality needed to run your V-Sekai backend. It will serve custom game content, support content caching, and provide a user authentication system

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published