Skip to content

Commit

Permalink
README.md: updates
Browse files Browse the repository at this point in the history
Signed-off-by: Balazs Scheidler <[email protected]>
  • Loading branch information
bazsi committed Dec 23, 2023
1 parent 6cf1232 commit 194d837
Showing 1 changed file with 26 additions and 21 deletions.
47 changes: 26 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,23 +13,6 @@ created and maintained by [Axoflow](https://axoflow.com).

## Container images

Our images are
different from the [upstream syslog-ng
images](https://hub.docker.com/r/balabit/syslog-ng/) in a number of ways:

- They are based on Alpine Linux, instead of Debian testing for reliability and smaller size (thus smaller attack surface).
- They incorporate cloud-native features and settings (such as the Kubernetes source).
- They incorporate container-level optimizations (like the use of an alternative malloc library) for better performance and improved security.
- They support the ARM architecture.

Our images are available for the following architectures:

- amd64
- arm/v7
- arm64

### How to use

You can find the list of tagged versions at [https://github.com/axoflow/axosyslog/pkgs/container/axosyslog](https://github.com/axoflow/axosyslog/pkgs/container/axosyslog).

_NOTE: Images found at [https://github.com/axoflow/axosyslog/pkgs/container/syslog-ng](https://github.com/axoflow/axosyslog/pkgs/container/syslog-ng) are deprecated and will be removed in the future._
Expand Down Expand Up @@ -58,18 +41,31 @@ docker pull ghcr.io/axoflow/axosyslog:nightly
> docker pull ghcr.io/axoflow/axosyslog:4.5.0
> ```
## Helm Charts
### Difference from upstream images
Our images are different from the [upstream syslog-ng images](https://hub.docker.com/r/balabit/syslog-ng/) in a number of ways:
This repository contains various [Helm charts](https://helm.sh/docs/topics/charts/) for syslog-ng. You can use these charts to install the [AxoSyslog - cloud-ready syslog-ng images](https://github.com/axoflow/axosyslog) created and maintained by [Axoflow](https://axoflow.com).
- They are based on Alpine Linux, instead of Debian testing for reliability and smaller size (thus smaller attack surface).
- They incorporate cloud-native features and settings (such as the Kubernetes source).
- They incorporate container-level optimizations (like the use of an alternative malloc library) for better performance and improved security.
- They support the ARM architecture.
### How to use
Our images are available for the following architectures:
- amd64
- arm/v7
- arm64
## Helm Charts
AxoSyslog provides [Helm charts](https://helm.sh/docs/topics/charts/) to deploy syslog-ng on Kubernetes.
[Helm](https://helm.sh) must be installed to use the charts. Please refer to
Helm's [documentation](https://helm.sh/docs) to get started.
Once Helm has been set up correctly, add the repo as follows:
helm repo add axosyslog https://axoflow.github.io/axosyslog-charts
helm repo add axosyslog https://axoflow.github.io/axosyslog
If you had already added this repo earlier, run `helm repo update` to retrieve
the latest versions of the packages. You can then run `helm search repo
Expand All @@ -83,6 +79,15 @@ To uninstall the chart:
helm delete my-axosyslog-collector
## Documentation
You can find [comprehensive documentation for AxoSyslog](https://axoflow.com/docs/axosyslog-core)
on the [Axoflow website](https://axoflow.com/).
The documentation is a combination of the syslog-ng reference guide and the
AxoSyslog reference guide. The [syslog-ng documentation](https://axoflow.com/docs/axosyslog-core)
was included in there as the upstream documentation fell out of maintenance.
## Contact and support
In case you need help or want to contact us, open a [GitHub issue](https://github.com/axoflow/axosyslog/issues), or come chat with us in the [syslog-ng channel of the Axoflow Discord server](https://discord.gg/4Fzy7D66Qq).
Expand Down

0 comments on commit 194d837

Please sign in to comment.