diff --git a/README.md b/README.md index a75f311..0a40962 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,38 @@ -# inbuxa-charts +

+ inbuxa +

-The Helm chart for running inbuxa on Kubernetes: the mail server, the -webmail and the console, against a PostgreSQL, NATS and S3 you provide. +

+ inbuxa on Kubernetes: the Helm chart +

-**Status: in development.** The chart is being built for inbuxa 27.1 and -doesn't install anything yet. Release candidates start with `27.1.0-rc.1`. +

+ License: Apache-2.0 + Latest release + Forum: community.coffeylabs.org + Chat on Discord +

+ +--- + +> [!NOTE] +> Development happens on [git.coffeylabs.org/inbuxa/inbuxa-charts](https://git.coffeylabs.org/inbuxa/inbuxa-charts); the copy on GitHub is a read-only mirror. +> Report issues at **[git.coffeylabs.org/inbuxa/inbuxa-charts/issues](https://git.coffeylabs.org/inbuxa/inbuxa-charts/issues)**, join discussions at **[community.coffeylabs.org](https://community.coffeylabs.org)**, or chat on **[Discord](https://discord.gg/nqcY4TKfAn)**. + +> [!WARNING] +> **In development.** The chart is being built for inbuxa 27.1 and has no +> release yet: the first is `27.1.0-rc.1`, a release candidate, with the +> install guide on [docs.inbuxa.org](https://docs.inbuxa.org). Until then, +> nothing here is supported for running mail. + +The Helm chart for running **inbuxa** on Kubernetes: the mail server, the +[webmail](https://git.coffeylabs.org/inbuxa/inbuxa-webmail) and the +[console](https://git.coffeylabs.org/inbuxa/inbuxa-admin), against a +PostgreSQL, NATS and S3 you provide. Every release is signed and pins its +images by digest; see [Releases](#releases). The chart is tested end to end +in [inbuxa-k8s-lab](https://git.coffeylabs.org/inbuxa/inbuxa-k8s-lab). + +## In this repository - `charts/inbuxa`: the chart, its values schema and its tests - `tools/check.sh`: every check CI runs; see [CONTRIBUTING.md](CONTRIBUTING.md) @@ -60,5 +88,9 @@ Installs on real clusters, the mail tests and the upgrade tests are in [inbuxa-k8s-lab](https://git.coffeylabs.org/inbuxa/inbuxa-k8s-lab). The guide is at [docs.inbuxa.org](https://docs.inbuxa.org/). -Licensed under the [Apache License 2.0](LICENSE). The images the chart runs -are licensed separately. +## License + +The chart is free software under the [Apache License 2.0](LICENSE), and a +Coffey Labs project. The images it runs are licensed separately: the server, +the webmail and the console are under the AGPL-3.0, as their own +repositories say. diff --git a/img/brand/inbuxa-lockup-light.svg b/img/brand/inbuxa-lockup-light.svg new file mode 100644 index 0000000..a912d18 --- /dev/null +++ b/img/brand/inbuxa-lockup-light.svg @@ -0,0 +1,52 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file