Skip to content

Setup Wizard

The Setup Wizard runs on first boot and turns a fresh LiMon install into a working monitoring appliance. Docker installs normally open through the URL printed by the installer. Package installs normally use http://<host>:8585/setup/.

Each step validates the information it owns before moving on. The wizard creates the initial bootstrap configuration, generates credentials, and stores runtime settings so day-to-day changes can be managed later from the Admin UI.

1. Welcome

LiMon setup wizard welcome screen with license agreement acceptance
The welcome step explains what information is needed and requires license agreement acceptance before setup begins.

Use this screen to confirm that the instance is still in first-run mode and that you are ready to initialize it. The wizard also links to the license summary and full EULA if you want to read them before continuing.

2. Company

LiMon setup wizard company information form
Company details identify the LiMon installation in support, reports, and system metadata.

Enter the organization name, primary contact, and contact email for this installation. These values can be corrected later from the Admin UI if ownership changes.

3. Database

LiMon setup wizard MariaDB connection settings
The database step verifies host, port, database name, username, and password before setup proceeds.

LiMon uses MariaDB (or MySQL) for runtime state, configuration, and license monitoring data. Test the connection here so later steps do not fail to write the configuration against an unavailable database.

4. Security

LiMon setup wizard generated API key
The security step generates the API key and requires confirmation that it has been copied.

Copy the generated API key when it is shown; the wizard warns that it will not be displayed again. This key is used for Admin UI and protected API access, and can be rotated later.

5. Notifications

LiMon setup wizard email notification SMTP settings
Email notifications can be configured with SMTP host, port, credentials, sender, TLS, and a test recipient.

SMTP is optional during setup. If configured SMTP Host, Port and Sender Address are mandatory. Or skip the step and add mail settings later from the Admin UI.

6. Monitoring

LiMon setup wizard general configuration settings
General monitoring settings define the instance display name, timezone, polling interval, and raw data retention window.

These defaults guide monitor cadence, timestamps, and how long raw polling data is kept before consolidation. Routine changes later land in the database and are picked up automatically. Make sure to set here the timezone that matches the server running LiMon.

7. License Tools

LiMon setup wizard license tool binary path settings
License tool paths tell LiMon where to find vendor utilities such as lmutil, rlmutil, lmxendutil, DSLicSrv, and lsmon.

Only configure the vendor tools you have on the system. Leave unused paths empty and add more tools later from the Admin UI as the monitored estate grows. You can test the tools and LiMon will verify if they are valid linux binaries and executable.

8. Servers

LiMon setup wizard license server add and YAML import screen
The servers step supports adding `port@host` endpoints manually or importing a server list from YAML.

Add the first license endpoints that LiMon should poll. The wizard can start from a small set; additional servers can be imported, edited, decommissioned, or reactivated later.

9. Activation

LiMon setup wizard activation screen with installation ID and license key field
The activation step shows the installation ID and accepts an evaluation or purchased license key.

This is the place where you enter your evaluation key or the permanent key if you have one. If you just bought LiMon copy the installation ID and head to the license portal to generate a new key. Paste your new license key into the wizard. Activation determines the platform tier, server limits, and subscription-gated capabilities.

10. Review And Finalize

LiMon setup wizard review screen showing company, activation, database, and general settings
The review step summarizes the collected settings, activation, database, and tools before finalization.

Review the collected settings before committing them. If the current configuration exceeds licensed limits, the wizard blocks finalization until the setup is corrected or the license is upgraded.

LiMon setup wizard Activate LiMon confirmation button
The final review section includes license tool, email, and activation confirmation details.

When you are good to go Activate the instance to write the configuration and restart LiMon with the new settings. After finalization, use the Admin UI for routine changes and the Frontend for monitoring and insights.

LiMon setup wizard restarting overlay after activation
During restart, LiMon saves the configuration and shows the installation ID plus the next login path.

Once the restart finishes you'll be redirected to the admin interface login page. Set the API URL and use the API key generated in Step 4.

Tip

You do not need every vendor binary or every license server on day one. Add the minimum needed to begin polling, then refine servers, applications, sites, and settings from the Admin UI.