Skip to content

Commit

Permalink
feat(bytestash) Add new Chart (#32975)
Browse files Browse the repository at this point in the history
**Description**
<!--
Please include a summary of the change and which issue is fixed. Please
also include relevant motivation and context. List any dependencies that
are required for this change.
-->
Deploy new chart Bytestash
⚒️ Fixes  # <!--(issue)-->

**⚙️ Type of change**

- [x] ⚙️ Feature/App addition
- [ ] 🪛 Bugfix
- [ ] ⚠️ Breaking change (fix or feature that would cause existing
functionality to not work as expected)
- [ ] 🔃 Refactor of current code
- [x] 📜 Documentation Changes

**🧪 How Has This Been Tested?**
<!--
Please describe the tests that you ran to verify your changes. Provide
instructions so we can reproduce. Please also list any relevant details
for your test configuration
-->
This has been tested using app-template.
Pending test deployment from incubator train once PR is approved.

**📃 Notes:**
<!-- Please enter any other relevant information here -->

**✔️ Checklist:**

- [x] ⚖️ My code follows the style guidelines of this project
- [x] 👀 I have performed a self-review of my own code
- [x] #️⃣ I have commented my code, particularly in hard-to-understand
areas
- [x] 📄 I have made changes to the documentation
- [ ] 🧪 I have added tests to this description that prove my fix is
effective or that my feature works
- [x] ⬆️ I increased versions for any altered app according to semantic
versioning
- [x] I made sure the title starts with `feat(chart-name):`,
`fix(chart-name):`, `chore(chart-name):`, `docs(chart-name):` or
`fix(docs):`

**➕ App addition**

If this PR is an app addition please make sure you have done the
following.

- [x] 🖼️ I have added an icon in the Chart's root directory called
`icon.png`

---

_Please don't blindly check all the boxes. Read them and only check
those that apply.
Those checkboxes are there for the reviewer to see what is this all
about and
the status of this PR with a quick glance._

---------

Signed-off-by: Addison McDermid <admin@itconstruct.com.au>
Co-authored-by: alfi0812 <admin@alfi0812.de>
  • Loading branch information
itconstruct and alfi0812 authored Mar 7, 2025
1 parent 401286e commit 2cf51e0
Show file tree
Hide file tree
Showing 9 changed files with 143 additions and 0 deletions.
32 changes: 32 additions & 0 deletions charts/incubator/bytestash/.helmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# 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
*~
# Various IDEs
.project
.idea/
*.tmproj
.vscode/
# OWNERS file for Kubernetes
OWNERS
# helm-docs templates
*.gotmpl
# docs folder
/docs
# icon
icon.png
icon.webp
icon-small.webp
4 changes: 4 additions & 0 deletions charts/incubator/bytestash/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: Changelog
pagefind: false
---
37 changes: 37 additions & 0 deletions charts/incubator/bytestash/Chart.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
annotations:
max_scale_version: 24.04.1
min_scale_version: 24.04.0
truecharts.org/category: Productivity
truecharts.org/max_helm_version: "3.15"
truecharts.org/min_helm_version: "3.11"
truecharts.org/train: incubator
apiVersion: v2
appVersion: 1.5.7
dependencies:
- name: common
version: 25.4.10
repository: oci://tccr.io/truecharts
condition: ""
alias: ""
tags: []
import-values: []
deprecated: false
description: ByteStash is a self-hosted web application designed to store, organise, and manage your code snippets efficiently. With support for creating, editing, and filtering snippets, ByteStash helps you keep track of your code in one secure place.
home: https://truecharts.org/charts/incubator/bytestash
icon: https://truecharts.org/img/hotlink-ok/chart-icons/bytestash.webp
keywords:
- bytestash
- Productivity
- Tools-Utilities
- code
kubeVersion: '>=1.24.0-0'
maintainers:
- name: TrueCharts
email: info@truecharts.org
url: https://truecharts.org
name: bytestash
sources:
- https://github.com/jordan-dalby/ByteStash
- https://github.com/truecharts/charts/tree/master/charts/incubator/bytestash
type: application
version: 0.0.1
3 changes: 3 additions & 0 deletions charts/incubator/bytestash/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
title: README
---
29 changes: 29 additions & 0 deletions charts/incubator/bytestash/docs/How-To-Guide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
title: How-To
---

This is a quick how-to or setup-guide to use Bytestash on Talos.

## App Configuration

### Required Environment Settings:
The following must be specified and updated in your Helm Release file.
- `JWT_SECRET`: Provide a unique secret for the JSON Web Token

### Optional Environment Settings:
The following may be left at the default setting, OR you may override in your Helm Release file dependent on your requirements.
- `BASE_PATH`: write /bIytestash for a domain such as my.domain/bytestash, leave blank in every other case
- `TOKEN_EXPIRY`: How long the token lasts Default is 24 hrs.
- `ALLOW_NEW_ACCOUNTS`: Will the instance allow new new accounts to be created. The Default is to allow new account creation.
- `DEBUG`: Enable to turn on logging, in most instances leave disabled
- `DISABLE_ACCOUNTS`: Disable the use of any accounts, export snippets first if enabling on an existing instance, as it will be like starting with a fresh instance. Default is false.
- `DISABLE_INTERNAL_ACCOUNTS`: Disable the use of internal accounts. Default is false.

### OIDC Single Sign On
Setting up the OIDC section will allow you to enable Single Sign On (SSO).
- `OIDC_ENABLED`: Set this to true to enable SSO. The default is for SSO - OIDC to be disabled.
- `OIDC_DISPLAY_NAME`: Enter the Display Name for users signing in with SSO, the default is set to Single Sign-on
- `OIDC_ISSUER_URL`: Enter the OIDC issuer URL, e.g. https://authentik.mydomain.com/application/o/bytestash/ for authentik
- `OIDC_CLIENT_ID`: Enter the OIDC client ID, the SSO app provider will provide this
- `OIDC_CLIENT_SECRET`: Enter the OIDC client secret, the SSO app provider will provide this
- `OIDC_SCOPES`: The OIDC scopes to request, e.g. "openid profile email groups"
Binary file added charts/incubator/bytestash/icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions charts/incubator/bytestash/templates/NOTES.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{{- include "tc.v1.common.lib.chart.notes" $ -}}
1 change: 1 addition & 0 deletions charts/incubator/bytestash/templates/common.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{{ include "tc.v1.common.loader.all" . }}
36 changes: 36 additions & 0 deletions charts/incubator/bytestash/values.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
image:
repository: ghcr.io/jordan-dalby/bytestash
tag: 1.5.7@sha256:fa58bbc2fc5864ea600b92bb9d95a443d49fc92c6a9c7143fc4c1df8f45c4505
pullPolicy: IfNotPresent
service:
main:
ports:
main:
port: 5000
protocol: http
persistence:
data:
enabled: true
mountPath: "/data/snippets"
portal:
open:
enabled: true
workload:
main:
podSpec:
containers:
main:
env:
BASE_PATH: ""
JWT_SECRET: "bytestash JWT secret"
TOKEN_EXPIRY: "24h"
ALLOW_NEW_ACCOUNTS: "false"
DEBUG: "false"
DISABLE_ACCOUNTS: "false"
DISABLE_INTERNAL_ACCOUNTS: "false"
OIDC_ENABLED: "false"
OIDC_DISPLAY_NAME: ""
OIDC_ISSUER_URL: ""
OIDC_CLIENT_ID: ""
OIDC_CLIENT_SECRET: ""
OIDC_SCOPES: ""

0 comments on commit 2cf51e0

Please sign in to comment.