Skip to content

Commit 5ba6ccf

Browse files
authored
Update README.md
1 parent 1850fa8 commit 5ba6ccf

File tree

1 file changed

+17
-6
lines changed

1 file changed

+17
-6
lines changed

README.md

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<div align="center">
2-
<a href="https://opc-router.com/?utm_source=GitHub&utm_medium=DockerSample&utm_campaign=OpcUaUmatiMssqlGrafana">
2+
<a href="https://opc-router.com/?utm_source=GitHub&utm_medium=HelmChart&utm_campaign=OpcRouterChart">
33
<img src="img/opc_router_logo.png" alt="Logo" >
44
</a>
55
<br />
@@ -56,16 +56,27 @@
5656
- Helm 3.1.0
5757

5858
## **Installation**
59+
[Helm](https://helm.sh) must be installed to use the charts. Please refer to
60+
Helm's [documentation](https://helm.sh/docs) to get started.
61+
62+
Once Helm has been set up correctly, add the repo as follows:
63+
```shell
64+
helm repo add opc-router https://opc-router.github.io/helm-charts
65+
```
66+
If you had already added this repo earlier, run `helm repo update` to retrieve
67+
the latest versions of the packages. You can then run `helm search repo
68+
<alias>` to see the charts.
69+
5970
To install the chart with the name `my-opcrouter`:
6071
```shell
61-
$ helm install my-opcrouter <Hier Pfad einfügen> \
72+
helm install my-opcrouter opc-router/opc-router \
6273
--set I_do_accept_the_EULA=true
6374
```
6475
This command will install the opc router with standard settings, as a service with a seperate mongodb container. The mongodb won't require authentification, which is not recommended. Accepting the [End User License Agreement](https://www.opc-router.com/terms-of-use-and-eula/) by setting `I_do_accept_the_EULA` to true is required for the OPCRouter to run.
6576

6677
To deploy this chart with password authetification use this command:
6778
```shell
68-
$ helm install my-opcrouter <Hier Pfad einfügen> \
79+
helm install my-opcrouter opc-router/opc-router \
6980
--set mongodb.auth.enabled=true \
7081
--set mongodb.auth.rootPassword=<Your desired root password> \
7182
--set mongodb.auth.replicaSetKey=<Your desired replicaset key> \
@@ -76,7 +87,7 @@ Keep in mind that the root password and replicaset key can't be changed once set
7687
## **Uninstalling**
7788
The chart with the name `my-opcrouter` can simply be uninstalled by executing:
7889
```shell
79-
$ helm uninstall my-opcrouter
90+
helm uninstall my-opcrouter
8091
```
8192
However, keep in mind that the persitant volumes of the mongodb container don't get deleted by this. When reinstalling the chart under the same name you will have to use the previous mongodb root password and replica set key or delete the persistant volume beforehand.
8293

@@ -161,9 +172,9 @@ envVars:
161172
```
162173
A helm install command can also be issued with specifiying multiple environment variables:
163174
```shell
164-
$ helm install my-opcrouter <Hier Pfad einfügen> \
175+
$ helm install my-opcrouter opc-router/opc-router \
165176
--set envVars[0].TESTVAR="successful" \
166177
--set envVars[1].OtherVariable=42 \
167178
--set envVars[2].yetAnotherVar=false \
168179
--set I_do_accept_the_EULA=true
169-
```
180+
```

0 commit comments

Comments
 (0)