LumenOne Documentation

Installation

Set up and launch LumenOne with this comprehensive installation guide.

Picking a Server OS

LumenOne runs on a wide range of operating systems. We recommend using a stable Linux distribution for the best performance and security.

Operating System	Version	Notes
Debian	10 & 11	Tested and recommended. No major complications.
Ubuntu	20.04 LTS, 22.04 LTS	Full support, works without a hitch.
Windows	10, Server 2019	Beware of compatibility with certain dependencies.
CentOS	7, 8	Works, but adjustments are sometimes necessary.
Fedora	34+	Full support, but often requires recent package updates.

Dependency Installation

Update your system and install the required packages.

apt update -y && apt upgrade -y
apt install nodejs -y && apt install nginx -y && apt install git -y && apt install npm -y

Download Files

Clone the LumenOne repository into your web directory.

cd /var/www/
git clone https://github.com/lumenlabss/LumenOne.git

Configuration

Configure LumenOne by editing the config.json file.

Navigate to the folder:

cd LumenOne

Open the config file:

nano config/config.json

Example configuration:

{
  "hostname": "0.0.0.0",
  "port": 3000,
  "name": "LumenOne",
  "version": "v1.3.0-bêta",
  "session": {
    "secret": "secret-key",
    "resave": false,
    "saveUninitialized": false,
    "cookie": {
      "secure": false
    }
  },
  "rateLimit": {
    "global": {
      "windowMinutes": 15,
      "max": 100
    },
    "auth": {
      "windowMinutes": 15,
      "max": 5
    }
  }
}

Tip: To configure the web server (Nginx), please refer to the WebServer documentation.

Execution

Install Node.js dependencies and start the application.

npm install

Run LumenOne using node or a process manager like PM2:

node lumenone.js
# or
pm2 start lumenone.js

Previous: Introduction Next: WebServer