Skip to content

Commit

Permalink
update README and Chart.yaml
Browse files Browse the repository at this point in the history
  • Loading branch information
perfectra1n committed Jul 29, 2024
1 parent 52965db commit bfff24b
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 8 deletions.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ This is the Helm Chart for Trilium, to easily deploy Trilium on your Kubernetes

Please refer to the section "Modifying Deployed Resources" below on how to customize the deployment, or refer to the examples in [the examples folder](./examples/)

Seperate from the [values.yaml](./charts/trilium/values.yaml), please also view the additional files in the [templates](./charts/trilium/templates/) folder to see the additional values that are provided to Helm, to create the Kubernetes release. These values can also be overridden, and the defaults should be completely unobtrusive to any changes that are commonly made.

If you find that a value in your release is inconsistent with those found in the [values.yaml](./charts/trilium/values.yaml) and the [bjw-s common library](https://github.com/bjw-s/helm-charts/blob/common-3.2.1/charts/library/common/values.yaml), then they are being modified in the [templates](./charts/trilium/templates/) folder. Any value changes specified by the user override any values defined within this chart.

## Requirements

- A working Kubernetes cluster.
Expand Down Expand Up @@ -87,7 +91,7 @@ Often times, modifications need to be made to a Helm chart to allow it to operat

Anything you see [here](https://github.com/bjw-s/helm-charts/blob/d9e8c23df242dd9a2dda7c3738360928526d7a20/charts/library/common/values.yaml), including the top-level keys, can be added and subtracted from this chart's `values.yaml`.

For example, if you wished to create a `serviceAccount` as can be seen [here](https://github.com/bjw-s/helm-charts/blob/d9e8c23df242dd9a2dda7c3738360928526d7a20/charts/library/common/values.yaml#L364-L376):
For example, if you wished to create a `serviceAccount`, refer to the values [here](https://github.com/bjw-s/helm-charts/blob/d9e8c23df242dd9a2dda7c3738360928526d7a20/charts/library/common/values.yaml#L364-L376), and override them as needed. So, to create a `serviceAccount`, you would want to add YAML below to your Helm release values:

```yaml
serviceAccount:
Expand Down
14 changes: 7 additions & 7 deletions charts/trilium/Chart.yaml
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
apiVersion: v2
type: application
name: trilium
home: https://github.com/TriliumNext/helm-chart
icon: https://github.com/TriliumNext/helm-chart/commit/icon.png
home: https://github.com/TriliumNext/helm-charts
icon: https://github.com/TriliumNext/helm-charts/commit/icon.png
deprecated: false
description: |-
Build your personal knowledge base with Trilium Notes. A hierarchical note taking application with focus on building large personal knowledge bases.
annotations:
category: Notes
version: 1.0.0
version: 1.0.1
appVersion: 0.63.7
kubeVersion: ">= 1.19"
dependencies:
Expand Down Expand Up @@ -36,11 +36,11 @@ keywords:
- note-taker
- local-first
maintainers:
- name: trilium
url: https://github.com/zadam/trilium
- name: triliumnext
url: https://github.com/TriliumNext/Notes
- name: perfectra1n
email: [email protected]
url: https://perf3ct.tech
sources:
- https://github.com/TriliumNext/helm-chart
- https://github.com/zadam/trilium
- https://github.com/TriliumNext/helm-charts
- hhttps://github.com/TriliumNext/Notes

0 comments on commit bfff24b

Please sign in to comment.