Logship Logo
Logship Documentation

Install

Install

The logship agent OCI container is hosted on the GitHub Container Registry.

docker pull ghcr.io/logship-io/logship-agent:latest

Native Installation

For native installation instructions please take a look at the following links!

The release packages are available here: https://github.com/logship-io/logship-agent/releases/latest

Quick start (container)

docker run -d --name logship-agent \
  --network host \
  -v $PWD/agent-config.json:/app/appsettings.json:ro \
  ghcr.io/logship-io/logship-agent:latest
  • Mount your appsettings.json to configure outputs and inputs.
  • When not using host networking, expose any UDP ports you configure (e.g., -p 49999:49999/udp).

Quick start (Windows service)

  1. Download the latest ZIP release.
  2. Unzip and run:
.\logship-agent.exe install --config "C:\logship\appsettings.json"
.\logship-agent.exe start

Check status:

Get-Service -Name "logship-agent"

Upgrade

  • Container: pull the new tag and restart.
  • Native: stop the service, replace binaries, start the service. Preserve your config file.