Skip to content

Commit f6a5cf8

Browse files
committed
add compose info for 0.8.1 release
1 parent d0aa941 commit f6a5cf8

1 file changed

Lines changed: 5 additions & 4 deletions

File tree

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
<a href="https://hub.docker.com/r/lifailon/lazyjournal"><img title="Docker Hub" src="https://img.shields.io/docker/image-size/lifailon/lazyjournal/latest?logo=docker&color=blue&label=Docker+Hub"></a>
1717
</p>
1818

19-
Terminal user interface for reading logs from `journald`, `auditd`, file system, Docker (including Swarm) containers, Podman and Kubernetes pods with support for output coloring and multiple filtering modes. Written in Go with the [awesome-gocui](https://github.com/awesome-gocui/gocui) (fork [gocui](https://github.com/jroimartin/gocui)) library.
19+
Terminal user interface for reading logs from `journald`, `auditd`, file system, Docker (including Swarm) containers, Compose stacks, Podman and Kubernetes pods with support for output coloring and multiple filtering modes. Written in Go with the [awesome-gocui](https://github.com/awesome-gocui/gocui) (fork [gocui](https://github.com/jroimartin/gocui)) library.
2020

2121
This tool is inspired by and with love for [LazyDocker](https://github.com/jesseduffield/lazydocker) and [LazyGit](https://github.com/jesseduffield/lazygit). It is also included in [Awesome-Go](https://github.com/avelino/awesome-go?tab=readme-ov-file#logging), [Awesome-TUIs](https://github.com/rothgar/awesome-tuis?tab=readme-ov-file#development) and [Awesome-Docker](https://github.com/veggiemonk/awesome-docker?tab=readme-ov-file#terminal-ui), check out other useful projects on the repository pages.
2222

@@ -52,6 +52,7 @@ This tool is inspired by and with love for [LazyDocker](https://github.com/jesse
5252
- Apple System Logs support (`asl` format).
5353
- Search and analyze all logs from remote hosts in one interface using [rsyslog](https://www.rsyslog.com) configuration.
5454
- Docker and Swarm logs from the file system or stream, including build-in timestamps and filtering by stream.
55+
- Logs of all containers in Docker Compose stacks, sorted by time for all entries.
5556
- Podman logs, without the need to run a background process (socket).
5657
- Kubernetes pods logs (you must first configure a connection to the cluster via `kubectl`).
5758
- Logs of [k3s](https://github.com/k3s-io/k3s) pods and containers from the file system on any nodes (including workers).
@@ -163,7 +164,7 @@ brew install lazyjournal
163164

164165
### Docker (Debian-based)
165166

166-
Download the [compose](/docker-compose.yml) file and run the container using the image from [Docker Hub](https://hub.docker.com/r/lifailon/lazyjournal):
167+
Download the [docker-compose](/docker-compose.yml) file and run the container using the image from [Docker Hub](https://hub.docker.com/r/lifailon/lazyjournal):
167168

168169
```shell
169170
git clone https://github.com/Lifailon/lazyjournal
@@ -172,7 +173,7 @@ docker-compose up -d
172173
docker exec -it lazyjournal lazyjournal
173174
```
174175

175-
The image is based on Debian with `systemd` and docker cli pre-installed. The necessary **read-only** permissions are already preset in `docker-compose` to support all log sources from the host system (review it to customize for your individual use).
176+
The image is based on Debian with `systemd`, docker cli, compose and kubectl pre-installed. The necessary **read-only** permissions are already preset in `docker-compose` to support all log sources from the host system (review it to customize for your individual use). To access Kubernetes logs, you need to forward the configuration to the container (if you are using a local cluster, then change the IP address of the cluster server in the configuration to the address of the host on the local network).
176177

177178
### Web mode
178179

@@ -344,7 +345,7 @@ make test-all
344345
Check the source code on the base linters using [golangci-lint](https://github.com/golangci/golangci-lint) (including all [critic](https://github.com/go-critic/go-critic) and severity high in [security](https://github.com/securego/gosec)):
345346

346347
```shell
347-
make lint-check
348+
make lint
348349
```
349350

350351
## Contributing

0 commit comments

Comments
 (0)