Skip to content

Commit

Permalink
charts/sharry/README.md: adjust URLs and commands after forking
Browse files Browse the repository at this point in the history
  • Loading branch information
johanneskastl committed Oct 26, 2024
1 parent 62ff1d9 commit 53ee300
Showing 1 changed file with 12 additions and 20 deletions.
32 changes: 12 additions & 20 deletions charts/sharry/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@

Sharry allows to share files with others in a simple way. It is a self-hosted web application. The basic concept is to upload files and get a url back that can then be shared.

**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)**
Forked from the chart in the [k8s-at-home repository](https://github.com/k8s-at-home/charts) at version 5.4.2.

**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/johanneskastl/helm-charts/issues/)**

## Source Code

Expand All @@ -17,22 +19,22 @@ Sharry allows to share files with others in a simple way. It is a self-hosted we

| Repository | Name | Version |
|------------|------|---------|
| https://library-charts.k8s-at-home.com | common | 4.5.2 |
| https://johanneskastl.github.io/helm-charts/ | common | 5.0.5 |

## TL;DR

```console
helm repo add k8s-at-home https://k8s-at-home.com/charts/
helm repo add johanneskastl-helm-charts https://johanneskastl.github.io/helm-charts/
helm repo update
helm install sharry k8s-at-home/sharry
helm install sharry johanneskastl-helm-charts/sharry
```

## Installing the Chart

To install the chart with the release name `sharry`

```console
helm install sharry k8s-at-home/sharry
helm install sharry johanneskastl-helm-charts/sharry
```

## Uninstalling the Chart
Expand All @@ -48,20 +50,20 @@ The command removes all the Kubernetes components associated with the chart **in
## Configuration

Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values.
Other values may be used from the [values.yaml](https://github.com/k8s-at-home/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).
Other values may be used from the [values.yaml](https://github.com/johanneskastl/helm-charts/tree/main/charts/common/values.yaml) from the [common library](https://github.com/johanneskastl/helm-charts/tree/main/charts/common).

Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.

```console
helm install sharry \
--set env.TZ="America/New York" \
k8s-at-home/sharry
johanneskastl-helm-charts/sharry
```

Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.

```console
helm install sharry k8s-at-home/sharry -f values.yaml
helm install sharry johanneskastl-helm-charts/sharry -f values.yaml
```

## Custom configuration
Expand All @@ -70,7 +72,7 @@ N/A

## Values

**Important**: When deploying an application Helm chart you can add more values from our common library chart [here](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common)
**Important**: When deploying an application Helm chart you can add more values from the common library chart [here](https://github.com/johanneskastl/helm-charts/tree/main/charts/common)

| Key | Type | Default | Description |
|-----|------|---------|-------------|
Expand Down Expand Up @@ -103,16 +105,6 @@ N/A

N/A

### Older versions

A historical overview of changes can be found on [ArtifactHUB](https://artifacthub.io/packages/helm/k8s-at-home/sharry?modal=changelog)

## Support

- See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/)
- Open an [issue](https://github.com/k8s-at-home/charts/issues/new/choose)
- Ask a [question](https://github.com/k8s-at-home/organization/discussions)
- Join our [Discord](https://discord.gg/sTMX7Vh) community

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v0.1.1](https://github.com/k8s-at-home/helm-docs/releases/v0.1.1)
Open an [issue](https://github.com/johanneskastl/helm-charts/issues/).

0 comments on commit 53ee300

Please sign in to comment.