From 868c029e4dc7ba3533d065516a1afbabc6791010 Mon Sep 17 00:00:00 2001
From: pat-s <patrick.schratz@gmail.com>
Date: Wed, 28 Jun 2023 06:57:19 +0000
Subject: [PATCH] Document how to add custom themes (#460)

<!--
 Before you open the request please review the following guidelines and tips to help it be more easily integrated:

 - Describe the scope of your change - i.e. what the change does.
 - Describe any known limitations with your change.
 - Please run any tests or examples that can exercise your modified code.

 Thank you for contributing! We will try to review, test and integrate the change as soon as we can.
 -->

### Description of the change

Add documentation how to add custom themes

### Benefits

<!-- What benefits will be realized by the code change? -->

### Possible drawbacks

<!-- Describe any known limitations with your change -->

### Applicable issues

<!-- Enter any applicable Issues here (You can reference an issue using #). Please remove this section if there is no referenced issue. -->
  - fixes #301

### Additional information

<!-- If there's anything else that's important and relevant to your pull request, mention that information here. Please remove this section if it remains empty. -->

### Checklist

<!-- [Place an '[X]' (no spaces) in all applicable fields. Please remove unrelated fields.] -->

- [x] Parameters are documented in the `values.yaml` and added to the `README.md` using [readme-generator-for-helm](https://github.com/bitnami-labs/readme-generator-for-helm)
- [x] Breaking changes are documented in the `README.md`
- [x] Templating unittests are added

Reviewed-on: https://gitea.com/gitea/helm-chart/pulls/460
Co-authored-by: pat-s <patrick.schratz@gmail.com>
Co-committed-by: pat-s <patrick.schratz@gmail.com>
---
 README.md | 43 +++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 43 insertions(+)

diff --git a/README.md b/README.md
index 766f04f..cbe9708 100644
--- a/README.md
+++ b/README.md
@@ -21,6 +21,7 @@
 - [Configure commit signing](#configure-commit-signing)
 - [Metrics and profiling](#metrics-and-profiling)
 - [Pod annotations](#pod-annotations)
+- [Themes](#themes)
 - [Parameters](#parameters)
   - [Global](#global)
   - [Image](#image)
@@ -606,6 +607,48 @@ gitea:
   podAnnotations: {}
 ```
 
+## Themes
+
+Custom themes can be added via k8s secrets and referencing them in `values.yaml`.
+
+```yaml
+extraVolumes:
+  - name: gitea-themes
+    secret:
+      secretName: gitea-themes
+
+extraVolumeMounts:
+  - name: gitea-themes
+    readOnly: true
+    mountPath: "/data/gitea/public/css"
+```
+
+The secret can be created via `terraform`:
+
+```hcl
+resource "kubernetes_secret" "gitea-themes" {
+  metadata {
+    name      = "gitea-themes"
+    namespace = "gitea"
+  }
+
+  data = {
+    "theme-custom.css"      = "${file("FULL-PATH-TO-CSS")}"
+    "theme-custom-dark.css" = "${file("FULL-PATH-TO-CSS")}"
+  }
+
+  type = "Opaque"
+
+  depends_on = [kubernetes_namespace.gitea]
+}
+```
+
+or natively via `kubectl`:
+
+```bash
+kubectl create secret generic gitea-themes --from-file={{FULL-PATH-TO-CSS}} --namespace gitea
+```
+
 ## Parameters
 
 ### Global