Getting Started
Welcome to LogDeck! Get started in minutes with our Docker-based deployment.
What is LogDeck?
LogDeck is an open-source tool designed to be the most intuitive and visually appealing solution for monitoring Docker container logs and managing containers. Built with modern web technologies and a Go backend, LogDeck provides a beautiful interface for working with Docker.
Why LogDeck?
Docker's command-line tools are powerful but can be cumbersome for everyday use. LogDeck provides:
- Real-time log streaming - Watch your container logs update in real-time with automatic scrolling
- Log history - Logs are stored locally, so you can still read them after a container restarts, gets rebuilt, or is removed entirely
- Alerting - Get notified when a container dies, gets OOM-killed, or starts logging errors
- Multi-host management - Connect to multiple Docker or Podman daemons (local, TCP, or SSH) and manage them from one UI
- Advanced filtering - Search, filter by log level, and use regex to find exactly what you need
- Container management - Start, stop, restart, and remove containers, or operate on whole Compose stacks at once
- Stats and trends - Live CPU and memory per container, with sparklines covering recent history
- Live resource tuning - Edit memory limits, CPU limits, and restart policies with no container downtime
- A scriptable CLI - Everything the UI can see, from your terminal, with JSON output for scripts and AI agents
- Zero configuration - Works out of the box with sensible defaults
- Optional authentication - Login sessions and scoped API tokens, or run it completely open
Quick Start
The fastest way to get LogDeck running is with Docker Compose:
services:
logdeck:
image: amoabakelvin/logdeck:latest
container_name: logdeck
ports:
- "8123:8080"
volumes:
- /var/run/docker.sock:/var/run/docker.sock
- /proc:/host/proc:ro
# Config file, stored log history, and alert history
- logdeck-data:/data
restart: unless-stopped
volumes:
logdeck-data:Save this as docker-compose.yml and run:
docker-compose up -dThen open your browser to http://localhost:8123
The logdeck-data volume is where LogDeck keeps its config file, its stored log history, and its alert history. Leave it out and all three are lost the next time the container is recreated.
What's Next?
Now that you have LogDeck running, here are some next steps:
- Installation Guide - Learn about different deployment options
- Features - Discover all the features LogDeck offers
- Log History - How stored logs work, and how to tune retention
- Alerting - Alert on container deaths, OOM kills, and log patterns
- CLI - Install the logdeck command-line client and work from the terminal
- Configuration - Configure authentication, environment variables, and more
System Requirements
- Docker Engine 20.10 or later
- Access to the Docker socket (
/var/run/docker.sock) - Modern web browser (Chrome, Firefox, Safari, or Edge)
- Network access and credentials for any remote Docker hosts if using multi-host mode
Getting Help
If you encounter any issues or have questions:
- Check the GitHub Issues for known problems and solutions
- Open a new issue on GitHub