Skip to content

Commit

Permalink
✨ (memos): Initial release
Browse files Browse the repository at this point in the history
  • Loading branch information
gabe565 committed Mar 27, 2023
1 parent 7ce4089 commit 37837f2
Show file tree
Hide file tree
Showing 9 changed files with 222 additions and 0 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ helm delete my-<chart-name>
| [homer <img src='https://raw.githubusercontent.com/bastienwirtz/homer/5609315fe77da5441a9c3dda8d92c0ffe9f1bf17/public/assets/icons/logo.svg' alt='homer icon' width='18px' align='right' loading='lazy'>](charts/homer/) | A dead simple static HOMepage for your servER to keep your services on hand, from a simple yaml configuration file. |
| [limo ](charts/limo/) | A file upload server. |
| [matrimony <img src='https://raw.githubusercontent.com/gabe565/matrimony/b13163b384b27273080deb8d57d1222ba11337f9/frontend/public/img/logo.svg' alt='matrimony icon' width='18px' align='right' loading='lazy'>](charts/matrimony/) | Self-hosted wedding site configured via YAML |
| [memos <img src='https://raw.githubusercontent.com/usememos/memos/2e14561bfce0092851ab612b6d849b9c9815228c/web/public/logo.png' alt='memos icon' width='18px' align='right' loading='lazy'>](charts/memos/) | A lightweight, self-hosted memo hub. Open Source and Free forever. |
| [miniflux <img src='https://raw.githubusercontent.com/miniflux/logo/40cb83cc5b190212ad29fb4d5db6b52b335e4dc2/icon.svg' alt='miniflux icon' width='18px' align='right' loading='lazy'>](charts/miniflux/) | Miniflux is a minimalist and opinionated feed reader. |
| [mnemonic-ninja <img src='https://raw.githubusercontent.com/gabe565/mnemonic-ninja/465602cd7093f62d611c69d7a91e520e4022fab9/src/assets/logo.svg' alt='mnemonic-ninja icon' width='12px' align='right' loading='lazy'>](charts/mnemonic-ninja/) | Mnemonic Ninja is a website to convert between a number and its corresponding word to aid in memorization. |
| [monica <img src='https://raw.githubusercontent.com/monicahq/monica/main/public/img/monica.svg' alt='monica icon' width='18px' align='right' loading='lazy'>](charts/monica/) | Personal CRM. Remember everything about your friends, family and business relationships. |
Expand Down
25 changes: 25 additions & 0 deletions charts/memos/.helmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Patterns to ignore when building packages.
# This supports shell glob matching, relative path matching, and
# negation (prefixed with !). Only one pattern per line.
.DS_Store
# Common VCS dirs
.git/
.gitignore
.bzr/
.bzrignore
.hg/
.hgignore
.svn/
# Common backup files
*.swp
*.bak
*.tmp
*.orig
*~
# Various IDEs
.project
.idea/
*.tmproj
.vscode/
# helm-docs templates
*.gotmpl
6 changes: 6 additions & 0 deletions charts/memos/Chart.lock
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
dependencies:
- name: common
repository: https://bjw-s.github.io/helm-charts
version: 1.3.2
digest: sha256:9bb4816882dfc02904f9f347a7995bf7acefd55bd60f925c3a8d80938a2b1ec0
generated: "2023-02-19T11:54:44.803013189Z"
26 changes: 26 additions & 0 deletions charts/memos/Chart.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
apiVersion: v2
name: memos
description: A lightweight, self-hosted memo hub. Open Source and Free forever.
home: https://charts.gabe565.com/charts/memos
icon: https://raw.githubusercontent.com/usememos/memos/2e14561bfce0092851ab612b6d849b9c9815228c/web/public/logo.png
type: application
version: 0.1.0
# renovate datasource=docker depName=neosmemo/memos
appVersion: 0.11.2
kubeVersion: ">=1.22.0-0"
keywords:
- memo
- markdown
- note-taking
dependencies:
- name: common
repository: https://bjw-s.github.io/helm-charts
version: 1.3.2
sources:
- https://github.com/gabe565/charts/tree/main/charts/memos
- https://usememos.com
- https://github.com/usememos/memos
annotations:
artifacthub.io/changes: |-
- kind: added
description: Initial release
97 changes: 97 additions & 0 deletions charts/memos/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
# memos

<img src="https://raw.githubusercontent.com/usememos/memos/2e14561bfce0092851ab612b6d849b9c9815228c/web/public/logo.png" align="right" width="92" alt="memos logo">

![Version: 0.1.0](https://img.shields.io/badge/Version-0.1.0-informational?style=flat)
![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat)
![AppVersion: 0.11.2](https://img.shields.io/badge/AppVersion-0.11.2-informational?style=flat)

A lightweight, self-hosted memo hub. Open Source and Free forever.

**Homepage:** <https://charts.gabe565.com/charts/memos>

**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/gabe565/charts/issues/new)**

## Source Code

* <https://github.com/gabe565/charts/tree/main/charts/memos>
* <https://usememos.com>
* <https://github.com/usememos/memos>

## Requirements

Kubernetes: `>=1.22.0-0`

## Dependencies

| Repository | Name | Version |
|------------|------|---------|
| <https://bjw-s.github.io/helm-charts> | common | 1.3.2 |

## TL;DR

```console
helm repo add gabe565 https://charts.gabe565.com
helm repo update
helm install memos gabe565/memos
```

## Installing the Chart

To install the chart with the release name `memos`

```console
helm install memos gabe565/memos
```

## Uninstalling the Chart

To uninstall the `memos` deployment

```console
helm uninstall memos
```

The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release.

## Configuration

Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values.
Other values may be used from the [values.yaml](https://github.com/bjw-s/helm-charts/tree/main/charts/library/common/values.yaml) from the [bjw-s common library](https://github.com/bjw-s/helm-charts/tree/main/charts/library/common).

Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.

```console
helm install memos \
--set env.TZ="America/New York" \
gabe565/memos
```

Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.

```console
helm install memos gabe565/memos -f values.yaml
```

## Custom configuration

N/A

## Values

**Important**: When deploying an application Helm chart you can add more values from the bjw-s common library chart [here](https://github.com/bjw-s/helm-charts/tree/main/charts/library/common)

| Key | Type | Default | Description |
|-----|------|---------|-------------|
| image.pullPolicy | string | `"IfNotPresent"` | image pull policy |
| image.repository | string | `"neosmemo/memos"` | image repository |
| image.tag | string | `"0.11.2"` | image tag |
| ingress.main | object | See [values.yaml](./values.yaml) | Enable and configure ingress settings for the chart under this key. |
| persistence | object | See [values.yaml](./values.yaml) | Configure persistence settings for the chart under this key. |
| podSecurityContext.fsGroup | int | `65534` | Volume binds will be granted to `nobody` group |
| podSecurityContext.runAsGroup | int | `65534` | Run as `nobody` group |
| podSecurityContext.runAsUser | int | `65534` | Run as `nobody` user |
| service | object | See [values.yaml](./values.yaml) | Configures service settings for the chart. |

---
Autogenerated from chart metadata using [helm-docs](https://github.com/norwoodj/helm-docs)
9 changes: 9 additions & 0 deletions charts/memos/README_CONFIG.md.gotmpl
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{{- define "custom.custom.configuration.header" -}}
## Custom configuration
{{- end -}}

{{- define "custom.custom.configuration" -}}
{{ template "custom.custom.configuration.header" . }}

N/A
{{- end -}}
1 change: 1 addition & 0 deletions charts/memos/templates/NOTES.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{{- include "bjw-s.common.lib.chart.notes" . -}}
1 change: 1 addition & 0 deletions charts/memos/templates/common.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{{ include "bjw-s.common.loader.all" . }}
56 changes: 56 additions & 0 deletions charts/memos/values.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
#
# IMPORTANT NOTE
#
# This chart inherits from our common library chart. You can check the default values/options here:
# https://github.com/bjw-s/helm-charts/blob/main/charts/library/common/values.yaml
#

image:
# -- image repository
repository: neosmemo/memos
# -- image pull policy
pullPolicy: IfNotPresent
# -- image tag
tag: 0.11.2

# -- Configures service settings for the chart.
# @default -- See [values.yaml](./values.yaml)
service:
main:
ports:
http:
port: 5230

ingress:
# -- Enable and configure ingress settings for the chart under this key.
# @default -- See [values.yaml](./values.yaml)
main:
enabled: false
# hosts:
# - host: chart-example.local
# paths:
# - path: /
# tls:
# - secretName: chart-example.local
# hosts:
# - chart-example.local
# @ignored

# -- Configure persistence settings for the chart under this key.
# @default -- See [values.yaml](./values.yaml)
persistence:
data:
enabled: false
mountPath: /var/opt/memos
retain: true
# storageClass: ""
# accessMode: ReadWriteOnce
# size: 1Gi

podSecurityContext:
# -- Run as `nobody` user
runAsUser: 65534
# -- Run as `nobody` group
runAsGroup: 65534
# -- Volume binds will be granted to `nobody` group
fsGroup: 65534

0 comments on commit 37837f2

Please sign in to comment.