commit 7c5a6ee

Merge: 34a207a 2755f04
Author: Willy Kloucek <34452982+wkloucek@users.noreply.github.com>
Date:   Tue Jun 29 12:42:22 2021 +0200

    Merge pull request #2180 from owncloud/add_hello_and_s3_deployment_example

    add hello and s3 deplyoment example

extensions/glauth/configuration.md

@@ -1,6 +1,6 @@
 ---
 title: "Configuration"
-date: "2021-06-29T10:39:44+0000"
+date: "2021-06-29T10:43:36+0000"
 weight: 20
 geekdocRepo: https://github.com/owncloud/ocis
 geekdocEditPath: edit/master/glauth/templates
@@ -35,237 +35,237 @@ If multiple variables are listed for one option, they are in order of precedence
 
 If you prefer to configure the service with commandline flags you can see the available variables below. Command line flags are only working when calling the subcommand directly.
 
-### glauth server
+### glauth health
 
-Start integrated server
+Check health status
 
-Usage: `glauth server [command options] [arguments...]`
+Usage: `glauth health [command options] [arguments...]`
 
 
 
 
 
+-debug-addr |  $GLAUTH_DEBUG_ADDR
+: Address to debug endpoint. Default: `flags.OverrideDefaultString(cfg.Debug.Addr, "0.0.0.0:9129")`.
 
--log-file |  $GLAUTH_LOG_FILE , $OCIS_LOG_FILE
-: Enable log to file.
 
 
--config-file |  $GLAUTH_CONFIG_FILE
-: Path to config file. Default: `flags.OverrideDefaultString(cfg.File, "")`.
 
 
--tracing-enabled |  $GLAUTH_TRACING_ENABLED
-: Enable sending traces.
 
 
--tracing-type |  $GLAUTH_TRACING_TYPE
-: Tracing backend type. Default: `flags.OverrideDefaultString(cfg.Tracing.Type, "jaeger")`.
 
 
--tracing-endpoint |  $GLAUTH_TRACING_ENDPOINT
-: Endpoint for the agent. Default: `flags.OverrideDefaultString(cfg.Tracing.Endpoint, "")`.
 
 
--tracing-collector |  $GLAUTH_TRACING_COLLECTOR
-: Endpoint for the collector. Default: `flags.OverrideDefaultString(cfg.Tracing.Collector, "")`.
 
 
--tracing-service |  $GLAUTH_TRACING_SERVICE
-: Service name for tracing. Default: `flags.OverrideDefaultString(cfg.Tracing.Service, "glauth")`.
 
 
--debug-addr |  $GLAUTH_DEBUG_ADDR
-: Address to bind debug server. Default: `flags.OverrideDefaultString(cfg.Debug.Addr, "0.0.0.0:9129")`.
 
 
--debug-token |  $GLAUTH_DEBUG_TOKEN
-: Token to grant metrics access. Default: `flags.OverrideDefaultString(cfg.Debug.Token, "")`.
 
 
--debug-pprof |  $GLAUTH_DEBUG_PPROF
-: Enable pprof debugging.
 
 
--debug-zpages |  $GLAUTH_DEBUG_ZPAGES
-: Enable zpages debugging.
 
 
--role-bundle-id |  $GLAUTH_ROLE_BUNDLE_ID
-: roleid used to make internal grpc requests. Default: `flags.OverrideDefaultString(cfg.RoleBundleUUID, "71881883-1768-46bd-a24d-a356a2afdf7f")`.
 
 
--ldap-addr |  $GLAUTH_LDAP_ADDR
-: Address to bind ldap server. Default: `flags.OverrideDefaultString(cfg.Ldap.Address, "0.0.0.0:9125")`.
 
 
--ldap-enabled |  $GLAUTH_LDAP_ENABLED
-: Enable ldap server. Default: `flags.OverrideDefaultBool(cfg.Ldap.Enabled, true)`.
 
 
--ldaps-addr |  $GLAUTH_LDAPS_ADDR
-: Address to bind ldap server. Default: `flags.OverrideDefaultString(cfg.Ldaps.Address, "0.0.0.0:9126")`.
 
 
--ldaps-enabled |  $GLAUTH_LDAPS_ENABLED
-: Enable ldap server. Default: `flags.OverrideDefaultBool(cfg.Ldaps.Enabled, true)`.
 
 
--ldaps-cert |  $GLAUTH_LDAPS_CERT
-: path to ldaps certificate in PEM format. Default: `flags.OverrideDefaultString(cfg.Ldaps.Cert, path.Join(pkgos.MustUserConfigDir("ocis", "ldap"), "ldap.crt"))`.
+### glauth ocis-glauth
 
+Serve GLAuth API for oCIS
 
--ldaps-key |  $GLAUTH_LDAPS_KEY
-: path to ldaps key in PEM format. Default: `flags.OverrideDefaultString(cfg.Ldaps.Key, path.Join(pkgos.MustUserConfigDir("ocis", "ldap"), "ldap.key"))`.
+Usage: `glauth ocis-glauth [command options] [arguments...]`
 
 
--backend-basedn |  $GLAUTH_BACKEND_BASEDN
-: base distinguished name to expose. Default: `flags.OverrideDefaultString(cfg.Backend.BaseDN, "dc=example,dc=org")`.
+-log-level |  $GLAUTH_LOG_LEVEL , $OCIS_LOG_LEVEL
+: Set logging level.
 
 
--backend-name-format |  $GLAUTH_BACKEND_NAME_FORMAT
-: name attribute for entries to expose. typically cn or uid. Default: `flags.OverrideDefaultString(cfg.Backend.NameFormat, "cn")`.
+-log-pretty |  $GLAUTH_LOG_PRETTY , $OCIS_LOG_PRETTY
+: Enable pretty logging.
 
 
--backend-group-format |  $GLAUTH_BACKEND_GROUP_FORMAT
-: name attribute for entries to expose. typically ou, cn or dc. Default: `flags.OverrideDefaultString(cfg.Backend.GroupFormat, "ou")`.
+-log-color |  $GLAUTH_LOG_COLOR , $OCIS_LOG_COLOR
+: Enable colored logging.
 
 
--backend-ssh-key-attr |  $GLAUTH_BACKEND_SSH_KEY_ATTR
-: ssh key attribute for entries to expose. Default: `flags.OverrideDefaultString(cfg.Backend.SSHKeyAttr, "sshPublicKey")`.
 
 
--backend-datastore |  $GLAUTH_BACKEND_DATASTORE
-: datastore to use as the backend. one of accounts, ldap or owncloud. Default: `flags.OverrideDefaultString(cfg.Backend.Datastore, "accounts")`.
 
 
--backend-insecure |  $GLAUTH_BACKEND_INSECURE
-: Allow insecure requests to the datastore. Default: `flags.OverrideDefaultBool(cfg.Backend.Insecure, false)`.
 
 
--backend-use-graphapi |  $GLAUTH_BACKEND_USE_GRAPHAPI
-: use Graph API, only for owncloud datastore. Default: `flags.OverrideDefaultBool(cfg.Backend.UseGraphAPI, true)`.
 
 
--fallback-basedn |  $GLAUTH_FALLBACK_BASEDN
-: base distinguished name to expose. Default: `flags.OverrideDefaultString(cfg.Fallback.BaseDN, "dc=example,dc=org")`.
 
 
--fallback-name-format |  $GLAUTH_FALLBACK_NAME_FORMAT
-: name attribute for entries to expose. typically cn or uid. Default: `flags.OverrideDefaultString(cfg.Fallback.NameFormat, "cn")`.
 
 
--fallback-group-format |  $GLAUTH_FALLBACK_GROUP_FORMAT
-: name attribute for entries to expose. typically ou, cn or dc. Default: `flags.OverrideDefaultString(cfg.Fallback.GroupFormat, "ou")`.
 
 
--fallback-ssh-key-attr |  $GLAUTH_FALLBACK_SSH_KEY_ATTR
-: ssh key attribute for entries to expose. Default: `flags.OverrideDefaultString(cfg.Fallback.SSHKeyAttr, "sshPublicKey")`.
 
 
--fallback-datastore |  $GLAUTH_FALLBACK_DATASTORE
-: datastore to use as the fallback. one of accounts, ldap or owncloud. Default: `flags.OverrideDefaultString(cfg.Fallback.Datastore, "")`.
 
 
--fallback-insecure |  $GLAUTH_FALLBACK_INSECURE
-: Allow insecure requests to the datastore. Default: `flags.OverrideDefaultBool(cfg.Fallback.Insecure, false)`.
 
 
--fallback-use-graphapi |  $GLAUTH_FALLBACK_USE_GRAPHAPI
-: use Graph API, only for owncloud datastore. Default: `flags.OverrideDefaultBool(cfg.Fallback.UseGraphAPI, true)`.
 
-### glauth health
 
-Check health status
 
-Usage: `glauth health [command options] [arguments...]`
 
 
 
 
 
--debug-addr |  $GLAUTH_DEBUG_ADDR
-: Address to debug endpoint. Default: `flags.OverrideDefaultString(cfg.Debug.Addr, "0.0.0.0:9129")`.
 
 
 
 
+### glauth server
 
+Start integrated server
 
+Usage: `glauth server [command options] [arguments...]`
 
 
 
 
 
 
+-log-file |  $GLAUTH_LOG_FILE , $OCIS_LOG_FILE
+: Enable log to file.
 
 
+-config-file |  $GLAUTH_CONFIG_FILE
+: Path to config file. Default: `flags.OverrideDefaultString(cfg.File, "")`.
 
 
+-tracing-enabled |  $GLAUTH_TRACING_ENABLED
+: Enable sending traces.
 
 
+-tracing-type |  $GLAUTH_TRACING_TYPE
+: Tracing backend type. Default: `flags.OverrideDefaultString(cfg.Tracing.Type, "jaeger")`.
 
 
+-tracing-endpoint |  $GLAUTH_TRACING_ENDPOINT
+: Endpoint for the agent. Default: `flags.OverrideDefaultString(cfg.Tracing.Endpoint, "")`.
 
 
+-tracing-collector |  $GLAUTH_TRACING_COLLECTOR
+: Endpoint for the collector. Default: `flags.OverrideDefaultString(cfg.Tracing.Collector, "")`.
 
 
+-tracing-service |  $GLAUTH_TRACING_SERVICE
+: Service name for tracing. Default: `flags.OverrideDefaultString(cfg.Tracing.Service, "glauth")`.
 
 
+-debug-addr |  $GLAUTH_DEBUG_ADDR
+: Address to bind debug server. Default: `flags.OverrideDefaultString(cfg.Debug.Addr, "0.0.0.0:9129")`.
 
 
+-debug-token |  $GLAUTH_DEBUG_TOKEN
+: Token to grant metrics access. Default: `flags.OverrideDefaultString(cfg.Debug.Token, "")`.
 
 
+-debug-pprof |  $GLAUTH_DEBUG_PPROF
+: Enable pprof debugging.
 
 
+-debug-zpages |  $GLAUTH_DEBUG_ZPAGES
+: Enable zpages debugging.
 
-### glauth ocis-glauth
 
-Serve GLAuth API for oCIS
+-role-bundle-id |  $GLAUTH_ROLE_BUNDLE_ID
+: roleid used to make internal grpc requests. Default: `flags.OverrideDefaultString(cfg.RoleBundleUUID, "71881883-1768-46bd-a24d-a356a2afdf7f")`.
 
-Usage: `glauth ocis-glauth [command options] [arguments...]`
 
+-ldap-addr |  $GLAUTH_LDAP_ADDR
+: Address to bind ldap server. Default: `flags.OverrideDefaultString(cfg.Ldap.Address, "0.0.0.0:9125")`.
 
--log-level |  $GLAUTH_LOG_LEVEL , $OCIS_LOG_LEVEL
-: Set logging level.
 
+-ldap-enabled |  $GLAUTH_LDAP_ENABLED
+: Enable ldap server. Default: `flags.OverrideDefaultBool(cfg.Ldap.Enabled, true)`.
 
--log-pretty |  $GLAUTH_LOG_PRETTY , $OCIS_LOG_PRETTY
-: Enable pretty logging.
 
+-ldaps-addr |  $GLAUTH_LDAPS_ADDR
+: Address to bind ldap server. Default: `flags.OverrideDefaultString(cfg.Ldaps.Address, "0.0.0.0:9126")`.
 
--log-color |  $GLAUTH_LOG_COLOR , $OCIS_LOG_COLOR
-: Enable colored logging.
 
+-ldaps-enabled |  $GLAUTH_LDAPS_ENABLED
+: Enable ldap server. Default: `flags.OverrideDefaultBool(cfg.Ldaps.Enabled, true)`.
 
 
+-ldaps-cert |  $GLAUTH_LDAPS_CERT
+: path to ldaps certificate in PEM format. Default: `flags.OverrideDefaultString(cfg.Ldaps.Cert, path.Join(pkgos.MustUserConfigDir("ocis", "ldap"), "ldap.crt"))`.
 
 
+-ldaps-key |  $GLAUTH_LDAPS_KEY
+: path to ldaps key in PEM format. Default: `flags.OverrideDefaultString(cfg.Ldaps.Key, path.Join(pkgos.MustUserConfigDir("ocis", "ldap"), "ldap.key"))`.
 
 
+-backend-basedn |  $GLAUTH_BACKEND_BASEDN
+: base distinguished name to expose. Default: `flags.OverrideDefaultString(cfg.Backend.BaseDN, "dc=example,dc=org")`.
 
 
+-backend-name-format |  $GLAUTH_BACKEND_NAME_FORMAT
+: name attribute for entries to expose. typically cn or uid. Default: `flags.OverrideDefaultString(cfg.Backend.NameFormat, "cn")`.
 
 
+-backend-group-format |  $GLAUTH_BACKEND_GROUP_FORMAT
+: name attribute for entries to expose. typically ou, cn or dc. Default: `flags.OverrideDefaultString(cfg.Backend.GroupFormat, "ou")`.
 
 
+-backend-ssh-key-attr |  $GLAUTH_BACKEND_SSH_KEY_ATTR
+: ssh key attribute for entries to expose. Default: `flags.OverrideDefaultString(cfg.Backend.SSHKeyAttr, "sshPublicKey")`.
 
 
+-backend-datastore |  $GLAUTH_BACKEND_DATASTORE
+: datastore to use as the backend. one of accounts, ldap or owncloud. Default: `flags.OverrideDefaultString(cfg.Backend.Datastore, "accounts")`.
 
 
+-backend-insecure |  $GLAUTH_BACKEND_INSECURE
+: Allow insecure requests to the datastore. Default: `flags.OverrideDefaultBool(cfg.Backend.Insecure, false)`.
 
 
+-backend-use-graphapi |  $GLAUTH_BACKEND_USE_GRAPHAPI
+: use Graph API, only for owncloud datastore. Default: `flags.OverrideDefaultBool(cfg.Backend.UseGraphAPI, true)`.
 
 
+-fallback-basedn |  $GLAUTH_FALLBACK_BASEDN
+: base distinguished name to expose. Default: `flags.OverrideDefaultString(cfg.Fallback.BaseDN, "dc=example,dc=org")`.
 
 
+-fallback-name-format |  $GLAUTH_FALLBACK_NAME_FORMAT
+: name attribute for entries to expose. typically cn or uid. Default: `flags.OverrideDefaultString(cfg.Fallback.NameFormat, "cn")`.
 
 
+-fallback-group-format |  $GLAUTH_FALLBACK_GROUP_FORMAT
+: name attribute for entries to expose. typically ou, cn or dc. Default: `flags.OverrideDefaultString(cfg.Fallback.GroupFormat, "ou")`.
 
 
+-fallback-ssh-key-attr |  $GLAUTH_FALLBACK_SSH_KEY_ATTR
+: ssh key attribute for entries to expose. Default: `flags.OverrideDefaultString(cfg.Fallback.SSHKeyAttr, "sshPublicKey")`.
 
 
+-fallback-datastore |  $GLAUTH_FALLBACK_DATASTORE
+: datastore to use as the fallback. one of accounts, ldap or owncloud. Default: `flags.OverrideDefaultString(cfg.Fallback.Datastore, "")`.
 
 
+-fallback-insecure |  $GLAUTH_FALLBACK_INSECURE
+: Allow insecure requests to the datastore. Default: `flags.OverrideDefaultBool(cfg.Fallback.Insecure, false)`.
 
 
+-fallback-use-graphapi |  $GLAUTH_FALLBACK_USE_GRAPHAPI
+: use Graph API, only for owncloud datastore. Default: `flags.OverrideDefaultBool(cfg.Fallback.UseGraphAPI, true)`.
 

extensions/graph-explorer/configuration.md

@@ -1,6 +1,6 @@
 ---
 title: "Configuration"
-date: "2021-06-29T10:39:44+0000"
+date: "2021-06-29T10:43:36+0000"
 weight: 20
 geekdocRepo: https://github.com/owncloud/ocis
 geekdocEditPath: edit/master/graph-explorer/templates