Introduction

Getting Started

Prerequisites

HTTPS Setup

Configuration

Config File & Env Vars

Database Setup

Deployment

Local JAR

Docker

Cloud Hosting

Advanced

Systemd Service

Nginx WebSocket Proxy

Firewall Setup

Security Notes

Troubleshooting

How It Works

Browser Extension

Configuration File & Environment Variables

You can configure the server using either a configuration file or environment variables.

Option 1: Configuration File (

linkoraConfig.json

)

This file is auto-generated on the first run; the server will prompt you for required values. The 

hostAddress

and

serverPort

 fields are automatically detected and set by the server.

{
  "databaseUrl": "mysql://localhost:3306/linkora",
  "databaseUser": "your_username",
  "databasePassword": "your_password",
  "hostAddress": "xxx.xxx.xxx.xxx",
  "serverPort": 45454,
  "httpsPort": 54545,
  "keyStorePassword": "your_keystore_password",
  "serverAuthToken": "your_secure_token"
}

content_copy

HTTPS Configuration Details

httpsPort

: This optional field sets the port for HTTPS connections (default:

54545

)
keyStorePassword

: This password for your keystore is

auto-generated by the server
For HTTPS connections, the server always uses the machine's IPv4 address. The

hostAddress

field in the configuration file primarily applies to HTTP connections

Option 2: Environment Variables

Use these for containerized deployments, cloud hosting, or any scenario where you prefer environment variables over configuration files. 

LINKORA_HOST_ADDRESS

,

LINKORA_SERVER_PORT

,

LINKORA_HTTPS_PORT

, and 

LINKORA_KEY_STORE_PASSWORD

 are all optional, as the server can auto-detect/set them.

LINKORA_SERVER_USE_ENV_VAL=true
LINKORA_DATABASE_URL=mysql://localhost:3306/linkora
LINKORA_DATABASE_USER=your_username
LINKORA_DATABASE_PASSWORD=your_password
LINKORA_HOST_ADDRESS=xxx.xxx.xxx.xxx
LINKORA_SERVER_PORT=45454
LINKORA_HTTPS_PORT=54545
LINKORA_KEY_STORE_PASSWORD=your_keystore_password
LINKORA_SERVER_AUTH_TOKEN=your_secure_token

content_copy

Configuration Notes

Environment Variables

: For local JAR hosting,

linkoraConfig.json

is recommended. For Docker and cloud hosting, use environment variables.
Host Address

: The

hostAddress

field automatically defaults to the machine's current network IPv4 address. The server detects this automatically, so no manual configuration is needed for HTTP connections.

info

Last Updated on: Sep 11, 2025 at 04:00 PM IST

Made with genesis.