Skip to content
Logswarm

Getting started

Logswarm searches application logs where they already live — over SSH — and streams matches into a local results view. The same search engine ships in two editions:

EditionBest forHow it runs
DesktopIndividual operators and small teamsElectron app embeds @logswarm/server locally (no separate Node install for end users)
Docker (self-hosted)Shared team access on a host you controlSame server engine in a container with a persistent /data volume

Recommended first path: start with Desktop. Use Docker when you need a shared browser-accessible instance.

Prerequisites

Desktop

  • Windows installer (NSIS) built from the Logswarm release, or a portable build
  • Network access from your workstation to the SSH hosts that hold the logs
  • A valid license for the desktop installation when the product requires one (hardware key → administrator issues .logswarm.lic)

Docker

  • Docker Engine and Docker Compose
  • Host ports available (default 3000)
  • Persistent volume for /data
  • Values for APP_SECRET_KEY and INITIALIZE_PASSWORD (see Docker)

Shortest path to first search

  1. Install and open Desktop, or docker compose up for the server edition.
  2. Complete license / activation if prompted (copy hardware or installation key, import .logswarm.lic as admin).
  3. Follow Configure from scratch:
    • add an SSH Server and test the connection
    • add a Directory with at least one file location
    • create a Regex pattern and assign it to the location (or preset)
    • optionally group directories into a Preset
  4. On the search dashboard, pick Search in, enter a Search expression, and click Search.
  5. Narrow results with column filters once named groups are available.

What to read next