Skip to content

Commit

Permalink
chore(docs): 📝 add real URLs and names in READMEs (#38)
Browse files Browse the repository at this point in the history
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
  • Loading branch information
Supporterino and github-actions[bot] authored Nov 6, 2024
1 parent 0defe76 commit 0e94b42
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 11 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ hellyfin-helm/
To use the charts in this repository, first add the repository to Helm:

```bash
helm repo add jellyfin https://<your-repo-url>.git
helm repo add jellyfin https://jellyfin.github.io/jellyfin-helm
helm repo update
```

Expand Down
10 changes: 5 additions & 5 deletions charts/jellyfin/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,23 +13,23 @@ Jellyfin Media Server
Helm repositories contain collections of charts. You can add an existing repository using the following command:

```bash
helm repo add <repo-name> <repo-url>
helm repo add jellyfin https://jellyfin.github.io/jellyfin-helm
```

### 2. Install the Helm Chart

To install a chart, use the following command:

```bash
helm install <release-name> <repo-name>/jellyfin
helm install my-jellyfin jellyfin/jellyfin
```

### 3. View the Installation

You can check the status of the release using:

```bash
helm status <release-name>
helm status my-jellyfin
```

## Customizing the Chart
Expand All @@ -38,14 +38,14 @@ Helm charts come with default values, but you can customize them by using the --

### 1. Using --set to Override Values
```bash
helm install <release-name> <chart-name> --set key1=value1,key2=value2
helm install my-jellyfin jellyfin/jellyfin --set key1=value1,key2=value2
```

### 2. Using a values.yaml File
You can create a custom values.yaml file and pass it to the install command:

```bash
helm install <release-name> <chart-name> -f values.yaml
helm install my-jellyfin jellyfin/jellyfin -f values.yaml
```

## Values
Expand Down
10 changes: 5 additions & 5 deletions charts/jellyfin/README.md.gotmpl
Original file line number Diff line number Diff line change
Expand Up @@ -14,23 +14,23 @@
Helm repositories contain collections of charts. You can add an existing repository using the following command:

```bash
helm repo add <repo-name> <repo-url>
helm repo add jellyfin https://jellyfin.github.io/jellyfin-helm
```

### 2. Install the Helm Chart

To install a chart, use the following command:

```bash
helm install <release-name> <repo-name>/jellyfin
helm install my-jellyfin jellyfin/jellyfin
```

### 3. View the Installation

You can check the status of the release using:

```bash
helm status <release-name>
helm status my-jellyfin
```

## Customizing the Chart
Expand All @@ -39,14 +39,14 @@ Helm charts come with default values, but you can customize them by using the --

### 1. Using --set to Override Values
```bash
helm install <release-name> <chart-name> --set key1=value1,key2=value2
helm install my-jellyfin jellyfin/jellyfin --set key1=value1,key2=value2
```

### 2. Using a values.yaml File
You can create a custom values.yaml file and pass it to the install command:

```bash
helm install <release-name> <chart-name> -f values.yaml
helm install my-jellyfin jellyfin/jellyfin -f values.yaml
```

{{ template "chart.maintainersSection" . }}
Expand Down

0 comments on commit 0e94b42

Please sign in to comment.