fix(romm) update romm to support v3.x (#28822)

**Description**
Updated the docs, env variables and removed outdated variables.

Auth is required but the variables for it was removed....setup the admin
user from the web gui.
 
Redis is no longer experimental....romm does have a internal redis
server built in but after looking over the code....an external redis can
still be used so leaving redis bits untouched.
 
⚒️ Fixes  # <!--(issue)-->

**⚙️ Type of change**

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

**🧪 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
-->

**📃 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 corresponding changes to the documentation
- [ ] ⚠️ My changes generate no new warnings
- [ ] 🧪 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):` or `chore(chart-name):`

** 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._
This commit is contained in:
Xstar97TheNoob
2024-11-04 23:44:51 -05:00
committed by GitHub
parent a18c38fe96
commit b0b105c4a3
3 changed files with 61 additions and 18 deletions
+1 -1
View File
@@ -47,4 +47,4 @@ sources:
- https://github.com/truecharts/charts/tree/master/charts/stable/romm
- https://github.com/zurdi15/romm
type: application
version: 10.11.3
version: 10.12.0
+10 -2
View File
@@ -2,8 +2,16 @@
title: Installation Notes
---
Set Client Id and Client Secret with the API key from [IGDB](https://api-docs.igdb.com/#about)
SteamGridDB API Key is WIP and can be optionally set.
Set the `IGDB_CLIENT_ID` and `IGDB_CLIENT_SECRET` with the API key from [IGDB](https://api-docs.igdb.com/#about).
## Optional API
`STEAMGRIDDB_API_KEY` and/or `MOBYGAMES_API_KEY` API Key can be optionally set for additional metadata.
MobyGames API is no longer free.
## Rom Library Structure
This app has two folder structures found [here](https://github.com/zurdi15/romm/blob/master/README.md#-folder-structure).
+50 -15
View File
@@ -18,11 +18,6 @@ service:
targetPort: 8080
port: 10680
romm:
auth:
user: "admin"
pass: "admin"
workload:
main:
podSpec:
@@ -36,13 +31,57 @@ workload:
startup:
type: http
env:
# dont touch!
ROMM_BASE_PATH: /romm
ROMM_DB_DRIVER: mariadb
# IGDB client id
CLIENT_ID: ""
# IGDB client secret
CLIENT_SECRET: ""
STEAMGRIDDB_API_KEY: ""
ROMM_HOST: localhost
# IGDB client id and secret (not required but recommended to set)
IGDB_CLIENT_ID: ""
IGDB_CLIENT_SECRET: ""
# optional api
# STEAMGRIDDB_API_KEY: ""
# paid API only (optional)
# MOBYGAMES_API_KEY: ""
# Disables playing in browser with EmulatorJS (builtin)
# DISABLE_EMULATOR_JS: false
# Disables playing flash games with RuffleRS (builtin)
# DISABLE_RUFFLE_RS: false
# Disables CSRF protection (not recommended)
# DISABLE_CSRF_PROTECTION: false
# Disable auth on download endpoint (WebRcade, Tinfoil)
# DISABLE_DOWNLOAD_ENDPOINT_AUTH: false
# Timeout for the background scan/rescan tasks (in seconds)
# SCAN_TIMEOUT: 14400
# Enable rescanning of library when filesystem changes
# ENABLE_RESCAN_ON_FILESYSTEM_CHANGE: false
# Delay in minutes before rescanning library when filesystem changes
# RESCAN_ON_FILESYSTEM_CHANGE_DELAY: 5
# Cron expression for scheduled rescanning
# SCHEDULED_RESCAN_CRON: "0 3 * * *"
# Enable scheduled updating of Switch TitleDB index
# ENABLE_SCHEDULED_UPDATE_SWITCH_TITLEDB: false
# Cron expression for scheduled updating of Switch TitleDB
# SCHEDULED_UPDATE_SWITCH_TITLEDB_CRON: "0 4 * * *"
# Enable scheduled updating of MAME XML index
# ENABLE_SCHEDULED_UPDATE_MAME_XML: false
# Cron expression for scheduled updating of MAME XML
# SCHEDULED_UPDATE_MAME_XML_CRON: "0 5 * * *"
DB_PORT: 3306
DB_NAME: "{{ .Values.mariadb.mariadbDatabase }}"
DB_USER: "{{ .Values.mariadb.mariadbUsername }}"
@@ -63,10 +102,6 @@ workload:
secretKeyRef:
name: romm-secrets
key: ROMM_AUTH_SECRET_KEY
ROMM_AUTH_ENABLED: true
ENABLE_EXPERIMENTAL_REDIS: true
ROMM_AUTH_USERNAME: "{{ .Values.romm.auth.user}}"
ROMM_AUTH_PASSWORD: "{{ .Values.romm.auth.pass}}"
persistence:
library: