Skip to content

Commit

Permalink
Updated Dozzle docs with log access details and guide link
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
RaneyDazed committed Feb 5, 2024
1 parent d2fc355 commit dd4c774
Showing 1 changed file with 21 additions and 3 deletions.
24 changes: 21 additions & 3 deletions docs/apps/dozzle.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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 }

0 comments on commit dd4c774

Please sign in to comment.