Skip to content

Installation

DecDuck edited this page Mar 4, 2024 · 4 revisions

Polyengine is in development stages, so the only option is to deploy from source. Here's how to do that.

Step 1: Setting up dependencies

Polyengine requires an S3 endpoint and a MongoDB database. Make sure you have all the required credentials. That means:

  1. MongoDB Connection URI (mongodb://[host]:[port]/[database])
  2. S3 endpoint, region, access ID and access key

Step 2: Downloading Polyengine and building

Clone this repository and navigate to the folder. Then, run:

  1. yarn, to install dependencies
  2. yarn build, to build a server

Step 3: Setup environment and run

From the output of yarn build, Nuxt 3 should give you a command to run the server. This needs to be run, with the relevant configuration environment variables.

Environment Var Name Description
SESSION (required) A session secret, at least 32 characters long and can't be shared with anyone.
MONGODB_URI (required) MongoDB connection URI, with the database name (mongodb://[host]:[port]/[database])
SELF_URL (required) The externally accessible endpoint for this server. Must be accessible both by the server and clients.
S3_ENDPOINT S3 endpoint to connect to, for the storage of resource packs. Defaults to 127.0.0.1
S3_PORT S3 port to connect to, for the storage of resource packs. Defaults to 9000
S3_REGION S3 region to connect to, defaults to auto
S3_ACCESS_ID S3 access id, defaults to minioadmin
S3_ACCESS_KEY S3 access key, defaults to minioadmin
S3_SSL Whether or not to use SSL. Defaults to on, set to false to disable
MAX_PACKS A (currently) global config option to define how many resource-packs are kept (including the latest one)

Step 4: Run the command, and voila!

Should be up now :)

Clone this wiki locally