Skip to content

Latest commit

 

History

History
159 lines (104 loc) · 7.75 KB

README.md

File metadata and controls

159 lines (104 loc) · 7.75 KB
Raw

Dozzle - dozzle.dev

Dozzle is a small lightweight application with a web based interface to monitor Docker logs. It doesn’t store any log files. It is for live monitoring of your container logs only.

dozzle-dark.mp4

Docker Image Size (latest by date) Docker Pulls Docker Version Test

Features

  • Intelligent fuzzy search for container names 🤖
  • Search logs using regex 🔦
  • Search logs using SQL queries 📊
  • Small memory footprint 🏎
  • Split screen for viewing multiple logs
  • Live stats with memory and CPU usage
  • Multi-user authentication with support for proxy forward authorization 🚨
  • Swarm mode support 🐳
  • Agent mode for monitoring multiple Docker hosts 🕵️‍♂️
  • Dark mode 🌙

Dozzle has been tested with hundreds of containers. However, it doesn't support offline searching. Products like Loggly, Papertrail or Kibana are more suited for full search capabilities.

Getting Started

Dozzle is a small container (7 MB compressed). Pull the latest release with:

$ docker pull amir20/dozzle:latest

Running Dozzle

The simplest way to use dozzle is to run the docker container. Also, mount the Docker Unix socket with --volume to /var/run/docker.sock:

$ docker run --name dozzle -d --volume=/var/run/docker.sock:/var/run/docker.sock -p 8080:8080 amir20/dozzle:latest

Dozzle will be available at http://localhost:8080/.

Here is the Docker Compose file:

services:
  dozzle:
    container_name: dozzle
    image: amir20/dozzle:latest
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock
    ports:
      - 8080:8080

For advanced options like authentication, remote hosts or common questions see documentation at dozzle.dev.

Swarm Mode

Dozzle works with Docker Swarm mode. You can run Dozzle as a global service with:

$ docker service create --name dozzle --env DOZZLE_MODE=swarm --mode global --mount type=bind,source=/var/run/docker.sock,target=/var/run/docker.sock -p 8080:8080 amir20/dozzle:latest

See the Swarm Mode documentation for more details.

Agent Mode

Dozzle can be used to monitor multiple Docker hosts. You can run Dozzle in agent mode with:

$ docker run -v /var/run/docker.sock:/var/run/docker.sock -p 7007:7007 amir20/dozzle:latest agent

See the Agent Mode documentation for more details.

Technical Details

Dozzle users automatic API negotiation which works with most Docker configurations. Dozzle also works with Colima and Podman.

Installation on podman

By default Podman doesn't have a background process but you can enable this for Dozzle to work.

Verify first if your podman installation has enabled remote socket:

podman info

When you get under the key remote socket output like this, its already enabled:

  remoteSocket:
    exists: true
    path: /run/user/1000/podman/podman.sock

If it's not enabled please follow this tutorial to enable it.

Once you have the podman remote socket you can run Dozzle on podman.

podman run --volume=/run/user/1000/podman/podman.sock:/var/run/docker.sock -d -p 8080:8080 docker.io/amir20/dozzle:latest

Additionally you have to create a fake engine-id to prevent host not found errors. Podman doesn't generate an engine-id like Docker by itself due to its daemonless architecture.

Under /var/lib/docker create a file named engine-id. On a system with Podman you will have to create the folder path as well. Inside the file place the UUID, for instance using uuidgen > engine-id. After that the file should have an identifier that looks like this: b9f1d7fc-b459-4b6e-9f7a-e3d1cd2e14a9.

For more details check Podman Infos or the FAQ

Security

Dozzle supports file based authentication and forward proxy like Authelia. These are documented at https://dozzle.dev/guide/authentication.

Analytics collected

Dozzle collects anonymous user configurations using Google Analytics. Why? Dozzle is an open source project with no funding. As a result, there is no time to do user studies of Dozzle. Analytics is collected to prioritize features and fixes based on how people use Dozzle. This data is completely public and can be viewed live using Data Studio dashboard.

If you do not want to be tracked at all, see the --no-analytics flag below.

Environment variables and configuration

Dozzle follows the 12-factor model. Configurations can use the CLI flags or environment variables. The table below outlines all supported options and their respective env vars.

Flag Env Variable Default
--addr DOZZLE_ADDR :8080
--base DOZZLE_BASE /
--hostname DOZZLE_HOSTNAME ""
--level DOZZLE_LEVEL info
--auth-provider DOZZLE_AUTH_PROVIDER none
--auth-header-user DOZZLE_AUTH_HEADER_USER Remote-User
--auth-header-email DOZZLE_AUTH_HEADER_EMAIL Remote-Email
--auth-header-name DOZZLE_AUTH_HEADER_NAME Remote-Name
--enable-actions DOZZLE_ENABLE_ACTIONS false
--filter DOZZLE_FILTER ""
--no-analytics DOZZLE_NO_ANALYTICS false
--mode DOZZLE_MODE server
--remote-host DOZZLE_REMOTE_HOST
--remote-agent DOZZLE_REMOTE_AGENT

Support

There are many ways you can support Dozzle:

  • Use it! Write about it! Star it! If you love Dozzle, drop me a line and tell me what you love.
  • Blog about Dozzle to spread the word. If you are good at writing send PRs to improve the documentation at dozzle.dev
  • Sponsor my work at https://www.buymeacoffee.com/amirraminfar

Buy Me A Coffee

License

MIT

Building

To build and test locally:

  1. Install NodeJs and pnpm.
  2. Install Go.
  3. Install tools with make tools.
  4. Install node modules pnpm install.
  5. Run make dev to start a development server with hot reload.