Skip to content

Commit

Permalink
fix: doc improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
ilyannn committed Jan 5, 2024
1 parent 5e572b8 commit 4a9ab3b
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 5 deletions.
38 changes: 34 additions & 4 deletions langfuse/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,17 +12,47 @@ helm install langfuse-demo https://github.com/ilyannn/charts/releases/download/l

### Default Installation

With the default values, Langfuse will be installed with the bundled Postgres.
The password will be generated and saved in a secret (in this case, `langfuse-demo-postgres-secret`)
By default, Langfuse will be installed with the bundled Postgres.

The password will be generated and saved in a `Secret` (in this case, `langfuse-demo-postgres-secret`).

### Connecting existing Postgres instance

You can pass the exising connection URL.
### OAuth

### Using Existing Database Connection

Disable the bundled database and pass an exising connection URL instead.

```yaml
databaseURL: "postgresql://some-existing-url"

postgresql:
enabled: false
```
### Accessing the installation
The chart comes with an ingress that can be set up with
```yaml
ingress:
enabled: true
hosts: ...
```
### Uninstalling
The usual `helm uninstall RELEASE_NAME` should work, but note that the following objects are not deleted automatically:

- the data PVC of the `postgres` subchart (if the subchart was enabled)
- the `-postgres-secret` secret (unless `postgresql.secret.alwaysKeepWhenUninstalled` is unset)

This means that you can reinstall the chart and continue accessing the same data.


### Example values

See [megaver.se demo](https://docs.cluster.megaver.se/cluster/langfuse-demo-values.yaml)
2 changes: 1 addition & 1 deletion langfuse/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ postgresql:
# Set this to false if you want the secret to be deleted with `helm delete`
# This has no effect unless createIfMissing is also true.
# Warning: reinstalling the chart will generate a new password, but Postgres will
# continue to use an old password since it's stored on the the PVC.
# continue to use an old password since it's stored on the PVC.
alwaysKeepWhenUninstalled: true


Expand Down

0 comments on commit 4a9ab3b

Please sign in to comment.