Self-hosting and local installation

Run LumeOS on your own infrastructure.

The current LumeDocs and LumeNotes releases are static web applications. Download the source package, place the files behind a web server and use the applications without a required database or server-side account system.

Download LumeDocs 0.4.9Download LumeNotes 2.0.2
Before installing

Small requirements, clear boundaries.

The web server delivers the application files. User documents and notes remain in each browser unless you add your own synchronization layer.

01

A web server

Apache, Nginx, Caddy, shared hosting, XAMPP, WampServer, MAMP or another server capable of serving static files.

02

A modern browser

Use an up-to-date browser with IndexedDB and the web APIs used by the application.

03

No required database

The current core applications do not require MySQL, PostgreSQL or another database.

04

HTTPS for remote use

Use HTTPS on public or network installations. Localhost can be used for local testing and development.

1
Local computer

Install with XAMPP or a similar local server.

Do not open the application by double-clicking index.html. Serve it through http://localhost so browser storage, service workers and installable-app features work consistently.

XAMPP example

  1. 1

    Install XAMPP and start the Apache module.

  2. 2

    Download the LumeDocs or LumeNotes source package and extract it.

  3. 3

    Copy the folder containing index.html into the XAMPP htdocs directory.

  4. 4

    Open the application through localhost in your browser.

Common htdocs locationsWindows: C:\xampp\htdocs\lumenotesLinux: /opt/lampp/htdocs/lumenotesmacOS: /Applications/XAMPP/xamppfiles/htdocs/lumenotes
Example addresshttp://localhost/lumenotes/http://localhost/lumedocs/

Quick alternatives

From the folder containing index.html, you can also start a temporary local server with one of these commands.

python3 -m http.server 8080
npx serve .

http://localhost:8080

2
Own server or hosting

Publish on a domain, subdomain or internal network.

Upload the contents of the application folder to the document root assigned to the address where it will run. Keep index.html and the asset folders together.

Shared hosting or cPanel

  1. Create a subdomain such as docs.example.org or notes.example.org, or choose a subfolder.
  2. Upload and extract the package in the document root configured for that address.
  3. Enable HTTPS and open the address in a modern browser.

Apache and similar servers

For a normal static installation, point the virtual host or subdomain document root to the folder containing index.html. No PHP configuration is required for the current core releases.

Minimal Nginx example

Change the domain and root path to match your server.

server {
    listen 80;
    server_name notes.example.org;
    root /var/www/lumenotes;
    index index.html;

    location / {
        try_files $uri $uri/ /index.html;
    }
}
3
Updates and browser data

The address is part of the local storage identity.

IndexedDB and service-worker data are separated by origin. Changing protocol, domain, port or sometimes the application path can make the browser treat the installation as a new location.

Keep the same origin

Update files at the same HTTPS address when you want existing browser data to remain associated with the installation.

Back up before updating

Export important documents and create application backups before replacing files or changing domains.

Refresh cached releases

After replacing application files, perform a hard reload. If an older service worker remains active, update or unregister it and reload again.

Modified installations

Keep the license and provide the corresponding source when required.

The official releases use AGPL-3.0-only. Preserve license notices and consult the complete license text when redistributing the software or making a modified version available over a network.

Read the license page
Choose a package

Download, inspect and run the application where you prefer.

The official hosted versions remain available, but self-hosting is a supported part of the project philosophy.

Open LumeDocsOpen LumeNotes