Quick start guide

Welcome to the NXLog Platform on-premises quick start guide, intended to help you quickly set up an NXLog Platform instance for testing.

This guide walks you through signing up for and installing NXLog Platform, installing an agent, and configuring it to send logs to NXLog Platform. It normally takes under an hour to complete these steps.

Explore NXLog Platform

If you’re new to NXLog Platform, this video gives you an overview in under 10 minutes.

Prepare a virtual machine

Estimate: 25 minutes

Set up a virtual machine with the following requirements:
- Red Hat 8 or 9, Ubuntu 22 or 24, or SLES 15 operating system
- 11 GB RAM, 2 CPU cores
- 60 GB storage space
- Static IP address
- Internet access

See the complete system requirements for more information.

Estimate: 15 minutes

Sign up to create an organization
Download and install NXLog Platform
Configure DNS — For testing purposes, add the relevant entries to your workstation’s hosts file.
Log in to your NXLog Platform instance

You now have NXLog Platform up and running. You can navigate and explore the UI, but you don’t have any agents or data yet.

Install NXLog Agent

Estimate: 10 minutes

Install and enroll an agent

See also Bulk-deploy NXLog Agent for more information on automating the installation of the agent on multiple machines.

You have now installed an agent and connected it to NXLog Platform. The next step is to configure it to send data.

Configure NXLog Agent

Estimate: 5 minutes

Assign a configuration — Choose the default Agent logs to Platform configuration.
- You can also create a configuration or use one of our pre-made configuration templates
View your logs
Analyze your logs

That’s it! By completing these steps, you have installed NXLog Platform, connected and configured an agent, and started receiving data.

Next steps

Now that you have completed the basic setup, you may want to perform the following steps:

Learn about Navigating the NXLog Platform UI.
Configure a mail server and invite users to your NXLog Platform organization.
Follow our tutorial, Create your first NXLog Agent configuration, to gain an understanding of the agent’s configuration structure and components.