commit 4b65e6d

Merge: 485fa6d e2ea74c Author: David Christofas <[email protected]> Date: Tue Apr 26 15:26:46 2022 +0200 Merge pull request #3569 from owncloud/storage-config [full-ci] Refactor storage configuration to make it similar to other oCIS configuration
owncloud · Apr 26, 2022 · 609f1cb · 609f1cb
1 parent ffcdbc4
commit 609f1cb
Show file tree

Hide file tree

Showing 36 changed files with 1,034 additions and 8 deletions.
diff --git a/extensions/_includes/appprovider-config-example.yaml b/extensions/_includes/appprovider-config-example.yaml
@@ -0,0 +1,36 @@
+# Autogenerated
+tracing:
+  enabled: false
+  type: ""
+  endpoint: ""
+  collector: ""
+log:
+  level: ""
+  pretty: false
+  color: false
+  file: ""
+debug:
+  addr: 127.0.0.1:9165
+  token: ""
+  pprof: false
+  zpages: false
+supervised: false
+grpc:
+  addr: 127.0.0.1:9164
+  protocol: tcp
+jwtsecret: Pive-Fumkiu4
+gatewayendpoint: 127.0.0.1:9142
+skipusergroupsintoken: false
+externaladdr: ""
+driver: ""
+drivers:
+  wopi:
+    app_api_key: ""
+    app_desktop_only: false
+    app_icon_uri: ""
+    app_internal_url: ""
+    app_name: ""
+    app_url: ""
+    insecure: false
+    ipo_secret: ""
+    wopi_url: ""
diff --git a/extensions/_includes/appprovider_configvars.md b/extensions/_includes/appprovider_configvars.md
@@ -0,0 +1,10 @@
+## Environment Variables
+
+| Name | Type | Default Value | Description |
+|------|------|---------------|-------------|
+| APP_PROVIDER_DEBUG_ADDR | string | 127.0.0.1:9165 | |
+| APP_PROVIDER_DEBUG_TOKEN | string |  | |
+| APP_PROVIDER_DEBUG_PPROF | bool | false | |
+| APP_PROVIDER_DEBUG_ZPAGES | bool | false | |
+| APP_PROVIDER_GRPC_ADDR | string | 127.0.0.1:9164 | The address of the grpc service.|
+| APP_PROVIDER_GRPC_PROTOCOL | string | tcp | The transport protocol of the grpc service.|
diff --git a/extensions/_includes/auth-basic-config-example.yaml b/extensions/_includes/auth-basic-config-example.yaml
@@ -0,0 +1,67 @@
+# Autogenerated
+tracing:
+  enabled: false
+  type: ""
+  endpoint: ""
+  collector: ""
+log:
+  level: ""
+  pretty: false
+  color: false
+  file: ""
+debug:
+  addr: 127.0.0.1:9147
+  token: ""
+  pprof: false
+  zpages: false
+supervised: false
+grpc:
+  addr: 127.0.0.1:9146
+  protocol: tcp
+jwtsecret: Pive-Fumkiu4
+gatewayendpoint: 127.0.0.1:9142
+skipusergroupsintoken: false
+auth_provider: ldap
+auth_providers:
+  json:
+    file: ""
+  ldap:
+    uri: ldaps://localhost:9126
+    cacert: ~/.ocis/ldap/ldap.crt
+    insecure: false
+    binddn: cn=reva,ou=sysusers,dc=ocis,dc=test
+    bindpassword: reva
+    userbasedn: dc=ocis,dc=test
+    groupbasedn: dc=ocis,dc=test
+    userfilter: ""
+    groupfilter: ""
+    userobjectclass: posixAccount
+    groupobjectclass: posixGroup
+    loginattributes:
+    - cn
+    - mail
+    idp: https://localhost:9200
+    gatewayendpoint: ""
+    userschema:
+      id: ownclouduuid
+      idisoctetstring: false
+      mail: mail
+      displayname: displayname
+      username: cn
+    groupschema:
+      id: cn
+      idisoctetstring: false
+      mail: mail
+      displayname: cn
+      groupname: cn
+      member: cn
+  owncloud_sql:
+    dbusername: owncloud
+    dbpassword: secret
+    dbhost: mysql
+    dbport: 3306
+    dbname: owncloud
+    idp: https://localhost:9200
+    nobody: 90
+    joinusername: false
+    joinownclouduuid: false
diff --git a/extensions/_includes/auth-basic_configvars.md b/extensions/_includes/auth-basic_configvars.md
@@ -0,0 +1,36 @@
+## Environment Variables
+
+| Name | Type | Default Value | Description |
+|------|------|---------------|-------------|
+| AUTH_BASIC_DEBUG_ADDR | string | 127.0.0.1:9147 | |
+| AUTH_BASIC_DEBUG_TOKEN | string |  | |
+| AUTH_BASIC_DEBUG_PPROF | bool | false | |
+| AUTH_BASIC_DEBUG_ZPAGES | bool | false | |
+| AUTH_BASIC_GRPC_ADDR | string | 127.0.0.1:9146 | The address of the grpc service.|
+| AUTH_BASIC_GRPC_PROTOCOL | string | tcp | The transport protocol of the grpc service.|
+| AUTH_BASIC_AUTH_PROVIDER | string | ldap | The auth provider which should be used by the service|
+| AUTH_BASIC_JSON_PROVIDER_FILE | string |  | The file to which the json provider writes the data.|
+| LDAP_URI;AUTH_BASIC_LDAP_URI | string | ldaps://localhost:9126 | |
+| LDAP_CACERT;AUTH_BASIC_LDAP_CACERT | string | ~/.ocis/ldap/ldap.crt | |
+| LDAP_INSECURE;AUTH_BASIC_LDAP_INSECURE | bool | false | |
+| LDAP_BIND_DN;AUTH_BASIC_LDAP_BIND_DN | string | cn=reva,ou=sysusers,dc=ocis,dc=test | |
+| LDAP_BIND_PASSWORD;AUTH_BASIC_LDAP_BIND_PASSWORD | string | reva | |
+| LDAP_USER_BASE_DN;AUTH_BASIC_LDAP_USER_BASE_DN | string | dc=ocis,dc=test | |
+| LDAP_GROUP_BASE_DN;AUTH_BASIC_LDAP_GROUP_BASE_DN | string | dc=ocis,dc=test | |
+| LDAP_USERFILTER;AUTH_BASIC_LDAP_USERFILTER | string |  | |
+| LDAP_GROUPFILTER;AUTH_BASIC_LDAP_USERFILTER | string |  | |
+| LDAP_USER_OBJECTCLASS;AUTH_BASIC_LDAP_USER_OBJECTCLASS | string | posixAccount | |
+| LDAP_GROUP_OBJECTCLASS;AUTH_BASIC_LDAP_GROUP_OBJECTCLASS | string | posixGroup | |
+| LDAP_LOGIN_ATTRIBUTES;AUTH_BASIC_LDAP_LOGIN_ATTRIBUTES |  | [cn mail] | |
+| OCIS_URL;AUTH_BASIC_IDP_URL | string | https://localhost:9200 | |
+| LDAP_USER_SCHEMA_ID;AUTH_BASIC_LDAP_USER_SCHEMA_ID | string | ownclouduuid | |
+| LDAP_USER_SCHEMA_ID_IS_OCTETSTRING;AUTH_BASIC_LDAP_USER_SCHEMA_ID_IS_OCTETSTRING | bool | false | |
+| LDAP_USER_SCHEMA_MAIL;AUTH_BASIC_LDAP_USER_SCHEMA_MAIL | string | mail | |
+| LDAP_USER_SCHEMA_DISPLAYNAME;AUTH_BASIC_LDAP_USER_SCHEMA_DISPLAYNAME | string | displayname | |
+| LDAP_USER_SCHEMA_USERNAME;AUTH_BASIC_LDAP_USER_SCHEMA_USERNAME | string | cn | |
+| LDAP_GROUP_SCHEMA_ID;AUTH_BASIC_LDAP_GROUP_SCHEMA_ID | string | cn | |
+| LDAP_GROUP_SCHEMA_ID_IS_OCTETSTRING;AUTH_BASIC_LDAP_GROUP_SCHEMA_ID_IS_OCTETSTRING | bool | false | |
+| LDAP_GROUP_SCHEMA_MAIL;AUTH_BASIC_LDAP_GROUP_SCHEMA_MAIL | string | mail | |
+| LDAP_GROUP_SCHEMA_DISPLAYNAME;AUTH_BASIC_LDAP_GROUP_SCHEMA_DISPLAYNAME | string | cn | |
+| LDAP_GROUP_SCHEMA_GROUPNAME;AUTH_BASIC_LDAP_GROUP_SCHEMA_GROUPNAME | string | cn | |
+| LDAP_GROUP_SCHEMA_MEMBER;AUTH_BASIC_LDAP_GROUP_SCHEMA_MEMBER | string | cn | |
diff --git a/extensions/_includes/auth-bearer-config-example.yaml b/extensions/_includes/auth-bearer-config-example.yaml
@@ -0,0 +1,31 @@
+# Autogenerated
+tracing:
+  enabled: false
+  type: ""
+  endpoint: ""
+  collector: ""
+log:
+  level: ""
+  pretty: false
+  color: false
+  file: ""
+debug:
+  addr: 127.0.0.1:9149
+  token: ""
+  pprof: false
+  zpages: false
+supervised: false
+grpc:
+  addr: 127.0.0.1:9148
+  protocol: tcp
+jwtsecret: Pive-Fumkiu4
+gatewayendpoint: 127.0.0.1:9142
+skipusergroupsintoken: false
+auth_provider: ldap
+auth_providers:
+  oidc:
+    issuer: https://localhost:9200
+    insecure: false
+    id_claim: preferred_username
+    uid_claim: ""
+    gid_claim: ""
diff --git a/extensions/_includes/auth-bearer_configvars.md b/extensions/_includes/auth-bearer_configvars.md
@@ -0,0 +1,13 @@
+## Environment Variables
+
+| Name | Type | Default Value | Description |
+|------|------|---------------|-------------|
+| AUTH_BEARER_DEBUG_ADDR | string | 127.0.0.1:9149 | |
+| AUTH_BEARER_DEBUG_TOKEN | string |  | |
+| AUTH_BEARER_DEBUG_PPROF | bool | false | |
+| AUTH_BEARER_DEBUG_ZPAGES | bool | false | |
+| AUTH_BEARER_GRPC_ADDR | string | 127.0.0.1:9148 | The address of the grpc service.|
+| AUTH_BEARER_GRPC_PROTOCOL | string | tcp | The transport protocol of the grpc service.|
+| AUTH_BEARER_AUTH_PROVIDER | string | ldap | The auth provider which should be used by the service|
+| OCIS_URL;AUTH_BEARER_OIDC_ISSUER | string | https://localhost:9200 | |
+| OCIS_INSECURE;AUTH_BEARER_OIDC_INSECURE | bool | false | |
diff --git a/extensions/_includes/auth-machine-config-example.yaml b/extensions/_includes/auth-machine-config-example.yaml
@@ -0,0 +1,27 @@
+# Autogenerated
+tracing:
+  enabled: false
+  type: ""
+  endpoint: ""
+  collector: ""
+log:
+  level: ""
+  pretty: false
+  color: false
+  file: ""
+debug:
+  addr: 127.0.0.1:9167
+  token: ""
+  pprof: false
+  zpages: false
+supervised: false
+grpc:
+  addr: 127.0.0.1:9166
+  protocol: tcp
+jwtsecret: Pive-Fumkiu4
+gatewayendpoint: 127.0.0.1:9142
+skipusergroupsintoken: false
+auth_provider: ldap
+auth_providers:
+  machine:
+    api_key: change-me-please
diff --git a/extensions/_includes/auth-machine_configvars.md b/extensions/_includes/auth-machine_configvars.md
@@ -0,0 +1,12 @@
+## Environment Variables
+
+| Name | Type | Default Value | Description |
+|------|------|---------------|-------------|
+| AUTH_MACHINE_DEBUG_ADDR | string | 127.0.0.1:9167 | |
+| AUTH_MACHINE_DEBUG_TOKEN | string |  | |
+| AUTH_MACHINE_DEBUG_PPROF | bool | false | |
+| AUTH_MACHINE_DEBUG_ZPAGES | bool | false | |
+| AUTH_MACHINE_GRPC_ADDR | string | 127.0.0.1:9166 | The address of the grpc service.|
+| AUTH_MACHINE_GRPC_PROTOCOL | string | tcp | The transport protocol of the grpc service.|
+| AUTH_MACHINE_AUTH_PROVIDER | string | ldap | The auth provider which should be used by the service|
+| OCIS_MACHINE_AUTH_API_KEY;AUTH_MACHINE_PROVIDER_API_KEY | string | change-me-please | The api key for the machine auth provider.|
diff --git a/extensions/_includes/frontend-config-example.yaml b/extensions/_includes/frontend-config-example.yaml
@@ -0,0 +1,72 @@
+# Autogenerated
+tracing:
+  enabled: false
+  type: ""
+  endpoint: ""
+  collector: ""
+log:
+  level: ""
+  pretty: false
+  color: false
+  file: ""
+debug:
+  addr: 127.0.0.1:9141
+  token: ""
+  pprof: false
+  zpages: false
+supervised: false
+http:
+  addr: 127.0.0.1:9140
+  protocol: tcp
+  prefix: ""
+jwt_secret: Pive-Fumkiu4
+gatewayendpoint: 127.0.0.1:9142
+skipusergroupsintoken: false
+favorites: false
+enableprojectspaces: true
+upload_max_chunk_size: 100000000
+upload_http_method_override: ""
+default_upload_protocol: tus
+transfer_secret: replace-me-with-a-transfer-secret
+public_url: https://localhost:9200
+archiver:
+  max_num_files: 10000
+  max_size: 1073741824
+  prefix: archiver
+  insecure: false
+appprovider:
+  external_addr: ""
+  driver: ""
+  apps_url: ""
+  open_url: ""
+  new_url: ""
+  prefix: ""
+  insecure: false
+datagateway:
+  prefix: data
+ocs:
+  prefix: ocs
+  share_prefix: /Shares
+  home_namespace: /users/{{.Id.OpaqueId}}
+  additional_info_attribute: '{{.Mail}}'
+  resource_info_cache_ttl: 0
+  cache_warmup_driver: ""
+  cachewarmupdrivers:
+    cbox:
+      dbusername: ""
+      dbpassword: ""
+      dbhost: ""
+      dbport: 0
+      dbname: ""
+      namespace: ""
+authmachine:
+  apikey: change-me-please
+checksums:
+  supported_types:
+  - sha1
+  - md5
+  - adler32
+  preferred_upload_type: ""
+middleware:
+  auth:
+    credentials_by_user_agenr: {}
diff --git a/extensions/_includes/frontend_configvars.md b/extensions/_includes/frontend_configvars.md
@@ -0,0 +1,15 @@
+## Environment Variables
+
+| Name | Type | Default Value | Description |
+|------|------|---------------|-------------|
+| FRONTEND_DEBUG_ADDR | string | 127.0.0.1:9141 | |
+| FRONTEND_DEBUG_TOKEN | string |  | |
+| FRONTEND_DEBUG_PPROF | bool | false | |
+| FRONTEND_DEBUG_ZPAGES | bool | false | |
+| FRONTEND_HTTP_ADDR | string | 127.0.0.1:9140 | The address of the http service.|
+| FRONTEND_HTTP_PROTOCOL | string | tcp | The transport protocol of the http service.|
+| STORAGE_TRANSFER_SECRET | string | replace-me-with-a-transfer-secret | |
+| OCIS_URL;FRONTEND_PUBLIC_URL | string | https://localhost:9200 | |
+| OCIS_INSECURE;FRONTEND_ARCHIVER_INSECURE | bool | false | |
+| OCIS_INSECURE;FRONTEND_APPPROVIDER_INSECURE | bool | false | |
+| OCIS_MACHINE_AUTH_API_KEY | string | change-me-please | |
diff --git a/extensions/_includes/gateway-config-example.yaml b/extensions/_includes/gateway-config-example.yaml
@@ -0,0 +1,49 @@
+# Autogenerated
+tracing:
+  enabled: false
+  type: ""
+  endpoint: ""
+  collector: ""
+log:
+  level: ""
+  pretty: false
+  color: false
+  file: ""
+debug:
+  addr: 127.0.0.1:9143
+  token: ""
+  pprof: false
+  zpages: false
+supervised: false
+grpc:
+  addr: 127.0.0.1:9142
+  protocol: tcp
+jwtsecret: Pive-Fumkiu4
+gatewayendpoint: 127.0.0.1:9142
+skipusergroupsintoken: false
+commitsharetostoragegrant: true
+commitsharetostorageref: true
+sharefolder: Shares
+disablehomecreationonlogin: true
+transfersecret: replace-me-with-a-transfer-secret
+transferexpires: 86400
+homemapping: ""
+etagcachettl: 0
+usersendpoint: localhost:9144
+groupsendpoint: localhost:9160
+permissionsendpoint: localhost:9191
+sharingendpoint: localhost:9150
+datagatewaypublicurl: ""
+frontendpublicurl: https://localhost:9200
+authbasicendpoint: localhost:9146
+authbearerendpoint: localhost:9148
+authmachineendpoint: localhost:9166
+storagepubliclinkendpoint: localhost:9178
+storageusersendpoint: localhost:9157
+storagesharesendpoint: localhost:9154
+storageregistry:
+  driver: spaces
+  rules: []
+  json: ""
+appregistry:
+  mimetypesjson: ""
diff --git a/extensions/_includes/gateway_configvars.md b/extensions/_includes/gateway_configvars.md
@@ -0,0 +1,12 @@
+## Environment Variables
+
+| Name | Type | Default Value | Description |
+|------|------|---------------|-------------|
+| GATEWAY_DEBUG_ADDR | string | 127.0.0.1:9143 | |
+| GATEWAY_DEBUG_TOKEN | string |  | |
+| GATEWAY_DEBUG_PPROF | bool | false | |
+| GATEWAY_DEBUG_ZPAGES | bool | false | |
+| GATEWAY_GRPC_ADDR | string | 127.0.0.1:9142 | The address of the grpc service.|
+| GATEWAY_GRPC_PROTOCOL | string | tcp | The transport protocol of the grpc service.|
+| STORAGE_TRANSFER_SECRET | string | replace-me-with-a-transfer-secret | |
+| OCIS_URL;GATEWAY_FRONTEND_PUBLIC_URL | string | https://localhost:9200 | |