Skip to content

Commit

Permalink
add install section
Browse files Browse the repository at this point in the history
  • Loading branch information
umputun committed Aug 23, 2023
1 parent f3a19ad commit 23f03b7
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,12 @@ All the configuration is done via a few command line options/environment variabl

The idea of external services is to be able to integrate status of all related services into a single response. This way a singe json response can report instance metrics as well as status of http health check, status of running containers, etc.

## installation

- install binary from [releases](https://github.com/umputun/sys-agent/releases/). It has amd64, arm64 and armv7 builds for deb, rpm and apk packages as well as for tar.gz archive.
- it also has brew package for macos: `brew install sys-agent`.
- for docker use `umputun/sys-agent:latest` or `ghcr.io/umputun/sys-agent:latest` image. It is a multi-arch image with amd64 and arm64 builds.

## usage

`$ sys-agent -l :8080 -v "root:/" -v "data:/mnt/data"`
Expand All @@ -31,6 +37,7 @@ Help Options:
-h, --help Show this help message
```

### parameters details

* volumes (`--volume`, can be repeated) is a list of name:path pairs, where name is a name of the volume, and path is a path to the volume.
Expand Down

0 comments on commit 23f03b7

Please sign in to comment.