w-lands / api

Launcher and minecraft api server for Wl-mc project.

Wl-mc launcher and minecraft api server

Setup (docker compose)

Requirements:

• Docker with docker compose plugin

1. Clone the git repository

   git clone https://github.com/W-Lands/api

2. Rename example config

   mv .env.example .env

3. Change config variables
4. Generate 4096-bit RSA keypair in keys directory
5. Run:

   docker compose up

6. Log in into minio admin panel and change wlands-updates bucket policy to:

{
    "Version": "2012-10-17",
    "Statement": [{
        "Effect": "Allow",
        "Principal": {"AWS": ["*"]},
        "Action": ["s3:GetObject"],
        "Resource": ["arn:aws:s3:::wlands-updates/*"]
    }]
}

OR
set SET_UPDATES_BUCKET_POLICY environment variable to 1, it will set bucket policy automatically on startup.

Setup (without docker)

Requirements:

• Python 3.11+
• Poetry

1. Clone the git repository

   git clone https://github.com/W-Lands/api

2. Install dependencies:

   poetry install

3. Set the following environment variables:
   • DATABASE_URL - Database connection string, for example: mysql://username:[email protected]/wlands
   • S3_ENDPOINT - S3 endpoint, for example: http://127.0.0.1:9000
   • S3_ACCESS_KEY_ID - S3 access key
   • S3_SECRET_ACCESS_KEY - S3 secret key
     
     Optional variables:
   • SET_UPDATES_BUCKET_POLICY - set to 1 to enable automatic updates bucket policy changing.
4. Generate 4096-bit RSA keypair in keys directory
5. Run:

   poetry run uvicorn --workers 4 --host 127.0.0.1 --port 8080 wlands.main:app