From dd4c774af353760383d055d1d6d0164fd25602a8 Mon Sep 17 00:00:00 2001 From: CHAIR Date: Mon, 5 Feb 2024 13:17:56 -0600 Subject: [PATCH] Updated Dozzle docs with log access details and guide link Enhanced the Dozzle documentation to clarify that it can only monitor logs output to sysout or syserr, aligning expectations with its operational scope similar to `docker logs`. Updated the documentation links to point to the more informative guide section rather than the repository. Also provided an example setup for monitoring non-sysout/syserr logs by tailing an external log file within an Alpine container configuration. This addition offers a workaround for users needing to track logs not natively accessible by Dozzle. --- docs/apps/dozzle.md | 24 +++++++++++++++++++++--- 1 file changed, 21 insertions(+), 3 deletions(-) diff --git a/docs/apps/dozzle.md b/docs/apps/dozzle.md index 7f4d8112c..f5265ff88 100644 --- a/docs/apps/dozzle.md +++ b/docs/apps/dozzle.md @@ -2,11 +2,11 @@ ## What is it? -[Dozzle](https://dozzle.dev/) 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](https://dozzle.dev/) 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 can only access logs written to sysout or syserr which is the same functionality as the `docker logs` command. See below for more info on that. | Details | | | | |-------------|-------------|-------------|-------------| -| [:material-home: Project home](https://dozzle.dev/){: .header-icons } | [:octicons-link-16: Docs](https://github.com/amir20/dozzle){: .header-icons } | [:octicons-mark-github-16: Github](https://github.com/amir20/dozzle){: .header-icons } | [:material-docker: Docker](https://registry.hub.docker.com/r/amir20/dozzle){: .header-icons }| +| [:material-home: Project home](https://dozzle.dev/){: .header-icons } | [:octicons-link-16: Docs](https://dozzle.dev/guide/what-is-dozzle){: .header-icons } | [:octicons-mark-github-16: Github](https://github.com/amir20/dozzle){: .header-icons } | [:material-docker: Docker](https://registry.hub.docker.com/r/amir20/dozzle){: .header-icons }| ### 1. Installation @@ -22,4 +22,22 @@ sb install dozzle ### 3. Setup -- [:octicons-link-16: Documentation](https://github.com/amir20/dozzle){: .header-icons } +To view log files that are NOT written to sysout or syserr, use the following to setup a basic alpine container via compose that just tails a mounted log file (in this case, Cloudplow) which then exposes it to dozzle. Adjust as needed for your circumstances. + +``` yaml +--- + tail-cloudplow: + container_name: tail-cloudplow + image: alpine + volumes: + - /opt/cloudplow/cloudplow.log:/opt/cloudplow/cloudplow.log:ro + command: + - tail + - -F + - /opt/cloudplow/cloudplow.log + network_mode: none + restart: unless-stopped + user: 1000:1001 +``` + +- [:octicons-link-16: Documentation](https://dozzle.dev/guide/what-is-dozzle){: .header-icons }