Skip to content

Commit 3ff2e06

Browse files
committed
update readme
1 parent 81c64c8 commit 3ff2e06

1 file changed

Lines changed: 42 additions & 0 deletions

File tree

readme.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,43 @@
11
# Garage S3 Helm Chart
2+
3+
Helm chart to deploy a single-node [Garage](https://garagehq.deuxfleurs.fr)
4+
(S3-compatible object storage) to Kubernetes. It runs one node with
5+
`replication_factor=1` (no clustering/node discovery), keeps upstream security
6+
hardening and optional Prometheus monitoring, and can optionally bootstrap a
7+
bucket + access key on first boot.
8+
9+
## Configuration
10+
11+
The default configuration for this Helm chart is defined in the [values.yaml](./garage/values.yaml) file.
12+
For detailed descriptions of all the configurable parameters, refer to the provided [values.reference.yaml](./garage/values.reference.yaml) file.
13+
This file serves as the reference for all available settings and their default values. Do not use this for deployment.
14+
15+
## Manual Installation
16+
17+
You can pull and install the Helm chart directly from the OCI registry.
18+
19+
### Install Using OCI Registry
20+
21+
```bash
22+
helm install <release-name> oci://ghcr.io/aboutbits/helm-garage/garage --version <chart-version> --values values-<env>.yaml --namespace <namespace>
23+
```
24+
25+
## Build & Publish
26+
27+
To build and publish the chart, visit the GitHub Actions page of the repository and trigger the workflow "Release Package" manually.
28+
29+
## Information
30+
31+
About Bits is a company based in South Tyrol, Italy. You can find more information about us on [our website](https://aboutbits.it).
32+
33+
### Support
34+
35+
For support, please contact [info@aboutbits.it](mailto:info@aboutbits.it).
36+
37+
### Credits
38+
39+
- [All Contributors](../../contributors)
40+
41+
### License
42+
43+
The MIT License (MIT). Please see the [license file](license.md) for more information.

0 commit comments

Comments
 (0)