Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/amerkurev/doku
💽 Doku - Docker disk usage dashboard
https://github.com/amerkurev/doku
dashboard devops disk-space disk-usage docker docker-disk-usage monitoring size-calculation utility
Last synced: about 1 month ago
JSON representation
💽 Doku - Docker disk usage dashboard
- Host: GitHub
- URL: https://github.com/amerkurev/doku
- Owner: amerkurev
- License: mit
- Created: 2022-06-13T08:24:02.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2023-11-04T08:49:57.000Z (10 months ago)
- Last Synced: 2024-06-19T01:56:21.189Z (3 months ago)
- Topics: dashboard, devops, disk-space, disk-usage, docker, docker-disk-usage, monitoring, size-calculation, utility
- Language: Go
- Homepage: https://docker-disk.space
- Size: 2.7 MB
- Stars: 271
- Watchers: 3
- Forks: 12
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- awesome-docker - Doku - Doku is a simple web-based application that allows you to monitor Docker disk usage. [@amerkurev](https://github.com/amerkurev) (Container Operations / Monitoring)
- awesome-homelab - Doku - Docker disk usage dashboard | (Apps / Monitoring)
README
# Doku
Doku is a simple, lightweight web-based application that allows you to monitor Docker disk usage in a user-friendly manner.
The Doku displays the amount of disk space used by the Docker daemon, splits by images, containers, volumes, and builder cache.
If you're lucky, you'll also see the sizes of log files :)
Doku should work for most. It has been tested with dozen of hosts.
[](https://github.com/amerkurev/doku/actions/workflows/ci.yml)Â
[](https://coveralls.io/github/amerkurev/doku?branch=master)Â
[](https://goreportcard.com/report/github.com/amerkurev/doku)Â
[](https://hub.docker.com/r/amerkurev/doku/tags)Â
[](https://hub.docker.com/r/amerkurev/doku)Â
## Getting Doku
Doku is a very small Docker container (6 MB compressed). Pull the latest release from the index:
docker pull amerkurev/doku:latest
## Using Doku
The simplest way to use Doku is to run the Docker container. Mount the Docker Unix socket with `-v` to `/var/run/docker.sock`. Also, you need to mount the top-level directory (`/`) on the host machine in `ro` mode. Otherwise, Doku will not be able to calculate the size of the logs and bind mounts.
docker run --name doku -d -v /var/run/docker.sock:/var/run/docker.sock:ro -v /:/hostroot:ro -p 9090:9090 amerkurev/doku
Use following configuration for docker compose:
```yaml
version: "3"
services:
docu:
image: amerkurev/doku:v0.0.16
ports:
- 9090:9090
volumes:
- /var/run/docker.sock:/var/run/docker.sock:ro
- /:/hostroot:ro
```
Doku will be available at [http://localhost:9090/](http://localhost:9090/). You can change `-p 9090:9090` to any port. For example, if you want to view Doku over port 8080 then you would do `-p 8080:9090`.
## Basic auth
Doku supports basic auth for all requests. This functionality is disabled by default.
In order to enable basic auth, user should set the typical htpasswd file with `--basic-htpasswd=` or `env BASIC_HTPASSWD=`.
Doku expects htpasswd file to be crypted with `bcrypt` algorithm in the following format:
```
username1:bcrypt(password1)
username2:bcrypt(password2)
...
```
this can be generated with `htpasswd -nbB` command, i.e. `htpasswd -nbB test passwd`
## Supported architectures
- linux/amd64
- linux/arm/v7
- linux/arm64
## Special thanks to
The following great works inspired me:
- Gatus: https://github.com/TwiN/gatus
- Dozzle: https://github.com/amir20/dozzle
- Reproxy: https://github.com/umputun/reproxy
## License
[MIT](LICENSE)