eliott/ocis
1
0
Fork 0
mirror of https://github.com/owncloud/ocis synced 2026-04-25 17:25:21 +02:00
Code Issues Packages Projects Releases Wiki Activity

[docs-only] Update of the envvar delta table and replace curie with semver

Browse Source
This commit is contained in:
Martin Mattel
2026-01-19 11:13:26 +01:00
parent 6fc0d1d10a
commit ed6897a7a0
5 changed files with 60 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
docs/services/general-info/envvars/env-var-deltas/7.3.0-8.0.0-added.adoc
View File

@@ -1,7 +1,7 @@
// # Added Variables between oCIS 7.3.0 and oCIS 8.0.0
// commenting the headline to make it better includable
// table created per 2026.01.13
// table created per 2026.01.19
// the table should be recreated/updated on source () changes
[width="100%",cols="~,~,~,~",options="header"]
@@ -28,6 +28,46 @@
| LDAP attribute that references the external ID of users during the provisioning process. The final ID is provided by an external identity provider. If it is not set, a default attribute will be used instead.
| owncloudExternalID
|
| OCIS_LDAP_INSTANCE_MAPPER_BASE_DN
| BaseDN of the 'instancename to instanceid' mapper in LDAP. Requires OCIS_MULTI_INSTANCE_ENABLED.
|
|
| OCIS_LDAP_INSTANCE_MAPPER_ENABLED
| The InstanceMapper allows mapping instance names (user readable) to instance IDs (machine readable) based on an LDAP query. See other _INSTANCE_MAPPER_ env vars. Requires OCIS_MULTI_INSTANCE_ENABLED.
| false
|
| OCIS_LDAP_INSTANCE_MAPPER_ID_ATTRIBUTE
| LDAP Attribute of the instance ID. Requires OCIS_MULTI_INSTANCE_ENABLED.
|
|
| OCIS_LDAP_INSTANCE_MAPPER_NAME_ATTRIBUTE
| LDAP Attribute of the instance name. Requires OCIS_MULTI_INSTANCE_ENABLED.
|
|
| OCIS_LDAP_PRECISE_SEARCH_ATTRIBUTE
| LDAP Attribute to be used for searching users on other instances. Requires OCIS_MULTI_INSTANCE_ENABLED.
|
|
| OCIS_LDAP_USER_GUEST_ATTRIBUTE
| LDAP Attribute to signal the user is guest of an instance. Requires OCIS_MULTI_INSTANCE_ENABLED.
|
|
| OCIS_LDAP_USER_MEMBER_ATTRIBUTE
| LDAP Attribute to signal the user is member of an instance. Requires OCIS_MULTI_INSTANCE_ENABLED.
|
|
| OCIS_MULTI_INSTANCE_QUERY_TEMPLATE
| The regular expression extracting username and instancename from a user provided search.
|
| xref:{s-path}/proxy.adoc[Proxy]
| PROXY_FORCE_STRICT_TRANSPORT_SECURITY
| Force emission of the Strict-Transport-Security header on all responses, including plain HTTP requests. See also: PROXY_TLS

8
docs/services/general-info/envvars/env-var-deltas/7.3.0-8.0.0-added.md
View File

@@ -4,6 +4,14 @@
| [Graph]({s-path}/graph.adoc) | GRAPH_LDAP_EXTERNAL_ID_ATTRIBUTE | LDAP attribute that references the external ID of users during the provisioning process. The final ID is provided by an external identity provider. If it is not set, a default attribute will be used instead. | owncloudExternalID |
| | GRAPH_LDAP_REQUIRE_EXTERNAL_ID | If enabled, the 'OCIS_LDAP_USER_SCHEMA_EXTERNAL_ID' is used as primary identifier for the provisioning API. | false |
| | OCIS_LDAP_USER_SCHEMA_EXTERNAL_ID | LDAP attribute that references the external ID of users during the provisioning process. The final ID is provided by an external identity provider. If it is not set, a default attribute will be used instead. | owncloudExternalID |
| | OCIS_LDAP_INSTANCE_MAPPER_BASE_DN | BaseDN of the 'instancename to instanceid' mapper in LDAP. Requires OCIS_MULTI_INSTANCE_ENABLED. | |
| | OCIS_LDAP_INSTANCE_MAPPER_ENABLED | The InstanceMapper allows mapping instance names (user readable) to instance IDs (machine readable) based on an LDAP query. See other _INSTANCE_MAPPER_ env vars. Requires OCIS_MULTI_INSTANCE_ENABLED. | false |
| | OCIS_LDAP_INSTANCE_MAPPER_ID_ATTRIBUTE | LDAP Attribute of the instance ID. Requires OCIS_MULTI_INSTANCE_ENABLED. | |
| | OCIS_LDAP_INSTANCE_MAPPER_NAME_ATTRIBUTE | LDAP Attribute of the instance name. Requires OCIS_MULTI_INSTANCE_ENABLED. | |
| | OCIS_LDAP_PRECISE_SEARCH_ATTRIBUTE | LDAP Attribute to be used for searching users on other instances. Requires OCIS_MULTI_INSTANCE_ENABLED. | |
| | OCIS_LDAP_USER_GUEST_ATTRIBUTE | LDAP Attribute to signal the user is guest of an instance. Requires OCIS_MULTI_INSTANCE_ENABLED. | |
| | OCIS_LDAP_USER_MEMBER_ATTRIBUTE | LDAP Attribute to signal the user is member of an instance. Requires OCIS_MULTI_INSTANCE_ENABLED. | |
| | OCIS_MULTI_INSTANCE_QUERY_TEMPLATE | The regular expression extracting username and instancename from a user provided search. | |
| [Proxy]({s-path}/proxy.adoc) | PROXY_FORCE_STRICT_TRANSPORT_SECURITY | Force emission of the Strict-Transport-Security header on all responses, including plain HTTP requests. See also: PROXY_TLS | false |
| | OCIS_MULTI_INSTANCE_ENABLED | Enable multiple instances of Infinite Scale. | false |
| | OCIS_MULTI_INSTANCE_GUEST_CLAIM | The claim name for the 'guestOf' property | guestOf |

2
docs/services/general-info/envvars/env-var-deltas/7.3.0-8.0.0-deprecated.adoc
View File

@@ -1,7 +1,7 @@
// # Deprecated Variables between oCIS 7.3.0 and oCIS 8.0.0
// commenting the headline to make it better includable
// table created per 2026.01.13
// table created per 2026.01.19
// the table should be recreated/updated on source () changes
[width="100%",cols="~,~,~,~,~",options="header"]

2
docs/services/general-info/envvars/env-var-deltas/7.3.0-8.0.0-removed.adoc
View File

@@ -1,7 +1,7 @@
// # Removed Variables between oCIS 7.3.0 and oCIS 8.0.0
// commenting the headline to make it better includable
// table created per 2026.01.13
// table created per 2026.01.19
// the table should be recreated/updated on source () changes
[width="100%",cols="~,~,~,~",options="header"]

18
services/graph/pkg/config/config.go
View File

@@ -95,13 +95,13 @@ type LDAP struct {
RequireExternalID bool `yaml:"require_external_id" env:"GRAPH_LDAP_REQUIRE_EXTERNAL_ID" desc:"If enabled, the 'OCIS_LDAP_USER_SCHEMA_EXTERNAL_ID' is used as primary identifier for the provisioning API." introductionVersion:"8.0.0"`
// Multi-Instance Only
UserMemberAttribute string `yaml:"user_member_attribute" env:"OCIS_LDAP_USER_MEMBER_ATTRIBUTE" desc:"LDAP Attribute to signal the user is member of an instance. Requires OCIS_MULTI_INSTANCE_ENABLED." introductionVersion:"Curie"`
UserGuestAttribute string `yaml:"user_guest_attribute" env:"OCIS_LDAP_USER_GUEST_ATTRIBUTE" desc:"LDAP Attribute to signal the user is guest of an instance. Requires OCIS_MULTI_INSTANCE_ENABLED." introductionVersion:"Curie"`
PreciseSearchAttribute string `yaml:"precise_search_attribute" env:"OCIS_LDAP_PRECISE_SEARCH_ATTRIBUTE" desc:"LDAP Attribute to be used for searching users on other instances. Requires OCIS_MULTI_INSTANCE_ENABLED." introductionVersion:"Curie"`
InstanceMapperEnabled bool `yaml:"instance_mapper_enabled" env:"OCIS_LDAP_INSTANCE_MAPPER_ENABLED" desc:"The InstanceMapper allows mapping instance names (user readable) to instance IDs (machine readable) based on an LDAP query. See other _INSTANCE_MAPPER_ env vars. Requires OCIS_MULTI_INSTANCE_ENABLED." introductionVersion:"Curie"`
InstanceMapperBaseDN string `yaml:"instance_mapper_base_dn" env:"OCIS_LDAP_INSTANCE_MAPPER_BASE_DN" desc:"BaseDN of the 'instancename to instanceid' mapper in LDAP. Requires OCIS_MULTI_INSTANCE_ENABLED." introductionVersion:"Curie"`
InstanceMapperNameAttribute string `yaml:"instance_mapper_name_attribute" env:"OCIS_LDAP_INSTANCE_MAPPER_NAME_ATTRIBUTE" desc:"LDAP Attribute of the instance name. Requires OCIS_MULTI_INSTANCE_ENABLED." introductionVersion:"Curie"`
InstanceMapperIDAttribute string `yaml:"instance_mapper_id_attribute" env:"OCIS_LDAP_INSTANCE_MAPPER_ID_ATTRIBUTE" desc:"LDAP Attribute of the instance ID. Requires OCIS_MULTI_INSTANCE_ENABLED." introductionVersion:"Curie"`
UserMemberAttribute string `yaml:"user_member_attribute" env:"OCIS_LDAP_USER_MEMBER_ATTRIBUTE" desc:"LDAP Attribute to signal the user is member of an instance. Requires OCIS_MULTI_INSTANCE_ENABLED." introductionVersion:"8.0.0"`
UserGuestAttribute string `yaml:"user_guest_attribute" env:"OCIS_LDAP_USER_GUEST_ATTRIBUTE" desc:"LDAP Attribute to signal the user is guest of an instance. Requires OCIS_MULTI_INSTANCE_ENABLED." introductionVersion:"8.0.0"`
PreciseSearchAttribute string `yaml:"precise_search_attribute" env:"OCIS_LDAP_PRECISE_SEARCH_ATTRIBUTE" desc:"LDAP Attribute to be used for searching users on other instances. Requires OCIS_MULTI_INSTANCE_ENABLED." introductionVersion:"8.0.0"`
InstanceMapperEnabled bool `yaml:"instance_mapper_enabled" env:"OCIS_LDAP_INSTANCE_MAPPER_ENABLED" desc:"The InstanceMapper allows mapping instance names (user readable) to instance IDs (machine readable) based on an LDAP query. See other _INSTANCE_MAPPER_ env vars. Requires OCIS_MULTI_INSTANCE_ENABLED." introductionVersion:"8.0.0"`
InstanceMapperBaseDN string `yaml:"instance_mapper_base_dn" env:"OCIS_LDAP_INSTANCE_MAPPER_BASE_DN" desc:"BaseDN of the 'instancename to instanceid' mapper in LDAP. Requires OCIS_MULTI_INSTANCE_ENABLED." introductionVersion:"8.0.0"`
InstanceMapperNameAttribute string `yaml:"instance_mapper_name_attribute" env:"OCIS_LDAP_INSTANCE_MAPPER_NAME_ATTRIBUTE" desc:"LDAP Attribute of the instance name. Requires OCIS_MULTI_INSTANCE_ENABLED." introductionVersion:"8.0.0"`
InstanceMapperIDAttribute string `yaml:"instance_mapper_id_attribute" env:"OCIS_LDAP_INSTANCE_MAPPER_ID_ATTRIBUTE" desc:"LDAP Attribute of the instance ID. Requires OCIS_MULTI_INSTANCE_ENABLED." introductionVersion:"8.0.0"`
}
// LDAPEducationConfig represents the LDAP configuration for education related resources
@@ -175,7 +175,7 @@ type Validation struct {
// MultiInstanceConfig holds configuration for multi-instance-ocis
type MultiInstanceConfig struct {
Enabled bool `yaml:"enabled" env:"OCIS_MULTI_INSTANCE_ENABLED" desc:"Enable multiple instances of Infinite Scale." introductionVersion:"Curie"`
InstanceID string `yaml:"instanceid" env:"OCIS_MULTI_INSTANCE_INSTANCEID" desc:"The unique ID of this instance." introductionVersion:"Curie"`
Enabled bool `yaml:"enabled" env:"OCIS_MULTI_INSTANCE_ENABLED" desc:"Enable multiple instances of Infinite Scale." introductionVersion:"8.0.0"`
InstanceID string `yaml:"instanceid" env:"OCIS_MULTI_INSTANCE_INSTANCEID" desc:"The unique ID of this instance." introductionVersion:"8.0.0"`
QueryRegexp string `yaml:"query_regexp" env:"OCIS_MULTI_INSTANCE_QUERY_TEMPLATE" desc:"The regular expression extracting username and instancename from a user provided search." introductionVersion:"Curie"`
}