Initial commit

overleaf-helm-chart/README.md

@@ -0,0 +1,73 @@
+# Overleaf Helm Chart
+
+This Helm chart deploys Overleaf on a Kubernetes cluster using Traefik for ingress and cert-manager for SSL certificate management. It also utilizes CSI CephFS for persistent storage.
+
+## Prerequisites
+
+- Kubernetes cluster
+- Helm 3.x
+- Traefik installed in the cluster
+- Cert-manager installed in the cluster
+- CSI CephFS storage class configured
+
+## Installation
+
+To install the Overleaf Helm chart, follow these steps:
+
+1. **Clone the repository:**
+
+   ```bash
+   git clone <repository-url>
+   cd overleaf-helm-chart
+   ```
+
+2. **Update the dependencies (if any):**
+
+   ```bash
+   helm dependency update
+   ```
+
+3. **Install the chart:**
+
+   ```bash
+   helm install overleaf ./overleaf-helm-chart
+   ```
+
+   You can customize the installation by providing your own `values.yaml` file:
+
+   ```bash
+   helm install overleaf ./overleaf-helm-chart -f custom-values.yaml
+   ```
+
+## Configuration
+
+The following configuration options are available in `values.yaml`:
+
+- `image.repository`: The Docker image repository for Overleaf.
+- `image.tag`: The Docker image tag for Overleaf.
+- `mongo.storage.size`: The size of the persistent volume for MongoDB.
+- `redis.storage.size`: The size of the persistent volume for Redis.
+- `overleaf.storage.size`: The size of the persistent volume for Overleaf data.
+- `ingress.enabled`: Enable or disable ingress.
+- `ingress.hosts`: The hostnames for the ingress resource.
+- `certManager.enabled`: Enable or disable cert-manager integration.
+
+## Usage
+
+After installation, you can access Overleaf through the configured ingress hostname. Make sure that your DNS is set up to point to the Traefik ingress controller.
+
+## Uninstallation
+
+To uninstall the Overleaf Helm chart, run:
+
+```bash
+helm uninstall overleaf
+```
+
+## Contributing
+
+Contributions are welcome! Please submit a pull request or open an issue for any enhancements or bug fixes.
+
+## License
+
+This project is licensed under the MIT License. See the LICENSE file for details.