Addison McDermid
9813cb45a2
Merge changes **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. --> Moving ByteStash chart to Stable Train after a successful deployment to a test cluster. ⚒️ 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 - [ ] 📜 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 --> Deployed to test cluster and confirmed chart deployed successfully, webpage loaded successfully and persistence working after restarts of the container. **📃 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 - [ ] #️⃣ I have commented my code, particularly in hard-to-understand areas - [ ] 📄 I have made changes to the documentation - [x] 🧪 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. - [ ] 🖼️ 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: Alfred Göppel <43101280+alfi0812@users.noreply.github.com> Co-authored-by: Alfred Göppel <43101280+alfi0812@users.noreply.github.com>
1.7 KiB
1.7 KiB
title
| 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 /bytestash for a domain such as my.domain/bytestash, leave blank in every other caseTOKEN_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 disabledDISABLE_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-onOIDC_ISSUER_URL: Enter the OIDC issuer URL, e.g. https://authentik.mydomain.com/application/o/bytestash/ for authentikOIDC_CLIENT_ID: Enter the OIDC client ID, the SSO app provider will provide thisOIDC_CLIENT_SECRET: Enter the OIDC client secret, the SSO app provider will provide thisOIDC_SCOPES: The OIDC scopes to request, e.g. "openid profile email groups"