Skip to main content

Git

Installing Siglens using Git

The Git approach for installing SigLens is ideal for users who prefer a hands-on experience and want to customize settings directly. Cloning the repository and running locally provides transparency and control, making it ideal for developers and system administrators who enjoy a more involved installation process.

System Requirements​

Before getting started, make sure you have the following prerequisites:

  1. Git: Ensure that Git is installed on your system.

  2. Golang: SigLens requires Golang to be installed and configured on your machine.

    • Ubuntu/Debian:

      sudo apt update && sudo apt install golang-go

    • CentOS/RHEL:

      sudo yum install epel-release
      sudo yum install golang

    • MacOS: Make sure you have Homebrew installed, then run:

      brew update && brew install golang

Windows Support​

Currently, SigLens does not natively support Windows. However, you can choose one of the following workarounds:

  1. Create a Linux Virtual Machine using VirtualBox or QEMU (VirtualBox, QEMU)
  2. Use WSL2 to emulate a Linux environment within your Windows system
  3. Run SigLens as a Docker container. Refer to the Docker installation guide.

Cloning and Running SigLens​

Follow these steps, Once you have the prerequisites set up and a Linux or MacOS environment. For Windows, you can use Linux Virtual Machine or WSL2:

  1. Clone the SigLens repository:

    git clone https://github.com/siglens/siglens.git

  2. Navigate to the SigLens directory:

    cd siglens

  3. Run the SigLens binary:

    go run cmd/siglens/main.go --config server.yaml

    Please note: If you're running SigLens in a different directory, adjust the commands accordingly.

  4. Access the SigLens UI at http://localhost:5122/.

    Note: Be mindful of port numbers. If you changed the ports, use the correct port number for the UI dashboard.

Configuring SigLens​

The server.yaml config file sets up SigLens to run on ports 5122 (UI and Query Server) and 8081 (Ingestion Server). You can customize these ports as needed.

Next Steps​

Log Ingestion

If you encounter any issues or have questions, feel free to reach out to the SigLens community for assistance.