Single Node Deployment

Bring up a local deployment and complete the initial setup.

Single Node Deployment

You can bring up a local Logship stack either with the native shell installer or with Docker Compose from the logship-deployments repository.

Native install by sh

This installs the Logship database, frontend, and agent together on a single Linux host with systemd.

curl -fsSL https://raw.githubusercontent.com/logship-io/logship-deployments/main/src/shell/install.sh | sh
# Open http://localhost:8000/setup in your browser

Useful flags:

  • --path to change the install directory (default: /opt/logship)
  • --data-root to change the data directory (default: /logship)
  • --hostname, --database-port, and --frontend-port to change endpoints
  • --overwrite to regenerate configs
  • --no-install to download/configure without creating systemd services

To uninstall:

sudo /opt/logship/uninstall.sh

Docker Compose

This example uses the single-node compose stack from logship-deployments.

Scripts only

git clone https://github.com/logship-io/logship-deployments.git
cd logship-deployments
cd src/compose/single-node
docker compose pull
docker compose up -d
# Open http://localhost:8000/setup in your browser

Guided

  1. Use git to clone a copy of the logship-deployments repository:
git clone https://github.com/logship-io/logship-deployments.git
  1. Enter the repository and move to src/compose/single-node:
cd logship-deployments
cd src/compose/single-node
  1. Pull the latest images:
docker compose pull
  1. Start the environment:
docker compose up -d

Try it out

  1. Open up the local logship frontend at http://localhost:8000/setup.
  2. Follow the setup instructions to create a login for your new database.
  3. Try it out! Explore the query and alerts page. Check out how the page views chart on the homepage changes as you explore over time.
  4. Open the Logship Administration account (visible to global administrators) to see the built-in monitoring described below.
  5. Clean up with docker compose down

Built-in monitoring

A fresh install monitors itself. The first time the backend starts it creates alerts and dashboards in the Logship Administration account, with no configuration.

Dashboards: Getting Started, Logship Platform Health, Executor & Memory, System Overview, Query Performance, Data Ingestion, Alerts & Notifications and Agent Management.

Alerts

SeverityAlertFires when
CriticalLogship service unhealthyA service has been unhealthy for 5 minutes
CriticalNo executors onlineNo executor has been registered for 10 minutes
CriticalExecutor disk almost fullLess than 10% free, or below the minimum free
WarningExecutor disk space lowLess than 20% free
WarningLogship restartedThe service has been up for under 5 minutes
WarningAlert is failingAny alert's query has failed more than twice
WarningQueries are waiting for memoryQueries have queued for query memory for 10 minutes

Warnings email every global administrator. Critical alerts also open a SEV1 incident owned by a global administrator. Email delivery requires a configured messenger.

Built-in alerts are created once. Change thresholds, add recipients, or disable them from the Alerts page and your changes survive restarts. To skip them entirely, set setupService.builtIns to false.

Verify data flow end-to-end

  1. Send a sample event. Direct inflow requires a bearer token: Push Your First Event.
curl -X PUT "http://localhost:5000/inflow/00000000-0000-0000-0000-000000000000" \
  -H "Authorization: Bearer $inflow_token" \
  -H "Content-Type: application/json" \
  -d '[{"schema":"demo.hello","timestamp":"'$(date -u +"%Y-%m-%dT%H:%M:%S.%NZ")'","data":{"message":"Hello from curl","value":42}}]'
  1. Query it in the UI (Query page):
demo.hello
| where timestamp > ago(5m)
| project timestamp, message, value
  1. Clean up:
docker compose down -v