fulgens/README.md

1.9 KiB

Fulgens Web Server

A simple and fast plugin-based web server written in Golang.

Go Report Card Go Reference wakatime

It utilises Chi and the Go standard library to provide a fast and efficient web server, with the ability to add plugins to extend its functionality.

Features

  • Fast and efficient
  • Plugin-based
  • Easy to use
  • Comes with OAuth2 and Blob storage (known as the "nucleus" services)
  • SQLite and PostgreSQL support
  • Easy to extend

Installation

To install, git clone the repository:

git clone https://git.ailur.dev/Ailur/fulgens.git --depth 1

Then, build the server:

./build.sh

After that, configure the server using the config.json file (see below), and you're ready to go!

Usage

To run the server, simply run the binary:

./fulgens

Configuration

The server can be configured using a config.conf file. You can see the config format in config.conf.example.

Contributing

Contributions are welcome! Please open a pull request with your changes.

Plugin development

Plugins require the use of the library package, found here. This provides them with the necessary resources to interact with the rest of the server

Enterprise support

For enterprise support, please visit Ailur Enterprise.