Skip to content

Commit

Permalink
update readme for the github.io doc page
Browse files Browse the repository at this point in the history
  • Loading branch information
jessebot committed Mar 27, 2024
1 parent 9ef0910 commit 948f997
Showing 1 changed file with 60 additions and 2 deletions.
62 changes: 60 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# coturn Helm Chart
<a href="https://github.com/jessebot/coturn-chart/releases"><img src="https://img.shields.io/github/v/release/jessebot/coturn-chart?style=plastic&labelColor=blue&color=green&logo=GitHub&logoColor=white"></a>
<a href="https://github.com/small-hack/coturn-chart/releases"><img src="https://img.shields.io/github/v/release/small-hack/coturn-chart?style=plastic&labelColor=blue&color=green&logo=GitHub&logoColor=white"></a>

An unofficial [coturn](https://github.com/coturn/coturn) helm chart using the official [coturn docker image](https://hub.docker.com/r/coturn/coturn).

Expand All @@ -22,7 +22,7 @@ An unofficial [coturn](https://github.com/coturn/coturn) helm chart using the of
Note that you still need to fill out the [`charts/coturn/values.yaml`](./charts/coturn/values.yaml) (Autogenerated Docs can be found in [`charts/coturn/README.md`](./charts/coturn/README.md)).

```console
helm repo add coturn https://jessebot.github.io/coturn-chart/
helm repo add coturn https://small-hack.github.io/coturn-chart/
helm install coturn coturn/coturn --values values.yaml
```

Expand Down Expand Up @@ -143,6 +143,64 @@ postgresql:
enabled: false
```

### Bundled MySQL subchart
We provide optional Bitnami MySQL subchart to deploy an external database. You can use it like this:

```yaml
mysql:
enabled: true
auth:
# -- username for database, ignored if existingSecret is passed in
username: "coturn"
# -- password for db, autogenerated if empty & existingSecret empty
password: "mycoolpasswordthatisplaintextforsomereason"
# -- database to create, ignored if existingSecret is passed in
database: "coturn"
# -- Use existing secret for password details.
# The secret has to contain the keys mysql-root-password, mysql-replication-password and mysql-password
existingSecret: ""
# Names of the keys in existing secret to use for MySQL credentials
secretKeys:
# -- key in exsiting Secret to use for the coturn user
username: "username"
# -- key in existing Secret to use for coturn user's password
password: "password"
```

You're free to use any other values you find in the [Bitnami mysql helm values](https://github.com/bitnami/charts/tree/main/bitnami/mysql) under the `mysql` parameter in your values.yaml for coturn.

### External MySQL database
If `externalDatabase.enabled` is set to `true`, and `mysql.enabled` is set to false, you can pass in credentials from an existing mysql database, like this:

```yaml
externalDatabse:
enabled: true
# -- Currently postgresql and mysql are supported.
type: "mysql"
# -- required if externalDatabase.enabled: true and mysql.enabled: false
hostname: "mysqlserver"
# -- username for database, ignored if existingSecret is passed in
username: "coturn"
# -- password for database, ignored if existingSecret is passed in
password: "coolpasswordfordogs"
# -- database to create, ignored if existingSecret is passed in
database: "coturn"
# -- name of existing Secret to use for mysql credentials
existingSecret: ""
# Names of the keys in existing secret to use for MySQL credentials
secretKeys:
# -- key in existing Secret to use for the db user
username: ""
# -- key in existing Secret to use for db user's password
password: ""
# -- key in existing Secret to use for the database name
database: ""
# -- key in existing Secret to use for the db's hostname
hostname: ""
mysql:
enabled: false
```

## Testing

Source: [Tutorial for turnutils_uclient and Coturn server](https://gist.github.com/cameronelliott/be1e581cb7b28f748e04bcabc249e6b6)
Expand Down

0 comments on commit 948f997

Please sign in to comment.