mirror/opencloud
1
0
Fork 0
mirror of https://github.com/opencloud-eu/opencloud.git synced 2026-01-06 20:29:54 -06:00
Code Issues Packages Projects Releases Wiki Activity

Apply suggestions from code review

Browse Source 
Co-authored-by: Martin <github@diemattels.at>
This commit is contained in:
Daniel Swärd
2023-04-14 11:05:53 +02:00
parent 68f1d5897b
commit 6433fc8d80
2 changed files with 19 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
services/frontend/README.md
View File

@@ -26,21 +26,16 @@ The ocs endpoint, by default `/ocs`, implements the ownCloud 10 Open Collaborati
While the frontend service does not persist any data it does cache `Stat()` responses and user information. Therefore, multiple instances of this service can be spawned in a bigger deployment like when using container orchestration with Kubernetes, when configuring `FRONTEND_OCS_RESOURCE_INFO_CACHE_TYPE=redis` and the related config options.
## libregraph service interactions
## Libregraph Service Interactions
A lot of user management is done via a standardized libregraph API.
Depending on how the system is configured there might be some attributes
for users that an instance admin user can't change because of properties
coming from an external LDAP server, or similar. To make life easier for
admin users there are hints as capabilites telling which attributes are
read-only or not. To configure these hints we have the following
environment variables:
A lot of user management is done via a standardized libregraph API. Depending on how the system is configured, there might be some attributes for users that an ocis instance admin user can't change because of properties
coming from an external LDAP server, or similar. This can be the case when the ocis admin is not the LDAP admin. To make life easier for admin users, there are hints as capabilites telling the frontend which attributes are read-only or not, so they can be shown in the frontend differently. To configure these hints the following environment variables are available:
- FRONTEND_READONLY_ATTRIBUTES_ACCOUNT_ENABLED: Default is false
- FRONTEND_READONLY_ATTRIBUTES_DISPLAY_NAME: Default is true
- FRONTEND_READONLY_ATTRIBUTES_GIVEN_NAME: Default is true
- FRONTEND_READONLY_ATTRIBUTES_ID: Default is true
- FRONTEND_READONLY_ATTRIBUTES_MAIL: Default is true
- FRONTEND_READONLY_ATTRIBUTES_ON_PREMISES_SAM_ACCOUNT_NAME: Default is true
- FRONTEND_READONLY_ATTRIBUTES_SURNAME: Default is true
- FRONTEND_READONLY_ATTRIBUTES_QUOTA: Default is false
- FRONTEND_READONLY_ATTRIBUTES_ACCOUNT_ENABLED: Defaults to false
- FRONTEND_READONLY_ATTRIBUTES_DISPLAY_NAME: Defaults to true
- FRONTEND_READONLY_ATTRIBUTES_GIVEN_NAME: Defaults to true
- FRONTEND_READONLY_ATTRIBUTES_ID: Defaults to true
- FRONTEND_READONLY_ATTRIBUTES_MAIL: Defaults to true
- FRONTEND_READONLY_ATTRIBUTES_ON_PREMISES_SAM_ACCOUNT_NAME: Defaults to true
- FRONTEND_READONLY_ATTRIBUTES_SURNAME: Defaults to true
- FRONTEND_READONLY_ATTRIBUTES_QUOTA: Defaults to false

16
services/frontend/pkg/config/config.go
View File

@@ -163,12 +163,12 @@ type Checksums struct {
}
type ReadyOnlyAttributes struct {
AccountEnabled bool `yaml:"account_enabled" env:"FRONTEND_READONLY_ATTRIBUTES_ACCOUNT_ENABLED" desc:"Flag to indicate if account_enabled attribute is read-only. Default is false."`
DisplayName bool `yaml:"display_name" env:"FRONTEND_READONLY_ATTRIBUTES_DISPLAY_NAME" desc:"Flag to indicate if display_name attribute is read-only. Default is true."`
GivenName bool `yaml:"given_name" env:"FRONTEND_READONLY_ATTRIBUTES_GIVEN_NAME" desc:"Flag to indicate if given_name attribute is read-only. Default is true."`
ID bool `yaml:"id" env:"FRONTEND_READONLY_ATTRIBUTES_ID" desc:"Flag to indicate if id attribute is read-only. Default is true."`
Mail bool `yaml:"mail" env:"FRONTEND_READONLY_ATTRIBUTES_MAIL" desc:"Flag to indicate if mail attribute is read-only. Default is true."`
OnPremisesSamAccountName bool `yaml:"on_premises_sam_account_name" env:"FRONTEND_READONLY_ATTRIBUTES_ON_PREMISES_SAM_ACCOUNT_NAME" desc:"Flag to indicate if on_premises_sam_account_name attribute is read-only. Default is true."`
Surname bool `yaml:"surname" env:"FRONTEND_READONLY_ATTRIBUTES_SURNAME" desc:"Flag to indicate if surname attribute is read-only. Default is true."`
Quota bool `yaml:"quota" env:"FRONTEND_READONLY_ATTRIBUTES_QUOTA" desc:"Flag to indicate if quota attribute read-only. Default is false."`
AccountEnabled bool `yaml:"account_enabled" env:"FRONTEND_READONLY_ATTRIBUTES_ACCOUNT_ENABLED" desc:"Flag to indicate if account_enabled attribute is read-only. Defaults to false."`
DisplayName bool `yaml:"display_name" env:"FRONTEND_READONLY_ATTRIBUTES_DISPLAY_NAME" desc:"Flag to indicate if display_name attribute is read-only. Defaults to true."`
GivenName bool `yaml:"given_name" env:"FRONTEND_READONLY_ATTRIBUTES_GIVEN_NAME" desc:"Flag to indicate if given_name attribute is read-only. Defaults to true."`
ID bool `yaml:"id" env:"FRONTEND_READONLY_ATTRIBUTES_ID" desc:"Flag to indicate if id attribute is read-only. Defaults to true."`
Mail bool `yaml:"mail" env:"FRONTEND_READONLY_ATTRIBUTES_MAIL" desc:"Flag to indicate if mail attribute is read-only. Defaults to true."`
OnPremisesSamAccountName bool `yaml:"on_premises_sam_account_name" env:"FRONTEND_READONLY_ATTRIBUTES_ON_PREMISES_SAM_ACCOUNT_NAME" desc:"Flag to indicate if on_premises_sam_account_name attribute is read-only. Defaults to true."`
Surname bool `yaml:"surname" env:"FRONTEND_READONLY_ATTRIBUTES_SURNAME" desc:"Flag to indicate if surname attribute is read-only. Defaults to true."`
Quota bool `yaml:"quota" env:"FRONTEND_READONLY_ATTRIBUTES_QUOTA" desc:"Flag to indicate if quota attribute read-only. Defaults to false."`
}