Warning

This repository is currently pre-alpha, breaking changes happen frequently, there have not been any security audits, and data loss is expected.

Session Server

Session Server is the session discovery service for the OpenMinerva client.

Overview

Session Server is a self hostable microservice for the OpenMinerva project that allows users to advertise their open sessions, and have their sessions be found by others. This service only serves as an advertisement board for open sessions, and does not facilitate any connection between any parties.

Quick Start

Installation and running on Linux.

# Clone this repository.
git clone https://github.com/OpenMinerva/session-server

# Navigate to the repository.
cd session-server

# Create the .env file from the template.
cp .env.template .env

From here you have two directions. For production use, you probably want to run the command

./podman-run.sh # For production environments.

This will firstly compile all SASS files to regular css, then it will use Podman to build a container using the Containerfile using the default port 40500.

Alternatively for development, you can simply run

node server.js # For development.

to start the server on your local machine without a container.

Contributing

See CONTRIBUTING.md for guidelines, and information.