owncloud / owncloud/ocis

Improve dev docs on how to disable the password enforcement for public links

Open
#8,607 0 comments 2 reactions 0 assignees View on GitHub
Category:Enhancement Topic:Documentation
Dominant language
Go
Stars
2.1k
Forks
274
Avg merge
2d 1h
Merged PRs (30d)
103

Description

_Originally posted by @kulmann in https://github.com/owncloud/ocis/issues/8604#issuecomment-1985083188_

For this particular case I would suggest 2 things:
- deprecate the service vars because it seems like it only makes sense to have the global var. Otherwise you can shoot yourself in the foot very easily (like I did now).
- make sure that I find some info easily, which takes me by the hand and tells me "hey, there is password enforcement and a password policy for public links. to enable or disable password enforcement, set the env var `OCIS_....` to `true` or `false` respectively. If you want to tighten or loosen your password requirements, use the env vars `OCIS_....`.". You might argue that this belongs in admin docs, but I expect it in the dev docs already - where the env vars are defined. I don't need an exhaustive list of env vars. An FAQ with the most important things one might want to solve would be much more helpful.

I have two screenshots for you. The first one shows, that you don't find useful content when you search for "Password". The second shows, that the env var list in the frontend service suggests that the two env vars listed there can be used interchangeably - which now turned out as incorrect.

Screenshot 2024-03-08 at 06 48 17
Screenshot 2024-03-08 at 06 54 06

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.