2022-07-22 16:52:13 -04:00
# kiwix-serve
2022-09-23 01:53:47 -04:00
Kiwix enables you to have the whole Wikipedia at hand wherever you go!
2022-07-22 16:52:13 -04:00
TrueCharts can be installed as both *normal* Helm Charts or as Apps on TrueNAS SCALE.
This readme is just an automatically generated general guide on installing our Helm Charts and Apps.
2022-09-23 01:53:47 -04:00
For more information, please click here: [kiwix-serve ](https://truecharts.org/docs/charts/stable/kiwix-serve )
2022-07-22 16:52:13 -04:00
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here ](https://github.com/truecharts/charts/issues/new/choose )**
## Source Code
2022-09-23 01:53:47 -04:00
* < https: // github . com / truecharts / charts / tree / master / charts / stable / kiwix-serve >
2022-07-22 16:52:13 -04:00
* < https: // www . kiwix . org />
* < https: // hub . docker . com / r / kiwix / kiwix-serve />
2022-09-23 01:53:47 -04:00
* < https: // github . com / kiwix / kiwix-tools / blob / master / docker / server >
2022-07-22 16:52:13 -04:00
## Requirements
Kubernetes: `>=1.16.0-0`
## Dependencies
| Repository | Name | Version |
|------------|------|---------|
2022-10-19 09:55:38 -04:00
| https://library-charts.truecharts.org | common | 10.7.1 |
2022-07-22 16:52:13 -04:00
## Installing the Chart
### TrueNAS SCALE
2022-09-22 10:28:16 -04:00
To install this Chart on TrueNAS SCALE check our [Quick-Start Guide ](https://truecharts.org/docs/manual/SCALE%20Apps/Installing-an-App ).
2022-07-22 16:52:13 -04:00
### Helm
To install the chart with the release name `kiwix-serve`
```console
2022-08-08 19:15:26 -04:00
helm repo add TrueCharts https://charts.truecharts.org
2022-07-22 16:52:13 -04:00
helm repo update
helm install kiwix-serve TrueCharts/kiwix-serve
```
## Uninstall
### TrueNAS SCALE
**Upgrading, Rolling Back and Uninstalling the Chart**
2022-09-22 10:28:16 -04:00
To upgrade, rollback or delete this Chart from TrueNAS SCALE check our [Quick-Start Guide ](https://truecharts.org/docs/manual/SCALE%20Apps/Upgrade-rollback-delete-an-App ).
2022-07-22 16:52:13 -04:00
### Helm
To uninstall the `kiwix-serve` deployment
```console
helm uninstall kiwix-serve
```
## Configuration
### Helm
#### Available Settings
2022-09-10 06:22:01 -04:00
Read through the values.yaml file. It has several commented out suggested values.
2022-07-22 16:52:13 -04:00
Other values may be used from the [values.yaml ](https://github.com/truecharts/library-charts/tree/main/charts/stable/common/values.yaml ) from the [common library ](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common ).
2022-08-08 19:15:26 -04:00
#### Configure using the command line
2022-07-22 16:52:13 -04:00
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install` .
```console
helm install kiwix-serve \
--set env.TZ="America/New York" \
TrueCharts/kiwix-serve
```
#### Configure using a yaml file
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
```console
helm install kiwix-serve TrueCharts/kiwix-serve -f values.yaml
```
2022-08-08 19:15:26 -04:00
#### Connecting to other charts
2022-07-22 16:52:13 -04:00
2022-09-22 10:28:16 -04:00
If you need to connect this Chart to other Charts on TrueNAS SCALE, please refer to our [Linking Charts Internally ](https://truecharts.org/docs/manual/SCALE%20Apps/linking-apps ) quick-start guide.
2022-07-22 16:52:13 -04:00
## Support
2022-09-22 10:28:16 -04:00
- Please check our [quick-start guides for TrueNAS SCALE ](https://truecharts.org/docs/manual/SCALE%20Apps/Important-MUST-READ ).
2022-07-22 16:52:13 -04:00
- See the [Website ](https://truecharts.org )
- Check our [Discord ](https://discord.gg/tVsPTHWTtr )
- Open a [issue ](https://github.com/truecharts/apps/issues/new/choose )
---
## Sponsor TrueCharts
TrueCharts can only exist due to the incredible effort of our staff.
2022-09-22 10:28:16 -04:00
Please consider making a [donation ](https://truecharts.org/sponsor ) or contributing back to the project any way you can!
2022-07-22 16:52:13 -04:00
---
All Rights Reserved - The TrueCharts Project