Deployment

Overview

openfsd runs as two separate processes:

1. The FSD server itself
2. A web server providing a REST API and a basic frontend

The FSD server exposes its own lightweight web server allowing the main webserver to interface with it. This is used to obtain online user information, kick users, etc. The API for this system is proprietary and is not designed to be interacted with directly by the end-user. However, it must be accessible internally by the main webserver. The sample docker compose file accomplishes this.

Docker

A sample compose file is provided, orchestrating a complete openfsd deployment utilizing an SQLite database shared by both processes. Most people running a small server should consider using this deployment scheme, ensuring that they periodically back up the SQLite .db file.

Quick Start

1. Clone the Repository:

   git clone https://github.com/renorris/openfsd.git
   cd openfsd

2. Start with Docker Compose:

   docker-compose up -d

Manual deployments, k8s, etc.

The FSD and webserver images can be pulled directly from the openfsd container registry.

Windows

Option 1: Docker Desktop

Windows users may run the above Docker Compose deployment via Docker Desktop. After installing Docker Desktop, download the openfsd repository and navigate to the root directory. Run the same command docker-compose up -d.

Option 2: Batch File

1. Install the Go Programming Language
2. Download the openfsd repository, unzip, navigate into the created folder, then click run-windows.bat.
3. Wait for the downloads to complete and for the server to start.
4. Scroll up in the popup window until you find the DEFAULT ADMINISTRATOR CREDENTIALS:

5. Open your web browser, navigate to http://localhost:8000, and log in with these credentials.

To reset the database, delete the created openfsd.db file located next to run-windows.bat.