matrix-org / matrix-hookshot

A bridge between Matrix and multiple project management services, such as GitHub, GitLab and JIRA.

Home Page:https://matrix-org.github.io/matrix-hookshot/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Is /data really a data directory?

djmaze opened this issue · comments

If I understand the documentation correctly, /data is just used for reading the configuration files and the passkey. Isn't it rather a configuration directory then? It could also be mounted read-only if that is the case.

Would be good to know also for deploying this in a (swarm) cluster.

(By the way, the links to helm/hookshot in the documentation are broken.)

Yes, /data/config.yml, /data/passkey.pem /data/registration.yml can all be read only. Hookshot itself does not need any persistent mounts.

Yep, we should document this as such. I believe /data was something we just used early on and never changed. We could rename it to /config to keep it simple.

The clean solution would be to change the volume to ./config:/config:ro. But I can see that this would introduce a backward incompatibility. If you don't want that, I propose to change it to ./data:/config:ro at least (and adjust the code accordingly).