Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

wip: documentation and config for using websocket #32

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

wip: documentation and config for using websocket #32

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion charts/directus/Chart.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ type: application
# This is the chart version. This version number should be incremented each time you make changes
# to the chart and its templates, including the app version.
# Versions are expected to follow Semantic Versioning (https://semver.org/)
version: 0.7.22
version: 0.7.23

# This is the version number of the application being deployed. They should reflect the version
# the application is using.
Expand Down
16 changes: 15 additions & 1 deletion charts/directus/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ This Helm chart installs [Directus](https://directus.io/), a real-time API, and

## Un-official

Please note, this is an un-official Helm chart from Digitalist.
Please note, this is an un-official Helm chart from [Digitalist](https://www.digitalist.se/).

## License

Expand All @@ -21,6 +21,20 @@ We strive to make the installation of Directus as easy as possible, but there ar

We recommend that you either override the default values file from the repository or set your keys using `--set`.

### Websockets

If you are using websockets with Directus, and using ingress-nginx, websockets are supported by default. But you should set these annotations (if you are not doing it in [config](https://kubernetes.github.io/ingress-nginx/user-guide/nginx-configuration/configmap/#proxy-read-timeout)), otherwise, connection will be closed after default time, 60 seconds, which is not what you want if you are using websockets. Recommended is to set timeouts to at least on hour (3600 seconds).

```yaml
ingress:
enabled: true
annotations:
nginx.ingress.kubernetes.io/proxy-read-timeout: "3600"
nginx.ingress.kubernetes.io/proxy-send-timeout: "3600"
```

If you are using another type of ingress, please refer to that ingress documentation for setup.

### File storage

By default, no persistance storage is set, in general, you are recommended to use [External File Storage](README.md#external-file-storage).
Expand Down