diff --git a/.github/workflows/ssc-stable.yml b/.github/workflows/ssc-stable.yml index 79053f49b2..4d412b5ba4 100644 --- a/.github/workflows/ssc-stable.yml +++ b/.github/workflows/ssc-stable.yml @@ -84,7 +84,7 @@ jobs: org.opencontainers.image.authors="Axoflow" org.opencontainers.image.vendor="Axoflow" org.opencontainers.image.licenses="GPL-3.0-only" - org.opencontainers.image.source="https://github.com/axoflow/axosyslog-docker" + org.opencontainers.image.source="https://github.com/axoflow/axosyslog" org.opencontainers.image.documentation="https://axoflow.com/docs/axosyslog/docs/" org.opencontainers.image.url="https://axoflow.io/" diff --git a/README.md b/README.md index e587e16849..7732f05cca 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@

- - - Axoflow + + + Axoflow

@@ -13,26 +13,9 @@ 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: +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). -- 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-docker/pkgs/container/axosyslog](https://github.com/axoflow/axosyslog-docker/pkgs/container/axosyslog). - -_NOTE: Images found at [https://github.com/axoflow/axosyslog-docker/pkgs/container/syslog-ng](https://github.com/axoflow/axosyslog-docker/pkgs/container/syslog-ng) are deprecated and will be removed in the future._ +_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._ To install the latest stable version, run: @@ -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-docker) 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 @@ -83,14 +79,23 @@ 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-docker/issues), or come chat with us in the [syslog-ng channel of the Axoflow Discord server](https://discord.gg/4Fzy7D66Qq). +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). ## Contribution If you have fixed a bug or would like to contribute your improvements to -AxoSyslog, [open a pull request](https://github.com/axoflow/axosyslog-docker/pulls). We truly appreciate your help. +AxoSyslog, [open a pull request](https://github.com/axoflow/axosyslog/pulls). We truly appreciate your help. ## About Axoflow diff --git a/syslog-ng/alpine.dockerfile b/syslog-ng/alpine.dockerfile index 3508da9524..b471ecb05b 100644 --- a/syslog-ng/alpine.dockerfile +++ b/syslog-ng/alpine.dockerfile @@ -46,7 +46,7 @@ LABEL org.opencontainers.image.description="A cloud-native distribution of syslo LABEL org.opencontainers.image.authors="Axoflow" LABEL org.opencontainers.image.vendor="Axoflow" LABEL org.opencontainers.image.licenses="GPL-3.0-only" -LABEL org.opencontainers.image.source="https://github.com/axoflow/axosyslog-docker" +LABEL org.opencontainers.image.source="https://github.com/axoflow/axosyslog" LABEL org.opencontainers.image.documentation="https://axoflow.com/docs/axosyslog/docs/" LABEL org.opencontainers.image.url="https://axoflow.io/"