Skip to content

Commit 645209a

Browse files
authored
Merge pull request opencloud-eu#4 from ferenc-hechler/improve-readme
Improve README organization and add Matrix community links
2 parents e40ba3d + 795752f commit 645209a

File tree

2 files changed

+47
-12
lines changed

2 files changed

+47
-12
lines changed

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,4 @@
11
/.project
2+
3+
# macOS
4+
.DS_Store

README.md

Lines changed: 44 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,56 @@
44

55
Welcome to the **OpenCloud Helm Charts** repository! This repository is intended as a community-driven space for developing and maintaining Helm charts for deploying OpenCloud on Kubernetes.
66

7+
## 📑 Table of Contents
8+
9+
- [About](#-about)
10+
- [Community](#-community)
11+
- [Contributing](#-contributing)
12+
- [Prerequisites](#prerequisites)
13+
- [Installing the Helm Charts](#-installing-the-helm-charts)
14+
- [Architecture](#architecture)
15+
- [Component Interaction Diagram](#component-interaction-diagram)
16+
- [Configuration](#configuration)
17+
- [Global Settings](#global-settings)
18+
- [Image Settings](#image-settings)
19+
- [OpenCloud Settings](#opencloud-settings)
20+
- [Keycloak Settings](#keycloak-settings)
21+
- [PostgreSQL Settings](#postgresql-settings)
22+
- [OnlyOffice Settings](#onlyoffice-settings)
23+
- [Collabora Settings](#collabora-settings)
24+
- [Collaboration Service Settings](#collaboration-service-settings)
25+
- [Cilium Gateway API Configuration](#cilium-gateway-api-configuration)
26+
- [Cilium HTTPRoute Settings](#cilium-httproute-settings)
27+
- [Setting Up Gateway API with Talos, Cilium, and cert-manager](#setting-up-gateway-api-with-talos-cilium-and-cert-manager)
28+
- [Installing the DEV Helm Charts](#-installing-the-dev-helm-charts)
29+
- [License](#-license)
30+
- [Community Maintained](#community-maintained)
31+
732
## 🚀 About
833

934
This repository is created to **welcome contributions from the community**. It does not contain official charts from OpenCloud GmbH and is **not officially supported by OpenCloud GmbH**. Instead, these charts are maintained by the open-source community.
1035

11-
## Introduction
12-
1336
OpenCloud is a cloud collaboration platform that provides file sync and share, document collaboration, and more. This Helm chart deploys OpenCloud with Keycloak for authentication, MinIO for object storage, and multiple options for document editing including Collabora and OnlyOffice.
1437

38+
## 💬 Community
39+
40+
Join our Matrix chat for discussions about OpenCloud Helm Charts:
41+
- [OpenCloud Helm on Matrix](https://matrix.to/#/%23opencloud-helm:matrix.org)
42+
43+
For general OpenCloud discussions:
44+
- [OpenCloud on Matrix](https://matrix.to/#/%23opencloud:matrix.org)
45+
- [OpenCloud on Mastodon](https://social.opencloud.eu/@OpenCloud)
46+
- [GitHub Discussions](https://github.com/orgs/opencloud-eu/discussions)
47+
48+
## 💡 Contributing
49+
50+
We encourage contributions from the community! If you'd like to contribute:
51+
- Fork this repository
52+
- Submit a Pull Request
53+
- Discuss and collaborate on issues
54+
55+
Please ensure that your PR follows best practices and includes necessary documentation.
56+
1557
## Prerequisites
1658

1759
- Kubernetes 1.19+
@@ -697,16 +739,6 @@ $ helm uninstall -n opencloud opencloud
697739

698740
The data PVC is configured to be kept, so it will survive uninstall and install of opencloud-dev
699741

700-
701-
## 💡 Contributing
702-
703-
We encourage contributions from the community! If you'd like to contribute:
704-
- Fork this repository
705-
- Submit a Pull Request
706-
- Discuss and collaborate on issues
707-
708-
Please ensure that your PR follows best practices and includes necessary documentation.
709-
710742
## 📜 License
711743

712744
This project is licensed under the **AGPLv3** licence. See the [LICENSE](LICENSE) file for more details.

0 commit comments

Comments
 (0)