Skip to content

Commit

Permalink
users: revive USERS_LDAP_USER_SCHEMA_ID variable
Browse files Browse the repository at this point in the history
The config variable was accidently removed when cleaning up deprecated variables
for the 4.0.0 release

Fixes: #7312
  • Loading branch information
rhafer committed Sep 20, 2023
1 parent 8a1912e commit 9610ec6
Show file tree
Hide file tree
Showing 81 changed files with 175 additions and 123 deletions.
2 changes: 1 addition & 1 deletion services/_includes/adoc/antivirus_configvars.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

ifeval::[{show-deprecation} == true]

[#deprecation-note-2023-09-20-14-29-45]
[#deprecation-note-2023-09-20-17-00-46]
[caption=]
.Deprecation notes for the antivirus service
[width="100%",cols="~,~,~,~",options="header"]
Expand Down
2 changes: 1 addition & 1 deletion services/_includes/adoc/app-provider_configvars.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

ifeval::[{show-deprecation} == true]

[#deprecation-note-2023-09-20-14-29-45]
[#deprecation-note-2023-09-20-17-00-46]
[caption=]
.Deprecation notes for the app-provider service
[width="100%",cols="~,~,~,~",options="header"]
Expand Down
2 changes: 1 addition & 1 deletion services/_includes/adoc/app-registry_configvars.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

ifeval::[{show-deprecation} == true]

[#deprecation-note-2023-09-20-14-29-45]
[#deprecation-note-2023-09-20-17-00-46]
[caption=]
.Deprecation notes for the app-registry service
[width="100%",cols="~,~,~,~",options="header"]
Expand Down
2 changes: 1 addition & 1 deletion services/_includes/adoc/audit_configvars.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

ifeval::[{show-deprecation} == true]

[#deprecation-note-2023-09-20-14-29-45]
[#deprecation-note-2023-09-20-17-00-46]
[caption=]
.Deprecation notes for the audit service
[width="100%",cols="~,~,~,~",options="header"]
Expand Down
14 changes: 10 additions & 4 deletions services/_includes/adoc/auth-basic_configvars.adoc
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
// set the attribute to true or leave empty, true without any quotes.

:show-deprecation: false
:show-deprecation: true

ifeval::[{show-deprecation} == true]

[#deprecation-note-2023-09-20-14-29-45]
[#deprecation-note-2023-09-20-17-00-46]
[caption=]
.Deprecation notes for the auth-basic service
[width="100%",cols="~,~,~,~",options="header"]
Expand All @@ -13,6 +13,11 @@ ifeval::[{show-deprecation} == true]
| Deprecation Version
| Removal Version
| Deprecation Replacement

| LDAP_BIND_PASSWORD changing name for consistency
| 4.0.2
| 5.0.0
| OCIS_LDAP_BIND_PASSWORD
|===

endif::[]
Expand Down Expand Up @@ -255,9 +260,10 @@ a| [subs=-attributes]
a| [subs=-attributes]
LDAP DN to use for simple bind authentication with the target LDAP server.

a|`LDAP_BIND_PASSWORD` +
a|`OCIS_LDAP_BIND_PASSWORD` +
`LDAP_BIND_PASSWORD` +
`AUTH_BASIC_LDAP_BIND_PASSWORD` +

xref:deprecation-note-2023-09-20-17-00-46[Deprecation Note]
a| [subs=-attributes]
++string ++
a| [subs=-attributes]
Expand Down
2 changes: 1 addition & 1 deletion services/_includes/adoc/auth-basic_deprecation.adoc
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
:show-deprecation: false
:show-deprecation: true

2 changes: 1 addition & 1 deletion services/_includes/adoc/auth-bearer_configvars.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

ifeval::[{show-deprecation} == true]

[#deprecation-note-2023-09-20-14-29-45]
[#deprecation-note-2023-09-20-17-00-46]
[caption=]
.Deprecation notes for the auth-bearer service
[width="100%",cols="~,~,~,~",options="header"]
Expand Down
2 changes: 1 addition & 1 deletion services/_includes/adoc/auth-machine_configvars.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

ifeval::[{show-deprecation} == true]

[#deprecation-note-2023-09-20-14-29-45]
[#deprecation-note-2023-09-20-17-00-46]
[caption=]
.Deprecation notes for the auth-machine service
[width="100%",cols="~,~,~,~",options="header"]
Expand Down
2 changes: 1 addition & 1 deletion services/_includes/adoc/auth-service_configvars.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

ifeval::[{show-deprecation} == true]

[#deprecation-note-2023-09-20-14-29-45]
[#deprecation-note-2023-09-20-17-00-46]
[caption=]
.Deprecation notes for the auth-service service
[width="100%",cols="~,~,~,~",options="header"]
Expand Down
2 changes: 1 addition & 1 deletion services/_includes/adoc/clientlog_configvars.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

ifeval::[{show-deprecation} == true]

[#deprecation-note-2023-09-20-14-29-45]
[#deprecation-note-2023-09-20-17-00-46]
[caption=]
.Deprecation notes for the clientlog service
[width="100%",cols="~,~,~,~",options="header"]
Expand Down
2 changes: 1 addition & 1 deletion services/_includes/adoc/eventhistory_configvars.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

ifeval::[{show-deprecation} == true]

[#deprecation-note-2023-09-20-14-29-45]
[#deprecation-note-2023-09-20-17-00-46]
[caption=]
.Deprecation notes for the eventhistory service
[width="100%",cols="~,~,~,~",options="header"]
Expand Down
2 changes: 1 addition & 1 deletion services/_includes/adoc/frontend_configvars.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

ifeval::[{show-deprecation} == true]

[#deprecation-note-2023-09-20-14-29-45]
[#deprecation-note-2023-09-20-17-00-46]
[caption=]
.Deprecation notes for the frontend service
[width="100%",cols="~,~,~,~",options="header"]
Expand Down
2 changes: 1 addition & 1 deletion services/_includes/adoc/gateway_configvars.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

ifeval::[{show-deprecation} == true]

[#deprecation-note-2023-09-20-14-29-45]
[#deprecation-note-2023-09-20-17-00-46]
[caption=]
.Deprecation notes for the gateway service
[width="100%",cols="~,~,~,~",options="header"]
Expand Down
69 changes: 43 additions & 26 deletions services/_includes/adoc/global_configvars.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,6 @@ a| [subs=attributes+]
* xref:{s-path}/graph.adoc[graph] +
* xref:{s-path}/groups.adoc[groups] +
* xref:{s-path}/idp.adoc[idp] +
* xref:{s-path}/users.adoc[users] +

a| [subs=-attributes]
++string ++
Expand All @@ -82,7 +81,7 @@ a| [subs=-attributes]
++ ++

a| [subs=-attributes]
ID of the user that should receive admin privileges. Consider that the UUID can be encoded in some LDAP deployment configurations like in .ldif files. These need to be decoded beforehand.
ID of the user who collects all necessary information for deletion. Consider that the UUID can be encoded in some LDAP deployment configurations like in .ldif files. These need to be decoded beforehand.

a| `OCIS_ASYNC_UPLOADS`

Expand Down Expand Up @@ -144,7 +143,7 @@ a| [subs=-attributes]
++0 ++

a| [subs=-attributes]
The maximum quantity of items in the cache. Only applies when store type 'ocmem' is configured. Defaults to 512.
The maximum quantity of items in the user info cache. Only applies when store type 'ocmem' is configured. Defaults to 512.

a| `OCIS_CACHE_STORE`

Expand Down Expand Up @@ -216,7 +215,7 @@ a| [subs=-attributes]
++5m0s ++

a| [subs=-attributes]
Default time to live for user info in the cache. Only applied when access tokens has no expiration. The duration can be set as number followed by a unit identifier like s, m or h. Defaults to '300s' (300 seconds).
Default time to live for user info in the user info cache. Only applied when access tokens has no expiration. The duration can be set as number followed by a unit identifier like s, m or h. Defaults to '300s' (300 seconds).

a| `OCIS_CORS_ALLOW_CREDENTIALS`

Expand Down Expand Up @@ -261,7 +260,7 @@ a| [subs=-attributes]
++[]string ++

a| [subs=-attributes]
++[Authorization Origin Content-Type Accept X-Requested-With X-Request-Id Ocs-Apirequest] ++
++[Origin Accept Content-Type Depth Authorization Ocs-Apirequest If-None-Match If-Match Destination Overwrite X-Request-Id X-Requested-With Tus-Resumable Tus-Checksum-Algorithm Upload-Concat Upload-Length Upload-Metadata Upload-Defer-Length Upload-Expires Upload-Checksum Upload-Offset X-HTTP-Method-Override Cache-Control] ++

a| [subs=-attributes]
A blank or comma-separated list of allowed CORS headers. See following chapter for more details: *Access-Control-Request-Headers* at \https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Headers.
Expand All @@ -285,7 +284,7 @@ a| [subs=-attributes]
++[]string ++

a| [subs=-attributes]
++[GET] ++
++[OPTIONS HEAD GET PUT POST DELETE MKCOL PROPFIND PROPPATCH MOVE COPY REPORT SEARCH] ++

a| [subs=-attributes]
A comma-separated list of allowed CORS methods. See following chapter for more details: *Access-Control-Request-Method* at \https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Request-Method
Expand Down Expand Up @@ -427,7 +426,7 @@ a| [subs=-attributes]
++false ++

a| [subs=-attributes]
Enable TLS for the connection to the events broker. The events broker is the ocis service which receives and delivers events between the services..
Enable TLS for the connection to the events broker. The events broker is the ocis service which receives and delivers events between the services.

a| `OCIS_EVENTS_ENDPOINT`

Expand Down Expand Up @@ -480,7 +479,7 @@ a| [subs=-attributes]
++ ++

a| [subs=-attributes]
The root CA certificate used to validate the server's TLS certificate. If provided NOTIFICATIONS_EVENTS_TLS_INSECURE will be seen as false.
The root CA certificate used to validate the server's TLS certificate. If provided POSTPROCESSING_EVENTS_TLS_INSECURE will be seen as false.

a| `OCIS_GRPC_CLIENT_TLS_CACERT`

Expand Down Expand Up @@ -656,7 +655,7 @@ a| [subs=-attributes]
++false ++

a| [subs=-attributes]
Allow insecure connections to the OIDC issuer.
Allow insecure connections to the GATEWAY service.

a| `OCIS_JWT_SECRET`

Expand Down Expand Up @@ -725,7 +724,7 @@ a| [subs=-attributes]
++ ++

a| [subs=-attributes]
The client id to authenticate with keycloak.
The client ID to authenticate with keycloak.

a| `OCIS_KEYCLOAK_CLIENT_REALM`

Expand Down Expand Up @@ -800,11 +799,29 @@ a| [subs=-attributes]
++string ++

a| [subs=-attributes]
++uid=libregraph,ou=sysusers,o=libregraph-idm ++
++uid=reva,ou=sysusers,o=libregraph-idm ++

a| [subs=-attributes]
LDAP DN to use for simple bind authentication with the target LDAP server.

a| `OCIS_LDAP_BIND_PASSWORD`

a| [subs=attributes+]
* xref:{s-path}/auth-basic.adoc[auth-basic] +
* xref:{s-path}/graph.adoc[graph] +
* xref:{s-path}/groups.adoc[groups] +
* xref:{s-path}/idp.adoc[idp] +
* xref:{s-path}/users.adoc[users] +

a| [subs=-attributes]
++string ++

a| [subs=-attributes]
++ ++

a| [subs=-attributes]
Password to use for authenticating the 'bind_dn'.

a| `OCIS_LDAP_CACERT`

a| [subs=attributes+]
Expand Down Expand Up @@ -853,7 +870,7 @@ a| [subs=-attributes]
++attribute ++

a| [subs=-attributes]
An option to control the behavior for disabling users. Supported options are 'none', 'attribute' and 'group'. If set to 'group', disabling a user via API will add the user to the configured group for disabled users, if set to 'attribute' this will be done in the ldap user entry, if set to 'none' the disable request is not processed. Default is 'attribute'.
An option to control the behavior for disabling users. Valid options are 'none', 'attribute' and 'group'. If set to 'group', disabling a user via API will add the user to the configured group for disabled users, if set to 'attribute' this will be done in the ldap user entry, if set to 'none' the disable request is not processed.

a| `OCIS_LDAP_GROUP_BASE_DN`

Expand Down Expand Up @@ -904,7 +921,7 @@ a| [subs=-attributes]
++groupOfNames ++

a| [subs=-attributes]
The object class to use for groups in the default group search filter ('groupOfNames').
The object class to use for groups in the default group search filter like 'groupOfNames'.

a| `OCIS_LDAP_GROUP_SCHEMA_DISPLAYNAME`

Expand Down Expand Up @@ -951,10 +968,10 @@ a| [subs=-attributes]
++string ++

a| [subs=-attributes]
++owncloudUUID ++
++ownclouduuid ++

a| [subs=-attributes]
LDAP Attribute to use as the unique id for groups. This should be a stable globally unique ID like a UUID.
LDAP Attribute to use as the unique ID for groups. This should be a stable globally unique ID like a UUID.

a| `OCIS_LDAP_GROUP_SCHEMA_ID_IS_OCTETSTRING`

Expand All @@ -971,7 +988,7 @@ a| [subs=-attributes]
++false ++

a| [subs=-attributes]
Set this to true if the defined 'ID' attribute for groups is of the 'OCTETSTRING' syntax. This is required when using the 'objectGUID' attribute of Active Directory for the group ID's.
Set this to true if the defined 'id' attribute for groups is of the 'OCTETSTRING' syntax. This is e.g. required when using the 'objectGUID' attribute of Active Directory for the group ID's.

a| `OCIS_LDAP_GROUP_SCHEMA_MAIL`

Expand Down Expand Up @@ -1021,7 +1038,7 @@ a| [subs=-attributes]
++sub ++

a| [subs=-attributes]
LDAP search scope to use when looking up groups. Supported scopes are 'base', 'one' and 'sub'.
LDAP search scope to use when looking up groups. Supported values are 'base', 'one' and 'sub'.

a| `OCIS_LDAP_INSECURE`

Expand Down Expand Up @@ -1107,7 +1124,7 @@ a| [subs=-attributes]
++ownCloudUserEnabled ++

a| [subs=-attributes]
LDAP Attribute to use as a flag telling if the user is enabled or disabled.
LDAP attribute to use as a flag telling if the user is enabled or disabled.

a| `OCIS_LDAP_USER_FILTER`

Expand Down Expand Up @@ -1143,7 +1160,7 @@ a| [subs=-attributes]
++inetOrgPerson ++

a| [subs=-attributes]
The object class to use for users in the default user search filter ('inetOrgPerson').
The object class to use for users in the default user search filter like 'inetOrgPerson'.

a| `OCIS_LDAP_USER_SCHEMA_DISPLAYNAME`

Expand Down Expand Up @@ -1174,7 +1191,7 @@ a| [subs=-attributes]
++string ++

a| [subs=-attributes]
++owncloudUUID ++
++ownclouduuid ++

a| [subs=-attributes]
LDAP Attribute to use as the unique ID for users. This should be a stable globally unique ID like a UUID.
Expand All @@ -1194,7 +1211,7 @@ a| [subs=-attributes]
++false ++

a| [subs=-attributes]
Set this to true if the defined 'ID' attribute for users is of the 'OCTETSTRING' syntax. This is required when using the 'objectGUID' attribute of Active Directory for the user ID's.
Set this to true if the defined 'ID' attribute for users is of the 'OCTETSTRING' syntax. This is e.g. required when using the 'objectGUID' attribute of Active Directory for the user ID's.

a| `OCIS_LDAP_USER_SCHEMA_MAIL`

Expand Down Expand Up @@ -1263,7 +1280,7 @@ a| [subs=-attributes]
++sub ++

a| [subs=-attributes]
LDAP search scope to use when looking up users. Supported scopes are 'base', 'one' and 'sub'.
LDAP search scope to use when looking up users. Supported values are 'base', 'one' and 'sub'.

a| `OCIS_LOG_COLOR`

Expand Down Expand Up @@ -1511,7 +1528,7 @@ a| [subs=-attributes]
++https://localhost:9200 ++

a| [subs=-attributes]
URL of the OIDC issuer. It defaults to URL of the builtin IDP.
The identity provider value to set in the userids of the CS3 user objects for users returned by this user provider.

a| `OCIS_PERSISTENT_STORE`

Expand Down Expand Up @@ -1572,7 +1589,7 @@ a| [subs=-attributes]
++Duration ++

a| [subs=-attributes]
++336h0m0s ++
++0s ++

a| [subs=-attributes]
Time to live for events in the store. The duration can be set as number followed by a unit identifier like s, m or h. Defaults to '336h' (2 weeks).
Expand Down Expand Up @@ -1689,7 +1706,7 @@ a| [subs=-attributes]
++0 ++

a| [subs=-attributes]
Set the global max quota value in bytes. A value of 0 equals unlimited. The value is provided via capabilities.
Set a global max quota for spaces in bytes. A value of 0 equals unlimited. If not using the global OCIS_SPACES_MAX_QUOTA, you must define the FRONTEND_MAX_QUOTA in the frontend service.

a| `OCIS_SYSTEM_USER_API_KEY`

Expand Down Expand Up @@ -1999,7 +2016,7 @@ a| [subs=-attributes]
++https://localhost:9200 ++

a| [subs=-attributes]
URL of the OIDC issuer. It defaults to URL of the builtin IDP.
URL where oCIS is reachable for users.

a| `STORAGE_USERS_ASYNC_PROPAGATOR_PROPAGATION_DELAY`

Expand Down
Loading

0 comments on commit 9610ec6

Please sign in to comment.