Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Dozzle documentation with log access details and guide link #265

Merged
merged 5 commits into from
Feb 5, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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.
RaneyDazed marked this conversation as resolved.
Show resolved Hide resolved

| 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.
RaneyDazed marked this conversation as resolved.
Show resolved Hide resolved

``` yaml
owine marked this conversation as resolved.
Show resolved Hide resolved
---
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 }