Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ivictbor authored Dec 13, 2023
1 parent e97944f commit 19521bb
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# OnLogs
# OnLogs - Logs accsess for any docker containers
<a href="https://devforth.io"><img src="./.assets/df_powered_by.svg" style="height:36px"/></a>

![Passing Badge](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/LbP22/7a0933f8cba0bddbcc95c8b850e32663/raw/onlogs_passing__heads_main.json) ![Coverage Badge](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/LbP22/7a0933f8cba0bddbcc95c8b850e32663/raw/onlogs_units_coverage__heads_main.json) ![License Badge](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/LbP22/7a0933f8cba0bddbcc95c8b850e32663/raw/license_MIT.json)
Expand All @@ -10,33 +10,33 @@

### Benefits

- πŸ”‘ Secure and simple way to access logs without server/ssh accession
- πŸ—οΈ Built with Golang & Svelte.js to extract maximum performance and tiny bundle. Logs storage implemented on top of LevelDB
- 🧸 Setup is easy as docker run command/compose snippet
- πŸ”‘ Simple and secure way to access logs of any Docker containers without server/SSH connection
- πŸ—οΈ Built with Golang & Svelte.js to extract maximum performance and keep the image and RAM footprint as small as possible. Logs storage implemented on top of lightweight LevelDB
- 🧸 Installation is easy as docker runs command/compose snippet. HTTP port exposed and could be routed from Nginx/Traefik/Directly
- πŸ–± Get every service realtime logs stream with 1 click <img src="./.assets/1.gif"/>
- πŸ“± Check logs from smartphone (insane, but we know it happens that you need it)
- 🧾 Open-Source commercial friendly MIT license
- πŸ“± Check logs from your smartphone (insane, but we know it happens that you need it)
- 🧾 Open-source, commercial-friendly MIT license
- πŸ’Ύ Small size of Docker image (~ 13 MB)
- πŸ‘₯ Share access to logs with team members, revoke any time

### Features

- πŸ’» One host can be used to view logs from all other hosts in case if you are running Cluster
- πŸ”— Share log messages to collegues via link <img src="./.assets/2.gif"/>
- πŸ’» One host can be used to view logs from all other hosts in case you are running Cluster
- πŸ”— Share log messages to colleagues via link <img src="./.assets/2.gif"/>
- πŸ’½ Clear original docker logs to keep your storage size.
- πŸ“Š Error/Info/Debug Statistics
- πŸ”Ž Search through logs (configurable case sensetivity)
- πŸ‘ View parameters (parsing JSON, show local/UTC time for every logline)
- πŸ”Ž Search through logs (configurable case sensitivity)
- πŸ‘ View parameters (parsing JSON, showing local/UTC time for every logline)
- πŸ”΄ Realtime logs updating

### Roadmap

- πŸ—‚ Grouping hosts
- 🏷 Search & Filter by tags (log status, time)
- 🏷 Search and filter by tags (log status, time)
- πŸ”ŒPlugins and internal ability to notify about some event (e.g. notify when Error happens)
- πŸ“Š Improved statistics

## Hello world & ussage
## Hello world & usage
### Docker Compose example with traefik
```sh
onlogs:
Expand Down

0 comments on commit 19521bb

Please sign in to comment.