Skip to content

Commit

Permalink
Add information about IsStartupWizardCompleted to fix security issue
Browse files Browse the repository at this point in the history
  • Loading branch information
drinkataco committed Apr 6, 2024
1 parent 0f02923 commit 13080ad
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 22 deletions.
20 changes: 8 additions & 12 deletions charts/jellyfin/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,8 @@ application:
- filename: 'system.xml'
contents: |
# We could add <EnableMetrics>true</EnableMetrics> to enable prometheus metrics
# It is recommended to add <IsStartupWizardCompleted>true</IsStartupWizardCompleted> to
# prevent the wizard running again after initial setup.
...
mountPath: '/config/config/system.xml'
- filename: 'encoding.xml'
Expand All @@ -79,7 +81,7 @@ The following volumes are available by default:
- **ebooks** - Location of ebooks
- **film** - Location of movies
- **music** - Location of music
- **telivion** - Location of TV shows
- **television** - Location of TV shows
```yaml
deployment:
Expand All @@ -92,7 +94,9 @@ deployment:
nfs:
server: 'fileserver.local'
path: '/srv/media/ebooks/'

film:
music:
television:
```
By default, a PersistentVolumeClaim will be provisioned for the `config`, but `emptyDir: {}` will be used for downloads and film - but it is recommended enable some type of PVC and PV!
Expand Down Expand Up @@ -126,17 +130,9 @@ ingress:

### Metrics

Enabling metrics enables a sidecar container being attached for [exportarr](https://github.com/onedr0p/exportarr/) - and a ServiceMonitor CRD to be consumed by the [kube-prometheus](https://github.com/prometheus-operator/kube-prometheus) package.
Prometheus metrics are enabled by placing `<EnableMetrics>true</EnableMetrics>` in System.xml.

```yaml
metrics:
enabled: true
env: []
```
It is recommended to install [kube-prometheus chart](https://github.com/prometheus-community/helm-charts/tree/main/charts/kube-prometheus-stack) first for the CRD to be supported. It is not included as a dependency by default in this package!
Unless changed with `metrics.port.number` you can then consume metrics over port `9702`.
Read more about this functionality in the [official documentation](https://jellyfin.org/docs/general/networking/monitoring/)

### Advanced

Expand Down
22 changes: 12 additions & 10 deletions charts/jellyfin/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -25,16 +25,18 @@ application:
</NetworkConfiguration>
mountPath: '/config/config/network.xml'
# System Options
- filename: 'system.xml'
contents: |
<?xml version="1.0" encoding="utf-8"?>
<ServerConfiguration xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<EnableMetrics>true</EnableMetrics>
<PreferredMetadataLanguage>en</PreferredMetadataLanguage>
<MetadataCountryCode>GB</MetadataCountryCode>
<UICulture>en-GB</UICulture>
</ServerConfiguration>
mountPath: '/config/config/system.xml'
# - filename: 'system.xml'
# contents: |
# <?xml version="1.0" encoding="utf-8"?>
# <ServerConfiguration xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
# <EnableMetrics>true</EnableMetrics>
# <PreferredMetadataLanguage>en</PreferredMetadataLanguage>
# <MetadataCountryCode>GB</MetadataCountryCode>
# <UICulture>en-GB</UICulture>
# <!-- Change me to false to run the setup wizard, but make sure you keep it true!! -->
# <IsStartupWizardCompleted>true</IsStartupWizardCompleted>
# </ServerConfiguration>
# mountPath: '/config/config/system.xml'

#
# Resource - DEPLOYMENT
Expand Down

0 comments on commit 13080ad

Please sign in to comment.