Skip to content

Commit

Permalink
add license + readme
Browse files Browse the repository at this point in the history
  • Loading branch information
andrasbacsai committed May 7, 2024
1 parent c609e1a commit 6693e56
Show file tree
Hide file tree
Showing 3 changed files with 42 additions and 1 deletion.
7 changes: 7 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Copyright 2024 coolLabs Technologies Bt.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
36 changes: 35 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,38 @@

An experimental API for gathering Linux server / Docker Engine metrics.

Used by [Coolify](https://coolify.io).
> Will be use by [coolify.io](https://coolify.io).
## Features
### Server
- CPU usage
- Memory usage
- Disk usage
### Containers
- CPU usage
- Memory usage
- Network usage


## Usage
Start as a container:
```bash
docker run -d -p 127.0.0.1:8888:8888 -v /var/run/docker.sock:/var/run/docker.sock --name sentinel ghcr.io/coollabsio/sentinel:latest
```

## API
### Server
- `GET /api/cpu` - Get CPU usage.
- `GET /api/memory` - Get memory usage.
- `GET /api/disk` - Get disk usage.

### Containers
- `GET /api/containers` - Get all containers with metrics and labels.

## Roadmap

- [ ] Able to save metrics to a database / filesystem in a time series format.

## License
MIT

File renamed without changes.

0 comments on commit 6693e56

Please sign in to comment.