diff --git a/extensions/accounts/configuration.md b/extensions/accounts/configuration.md index 1ca8901d179..a0411171299 100644 --- a/extensions/accounts/configuration.md +++ b/extensions/accounts/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-06-23T17:39:23+0000" +date: "2021-06-24T01:51:08+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/accounts/templates @@ -35,12 +35,6 @@ 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. -### accounts add - -Create a new account - -Usage: `accounts add [command options] [arguments...]` - ### accounts list List existing accounts @@ -53,6 +47,12 @@ Usage: `accounts list [command options] [arguments...]` -name | $ACCOUNTS_NAME : service name. Default: `flags.OverrideDefaultString(cfg.Server.Name, "accounts")`. +### accounts rebuildIndex + +Rebuilds the service's index, i.e. deleting and then re-adding all existing documents + +Usage: `accounts rebuildIndex [command options] [arguments...]` + ### accounts remove Removes an existing account @@ -65,12 +65,6 @@ Usage: `accounts remove [command options] [arguments...]` -name | $ACCOUNTS_NAME : service name. Default: `flags.OverrideDefaultString(cfg.Server.Name, "accounts")`. -### accounts update - -Make changes to an existing account - -Usage: `accounts update [command options] [arguments...]` - ### accounts inspect Show detailed data on an existing account @@ -83,12 +77,6 @@ Usage: `accounts inspect [command options] [arguments...]` -name | $ACCOUNTS_NAME : service name. Default: `flags.OverrideDefaultString(cfg.Server.Name, "accounts")`. -### accounts rebuildIndex - -Rebuilds the service's index, i.e. deleting and then re-adding all existing documents - -Usage: `accounts rebuildIndex [command options] [arguments...]` - ### accounts ocis-accounts Provide accounts and groups for oCIS @@ -173,6 +161,12 @@ Usage: `accounts server [command options] [arguments...]` -service-user-username | $ACCOUNTS_SERVICE_USER_USERNAME : username of the internal service user (required on EOS). Default: `flags.OverrideDefaultString(cfg.ServiceUser.Username, "")`. +### accounts update + +Make changes to an existing account + +Usage: `accounts update [command options] [arguments...]` + ### accounts version Print the versions of the running instances @@ -185,3 +179,9 @@ Usage: `accounts version [command options] [arguments...]` -name | $ACCOUNTS_NAME : service name. Default: `flags.OverrideDefaultString(cfg.Server.Name, "accounts")`. +### accounts add + +Create a new account + +Usage: `accounts add [command options] [arguments...]` + diff --git a/extensions/glauth/configuration.md b/extensions/glauth/configuration.md index 0a5b0555790..28d880bca45 100644 --- a/extensions/glauth/configuration.md +++ b/extensions/glauth/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-06-23T17:40:17+0000" +date: "2021-06-24T01:51:58+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/glauth/templates @@ -35,6 +35,15 @@ 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 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 ocis-glauth Serve GLAuth API for oCIS @@ -152,12 +161,3 @@ Usage: `glauth server [command options] [arguments...]` -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")`. - diff --git a/extensions/graph-explorer/configuration.md b/extensions/graph-explorer/configuration.md index 65165ee67b1..13f4343639d 100644 --- a/extensions/graph-explorer/configuration.md +++ b/extensions/graph-explorer/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-06-23T17:40:17+0000" +date: "2021-06-24T01:51:58+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/graph-explorer/templates diff --git a/extensions/graph/configuration.md b/extensions/graph/configuration.md index 1b48ed84e43..30352b74b32 100644 --- a/extensions/graph/configuration.md +++ b/extensions/graph/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-06-23T17:40:17+0000" +date: "2021-06-24T01:51:58+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/graph/templates @@ -35,6 +35,15 @@ 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. +### graph health + +Check health status + +Usage: `graph health [command options] [arguments...]` + +-debug-addr | $GRAPH_DEBUG_ADDR +: Address to debug endpoint. Default: `flags.OverrideDefaultString(cfg.Debug.Addr, "0.0.0.0:9124")`. + ### graph ocis-graph Serve Graph API for oCIS @@ -128,12 +137,3 @@ Usage: `graph server [command options] [arguments...]` -reva-gateway-addr | $REVA_GATEWAY_ADDR : REVA Gateway Endpoint. Default: `flags.OverrideDefaultString(cfg.Reva.Address, "127.0.0.1:9142")`. -### graph health - -Check health status - -Usage: `graph health [command options] [arguments...]` - --debug-addr | $GRAPH_DEBUG_ADDR -: Address to debug endpoint. Default: `flags.OverrideDefaultString(cfg.Debug.Addr, "0.0.0.0:9124")`. - diff --git a/extensions/idp/configuration.md b/extensions/idp/configuration.md index 3dda7bc2b29..b52318e785c 100644 --- a/extensions/idp/configuration.md +++ b/extensions/idp/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-06-23T17:40:17+0000" +date: "2021-06-24T01:51:58+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/idp/templates @@ -35,6 +35,18 @@ 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. +### idp version + +Print the versions of the running instances + +Usage: `idp version [command options] [arguments...]` + +-http-namespace | $IDP_HTTP_NAMESPACE +: Set the base namespace for service discovery. Default: `flags.OverrideDefaultString(cfg.Service.Namespace, "com.owncloud.web")`. + +-name | $IDP_NAME +: Service name. Default: `flags.OverrideDefaultString(cfg.Service.Name, "idp")`. + ### idp health Check health status @@ -209,15 +221,3 @@ Usage: `idp server [command options] [arguments...]` -disable-identifier-webapp | $IDP_DISABLE_IDENTIFIER_WEBAPP : Disable built-in identifier-webapp to use a frontend hosted elsewhere.. Default: `flags.OverrideDefaultBool(cfg.IDP.IdentifierClientDisabled, true)`. -### idp version - -Print the versions of the running instances - -Usage: `idp version [command options] [arguments...]` - --http-namespace | $IDP_HTTP_NAMESPACE -: Set the base namespace for service discovery. Default: `flags.OverrideDefaultString(cfg.Service.Namespace, "com.owncloud.web")`. - --name | $IDP_NAME -: Service name. Default: `flags.OverrideDefaultString(cfg.Service.Name, "idp")`. - diff --git a/extensions/ocs/configuration.md b/extensions/ocs/configuration.md index e04dec4d682..c97716fcc20 100644 --- a/extensions/ocs/configuration.md +++ b/extensions/ocs/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-06-23T17:40:17+0000" +date: "2021-06-24T01:51:58+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/ocs/templates @@ -35,6 +35,18 @@ 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. +### ocs version + +Print the versions of the running instances + +Usage: `ocs version [command options] [arguments...]` + +-http-namespace | $OCS_NAMESPACE +: Set the base namespace for the http namespace. Default: `flags.OverrideDefaultString(cfg.Service.Namespace, "com.owncloud.web")`. + +-name | $OCS_NAME +: Service name. Default: `flags.OverrideDefaultString(cfg.Service.Name, "ocs")`. + ### ocs health Check health status @@ -125,15 +137,3 @@ Usage: `ocs server [command options] [arguments...]` -users-driver | $OCS_STORAGE_USERS_DRIVER , $STORAGE_USERS_DRIVER : storage driver for users mount: eg. local, eos, owncloud, ocis or s3. Default: `flags.OverrideDefaultString(cfg.StorageUsersDriver, "ocis")`. -### ocs version - -Print the versions of the running instances - -Usage: `ocs version [command options] [arguments...]` - --http-namespace | $OCS_NAMESPACE -: Set the base namespace for the http namespace. Default: `flags.OverrideDefaultString(cfg.Service.Namespace, "com.owncloud.web")`. - --name | $OCS_NAME -: Service name. Default: `flags.OverrideDefaultString(cfg.Service.Name, "ocs")`. - diff --git a/extensions/onlyoffice/configuration.md b/extensions/onlyoffice/configuration.md index f944b8565ec..c992ccb290f 100644 --- a/extensions/onlyoffice/configuration.md +++ b/extensions/onlyoffice/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-06-23T17:40:17+0000" +date: "2021-06-24T01:51:58+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/onlyoffice/templates diff --git a/extensions/proxy/configuration.md b/extensions/proxy/configuration.md index 5063336039a..a9a140835bd 100644 --- a/extensions/proxy/configuration.md +++ b/extensions/proxy/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-06-23T17:40:17+0000" +date: "2021-06-24T01:51:58+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/proxy/templates @@ -35,15 +35,6 @@ 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. -### proxy health - -Check health status - -Usage: `proxy health [command options] [arguments...]` - ---debug-addr | $PROXY_DEBUG_ADDR -: Address to debug endpoint. Default: `flags.OverrideDefaultString(cfg.Debug.Addr, "0.0.0.0:9109")`. - ### proxy ocis-proxy proxy for oCIS @@ -77,3 +68,12 @@ Usage: `proxy version [command options] [arguments...]` --service-name | $PROXY_SERVICE_NAME : Service name. Default: `flags.OverrideDefaultString(cfg.Service.Name, "proxy")`. +### proxy health + +Check health status + +Usage: `proxy health [command options] [arguments...]` + +--debug-addr | $PROXY_DEBUG_ADDR +: Address to debug endpoint. Default: `flags.OverrideDefaultString(cfg.Debug.Addr, "0.0.0.0:9109")`. + diff --git a/extensions/settings/configuration.md b/extensions/settings/configuration.md index 6087cf0b52a..8ade79ff44a 100644 --- a/extensions/settings/configuration.md +++ b/extensions/settings/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-06-23T17:40:18+0000" +date: "2021-06-24T01:51:58+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/settings/templates @@ -35,6 +35,27 @@ 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. +### settings version + +Print the versions of the running instances + +Usage: `settings version [command options] [arguments...]` + +-grpc-namespace | $SETTINGS_GRPC_NAMESPACE +: Set the base namespace for the grpc namespace. Default: `flags.OverrideDefaultString(cfg.GRPC.Namespace, "com.owncloud.api")`. + +-name | $SETTINGS_NAME +: service name. Default: `flags.OverrideDefaultString(cfg.Service.Name, "settings")`. + +### settings health + +Check health status + +Usage: `settings health [command options] [arguments...]` + +-debug-addr | $SETTINGS_DEBUG_ADDR +: Address to debug endpoint. Default: `flags.OverrideDefaultString(cfg.Debug.Addr, "0.0.0.0:9194")`. + ### settings ocis-settings Provide settings and permissions for oCIS @@ -113,24 +134,3 @@ Usage: `settings server [command options] [arguments...]` -jwt-secret | $SETTINGS_JWT_SECRET , $OCIS_JWT_SECRET : Used to create JWT to talk to reva, should equal reva's jwt-secret. Default: `flags.OverrideDefaultString(cfg.TokenManager.JWTSecret, "Pive-Fumkiu4")`. -### settings version - -Print the versions of the running instances - -Usage: `settings version [command options] [arguments...]` - --grpc-namespace | $SETTINGS_GRPC_NAMESPACE -: Set the base namespace for the grpc namespace. Default: `flags.OverrideDefaultString(cfg.GRPC.Namespace, "com.owncloud.api")`. - --name | $SETTINGS_NAME -: service name. Default: `flags.OverrideDefaultString(cfg.Service.Name, "settings")`. - -### settings health - -Check health status - -Usage: `settings health [command options] [arguments...]` - --debug-addr | $SETTINGS_DEBUG_ADDR -: Address to debug endpoint. Default: `flags.OverrideDefaultString(cfg.Debug.Addr, "0.0.0.0:9194")`. - diff --git a/extensions/storage/configuration.md b/extensions/storage/configuration.md index 33c8f2fcfb6..0166411edf2 100644 --- a/extensions/storage/configuration.md +++ b/extensions/storage/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-06-23T17:40:18+0000" +date: "2021-06-24T01:51:59+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/storage/templates @@ -55,66 +55,6 @@ Usage: `storage [global options] command [command options] [arguments...]` ## Sub Commands -### storage health - -Check health status - -Usage: `storage health [command options] [arguments...]` - --debug-addr | $STORAGE_DEBUG_ADDR -: Address to debug endpoint. Default: `flags.OverrideDefaultString(cfg.Debug.Addr, "0.0.0.0:9109")`. - -### storage storage-home - -Start storage-home service - -Usage: `storage storage-home [command options] [arguments...]` - --debug-addr | $STORAGE_HOME_DEBUG_ADDR -: Address to bind debug server. Default: `flags.OverrideDefaultString(cfg.Reva.StorageHome.DebugAddr, "0.0.0.0:9156")`. - --grpc-network | $STORAGE_HOME_GRPC_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `flags.OverrideDefaultString(cfg.Reva.StorageHome.GRPCNetwork, "tcp")`. - --grpc-addr | $STORAGE_HOME_GRPC_ADDR -: Address to bind storage service. Default: `flags.OverrideDefaultString(cfg.Reva.StorageHome.GRPCAddr, "0.0.0.0:9154")`. - --http-network | $STORAGE_HOME_HTTP_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `flags.OverrideDefaultString(cfg.Reva.StorageHome.HTTPNetwork, "tcp")`. - --http-addr | $STORAGE_HOME_HTTP_ADDR -: Address to bind storage service. Default: `flags.OverrideDefaultString(cfg.Reva.StorageHome.HTTPAddr, "0.0.0.0:9155")`. - --driver | $STORAGE_HOME_DRIVER -: storage driver for home mount: eg. local, eos, owncloud, ocis or s3. Default: `flags.OverrideDefaultString(cfg.Reva.StorageHome.Driver, "ocis")`. - --mount-path | $STORAGE_HOME_MOUNT_PATH -: mount path. Default: `flags.OverrideDefaultString(cfg.Reva.StorageHome.MountPath, "/home")`. - --mount-id | $STORAGE_HOME_MOUNT_ID -: mount id. Default: `flags.OverrideDefaultString(cfg.Reva.StorageHome.MountID, "1284d238-aa92-42ce-bdc4-0b0000009157")`. - --expose-data-server | $STORAGE_HOME_EXPOSE_DATA_SERVER -: exposes a dedicated data server. Default: `flags.OverrideDefaultBool(cfg.Reva.StorageHome.ExposeDataServer, false)`. - --data-server-url | $STORAGE_HOME_DATA_SERVER_URL -: data server url. Default: `flags.OverrideDefaultString(cfg.Reva.StorageHome.DataServerURL, "http://localhost:9155/data")`. - --http-prefix | $STORAGE_HOME_HTTP_PREFIX -: prefix for the http endpoint, without leading slash. Default: `flags.OverrideDefaultString(cfg.Reva.StorageHome.HTTPPrefix, "data")`. - --tmp-folder | $STORAGE_HOME_TMP_FOLDER -: path to tmp folder. Default: `flags.OverrideDefaultString(cfg.Reva.StorageHome.TempFolder, "/var/tmp/ocis/tmp/home")`. - --enable-home | $STORAGE_HOME_ENABLE_HOME -: enable the creation of home directories. Default: `flags.OverrideDefaultBool(cfg.Reva.Storages.Home.EnableHome, true)`. - --gateway-endpoint | $STORAGE_GATEWAY_ENDPOINT -: endpoint to use for the storage gateway service. Default: `flags.OverrideDefaultString(cfg.Reva.Gateway.Endpoint, "localhost:9142")`. - --users-endpoint | $STORAGE_USERPROVIDER_ENDPOINT -: endpoint to use for the storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Users.Endpoint, "localhost:9144")`. - ### storage auth-basic Start authprovider for basic auth @@ -193,23 +133,125 @@ Usage: `storage frontend [command options] [arguments...]` -checksum-preferred-upload-type | $STORAGE_FRONTEND_CHECKSUM_PREFERRED_UPLOAD_TYPE : Specify the preferred checksum algorithm used for uploads. Default: `flags.OverrideDefaultString(cfg.Reva.ChecksumPreferredUploadType, "")`. -### storage storage +### storage gateway -Storage service for oCIS +Start gateway -Usage: `storage storage [command options] [arguments...]` +Usage: `storage gateway [command options] [arguments...]` --config-file | $STORAGE_CONFIG_FILE -: Path to config file. +-debug-addr | $STORAGE_GATEWAY_DEBUG_ADDR +: Address to bind debug server. Default: `flags.OverrideDefaultString(cfg.Reva.Gateway.DebugAddr, "0.0.0.0:9143")`. --log-level | $STORAGE_LOG_LEVEL , $OCIS_LOG_LEVEL -: Set logging level. +-transfer-secret | $STORAGE_TRANSFER_SECRET +: Transfer secret for datagateway. Default: `flags.OverrideDefaultString(cfg.Reva.TransferSecret, "replace-me-with-a-transfer-secret")`. --log-pretty | $STORAGE_LOG_PRETTY , $OCIS_LOG_PRETTY -: Enable pretty logging. +-network | $STORAGE_GATEWAY_GRPC_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `flags.OverrideDefaultString(cfg.Reva.Gateway.GRPCNetwork, "tcp")`. --log-color | $STORAGE_LOG_COLOR , $OCIS_LOG_COLOR -: Enable colored logging. +-addr | $STORAGE_GATEWAY_GRPC_ADDR +: Address to bind storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Gateway.GRPCAddr, "0.0.0.0:9142")`. + +-endpoint | $STORAGE_GATEWAY_ENDPOINT +: endpoint to use for the storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Gateway.Endpoint, "localhost:9142")`. + +-commit-share-to-storage-grant | $STORAGE_GATEWAY_COMMIT_SHARE_TO_STORAGE_GRANT +: Commit shares to the share manager. Default: `flags.OverrideDefaultBool(cfg.Reva.Gateway.CommitShareToStorageGrant, true)`. + +-commit-share-to-storage-ref | $STORAGE_GATEWAY_COMMIT_SHARE_TO_STORAGE_REF +: Commit shares to the storage. Default: `flags.OverrideDefaultBool(cfg.Reva.Gateway.CommitShareToStorageRef, true)`. + +-share-folder | $STORAGE_GATEWAY_SHARE_FOLDER +: mount shares in this folder of the home storage provider. Default: `flags.OverrideDefaultString(cfg.Reva.Gateway.ShareFolder, "Shares")`. + +-disable-home-creation-on-login | $STORAGE_GATEWAY_DISABLE_HOME_CREATION_ON_LOGIN +: Disable creation of home folder on login. + +-storage-home-mapping | $STORAGE_GATEWAY_HOME_MAPPING +: mapping template for user home paths to user-specific mount points, e.g. /home/{{substr 0 1 .Username}}. Default: `flags.OverrideDefaultString(cfg.Reva.Gateway.HomeMapping, "")`. + +-auth-basic-endpoint | $STORAGE_AUTH_BASIC_ENDPOINT +: endpoint to use for the basic auth provider. Default: `flags.OverrideDefaultString(cfg.Reva.AuthBasic.Endpoint, "localhost:9146")`. + +-auth-bearer-endpoint | $STORAGE_AUTH_BEARER_ENDPOINT +: endpoint to use for the bearer auth provider. Default: `flags.OverrideDefaultString(cfg.Reva.AuthBearer.Endpoint, "localhost:9148")`. + +-storage-registry-driver | $STORAGE_STORAGE_REGISTRY_DRIVER +: driver of the storage registry. Default: `flags.OverrideDefaultString(cfg.Reva.StorageRegistry.Driver, "static")`. + +-storage-home-provider | $STORAGE_STORAGE_REGISTRY_HOME_PROVIDER +: mount point of the storage provider for user homes in the global namespace. Default: `flags.OverrideDefaultString(cfg.Reva.StorageRegistry.HomeProvider, "/home")`. + +-storage-registry-json | $STORAGE_STORAGE_REGISTRY_JSON +: JSON file containing the storage registry rules. Default: `flags.OverrideDefaultString(cfg.Reva.StorageRegistry.JSON, "")`. + +-public-url | $STORAGE_FRONTEND_PUBLIC_URL , $OCIS_URL +: URL to use for the storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Frontend.PublicURL, "https://localhost:9200")`. + +-datagateway-url | $STORAGE_DATAGATEWAY_PUBLIC_URL +: URL to use for the storage datagateway, defaults to /data. Default: `flags.OverrideDefaultString(cfg.Reva.DataGateway.PublicURL, "")`. + +-userprovider-endpoint | $STORAGE_USERPROVIDER_ENDPOINT +: endpoint to use for the userprovider. Default: `flags.OverrideDefaultString(cfg.Reva.Users.Endpoint, "localhost:9144")`. + +-groupprovider-endpoint | $STORAGE_GROUPPROVIDER_ENDPOINT +: endpoint to use for the groupprovider. Default: `flags.OverrideDefaultString(cfg.Reva.Groups.Endpoint, "localhost:9160")`. + +-sharing-endpoint | $STORAGE_SHARING_ENDPOINT +: endpoint to use for the storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Sharing.Endpoint, "localhost:9150")`. + +-storage-home-endpoint | $STORAGE_HOME_ENDPOINT +: endpoint to use for the home storage. Default: `flags.OverrideDefaultString(cfg.Reva.StorageHome.Endpoint, "localhost:9154")`. + +-storage-home-mount-path | $STORAGE_HOME_MOUNT_PATH +: mount path. Default: `flags.OverrideDefaultString(cfg.Reva.StorageHome.MountPath, "/home")`. + +-storage-home-mount-id | $STORAGE_HOME_MOUNT_ID +: mount id. Default: `flags.OverrideDefaultString(cfg.Reva.StorageHome.MountID, "1284d238-aa92-42ce-bdc4-0b0000009154")`. + +-storage-users-endpoint | $STORAGE_USERS_ENDPOINT +: endpoint to use for the users storage. Default: `flags.OverrideDefaultString(cfg.Reva.StorageUsers.Endpoint, "localhost:9157")`. + +-storage-users-mount-path | $STORAGE_USERS_MOUNT_PATH +: mount path. Default: `flags.OverrideDefaultString(cfg.Reva.StorageUsers.MountPath, "/users")`. + +-storage-users-mount-id | $STORAGE_USERS_MOUNT_ID +: mount id. Default: `flags.OverrideDefaultString(cfg.Reva.StorageUsers.MountID, "1284d238-aa92-42ce-bdc4-0b0000009157")`. + +-public-link-endpoint | $STORAGE_PUBLIC_LINK_ENDPOINT +: endpoint to use for the public links service. Default: `flags.OverrideDefaultString(cfg.Reva.StoragePublicLink.Endpoint, "localhost:9178")`. + +-storage-public-link-mount-path | $STORAGE_PUBLIC_LINK_MOUNT_PATH +: mount path. Default: `flags.OverrideDefaultString(cfg.Reva.StoragePublicLink.MountPath, "/public")`. + +### storage groups + +Start groups service + +Usage: `storage groups [command options] [arguments...]` + +-debug-addr | $STORAGE_GROUPPROVIDER_DEBUG_ADDR +: Address to bind debug server. Default: `flags.OverrideDefaultString(cfg.Reva.Groups.DebugAddr, "0.0.0.0:9161")`. + +-network | $STORAGE_GROUPPROVIDER_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `flags.OverrideDefaultString(cfg.Reva.Groups.GRPCNetwork, "tcp")`. + +-addr | $STORAGE_GROUPPROVIDER_ADDR +: Address to bind storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Groups.GRPCAddr, "0.0.0.0:9160")`. + +-endpoint | $STORAGE_GROUPPROVIDER_ENDPOINT +: URL to use for the storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Groups.Endpoint, "localhost:9160")`. + +-driver | $STORAGE_GROUPPROVIDER_DRIVER +: group driver: 'json', 'ldap', or 'rest'. Default: `flags.OverrideDefaultString(cfg.Reva.Groups.Driver, "ldap")`. + +-json-config | $STORAGE_GROUPPROVIDER_JSON +: Path to groups.json file. Default: `flags.OverrideDefaultString(cfg.Reva.Groups.JSON, "")`. + +### storage storage-metadata + +Start storage-metadata service + +Usage: `storage storage-metadata [command options] [arguments...]` ### storage storage-users @@ -316,6 +358,33 @@ Usage: `storage auth-bearer [command options] [arguments...]` -gateway-url | $STORAGE_GATEWAY_ENDPOINT : URL to use for the storage gateway service. Default: `flags.OverrideDefaultString(cfg.Reva.Gateway.Endpoint, "localhost:9142")`. +### storage health + +Check health status + +Usage: `storage health [command options] [arguments...]` + +-debug-addr | $STORAGE_DEBUG_ADDR +: Address to debug endpoint. Default: `flags.OverrideDefaultString(cfg.Debug.Addr, "0.0.0.0:9109")`. + +### storage storage + +Storage service for oCIS + +Usage: `storage storage [command options] [arguments...]` + +-config-file | $STORAGE_CONFIG_FILE +: Path to config file. + +-log-level | $STORAGE_LOG_LEVEL , $OCIS_LOG_LEVEL +: Set logging level. + +-log-pretty | $STORAGE_LOG_PRETTY , $OCIS_LOG_PRETTY +: Enable pretty logging. + +-log-color | $STORAGE_LOG_COLOR , $OCIS_LOG_COLOR +: Enable colored logging. + ### storage sharing Start sharing service @@ -346,125 +415,56 @@ Usage: `storage sharing [command options] [arguments...]` -public-enable-expired-shares-cleanup | $STORAGE_SHARING_PUBLIC_ENABLE_EXPIRED_SHARES_CLEANUP : whether to periodically delete expired public shares. Default: `flags.OverrideDefaultBool(cfg.Reva.Sharing.PublicEnableExpiredSharesCleanup, true)`. -### storage storage-metadata - -Start storage-metadata service - -Usage: `storage storage-metadata [command options] [arguments...]` - -### storage gateway - -Start gateway - -Usage: `storage gateway [command options] [arguments...]` - --debug-addr | $STORAGE_GATEWAY_DEBUG_ADDR -: Address to bind debug server. Default: `flags.OverrideDefaultString(cfg.Reva.Gateway.DebugAddr, "0.0.0.0:9143")`. - --transfer-secret | $STORAGE_TRANSFER_SECRET -: Transfer secret for datagateway. Default: `flags.OverrideDefaultString(cfg.Reva.TransferSecret, "replace-me-with-a-transfer-secret")`. - --network | $STORAGE_GATEWAY_GRPC_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `flags.OverrideDefaultString(cfg.Reva.Gateway.GRPCNetwork, "tcp")`. - --addr | $STORAGE_GATEWAY_GRPC_ADDR -: Address to bind storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Gateway.GRPCAddr, "0.0.0.0:9142")`. - --endpoint | $STORAGE_GATEWAY_ENDPOINT -: endpoint to use for the storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Gateway.Endpoint, "localhost:9142")`. - --commit-share-to-storage-grant | $STORAGE_GATEWAY_COMMIT_SHARE_TO_STORAGE_GRANT -: Commit shares to the share manager. Default: `flags.OverrideDefaultBool(cfg.Reva.Gateway.CommitShareToStorageGrant, true)`. - --commit-share-to-storage-ref | $STORAGE_GATEWAY_COMMIT_SHARE_TO_STORAGE_REF -: Commit shares to the storage. Default: `flags.OverrideDefaultBool(cfg.Reva.Gateway.CommitShareToStorageRef, true)`. - --share-folder | $STORAGE_GATEWAY_SHARE_FOLDER -: mount shares in this folder of the home storage provider. Default: `flags.OverrideDefaultString(cfg.Reva.Gateway.ShareFolder, "Shares")`. - --disable-home-creation-on-login | $STORAGE_GATEWAY_DISABLE_HOME_CREATION_ON_LOGIN -: Disable creation of home folder on login. - --storage-home-mapping | $STORAGE_GATEWAY_HOME_MAPPING -: mapping template for user home paths to user-specific mount points, e.g. /home/{{substr 0 1 .Username}}. Default: `flags.OverrideDefaultString(cfg.Reva.Gateway.HomeMapping, "")`. - --auth-basic-endpoint | $STORAGE_AUTH_BASIC_ENDPOINT -: endpoint to use for the basic auth provider. Default: `flags.OverrideDefaultString(cfg.Reva.AuthBasic.Endpoint, "localhost:9146")`. - --auth-bearer-endpoint | $STORAGE_AUTH_BEARER_ENDPOINT -: endpoint to use for the bearer auth provider. Default: `flags.OverrideDefaultString(cfg.Reva.AuthBearer.Endpoint, "localhost:9148")`. - --storage-registry-driver | $STORAGE_STORAGE_REGISTRY_DRIVER -: driver of the storage registry. Default: `flags.OverrideDefaultString(cfg.Reva.StorageRegistry.Driver, "static")`. +### storage storage-home --storage-home-provider | $STORAGE_STORAGE_REGISTRY_HOME_PROVIDER -: mount point of the storage provider for user homes in the global namespace. Default: `flags.OverrideDefaultString(cfg.Reva.StorageRegistry.HomeProvider, "/home")`. +Start storage-home service --storage-registry-json | $STORAGE_STORAGE_REGISTRY_JSON -: JSON file containing the storage registry rules. Default: `flags.OverrideDefaultString(cfg.Reva.StorageRegistry.JSON, "")`. +Usage: `storage storage-home [command options] [arguments...]` --public-url | $STORAGE_FRONTEND_PUBLIC_URL , $OCIS_URL -: URL to use for the storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Frontend.PublicURL, "https://localhost:9200")`. +-debug-addr | $STORAGE_HOME_DEBUG_ADDR +: Address to bind debug server. Default: `flags.OverrideDefaultString(cfg.Reva.StorageHome.DebugAddr, "0.0.0.0:9156")`. --datagateway-url | $STORAGE_DATAGATEWAY_PUBLIC_URL -: URL to use for the storage datagateway, defaults to /data. Default: `flags.OverrideDefaultString(cfg.Reva.DataGateway.PublicURL, "")`. +-grpc-network | $STORAGE_HOME_GRPC_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `flags.OverrideDefaultString(cfg.Reva.StorageHome.GRPCNetwork, "tcp")`. --userprovider-endpoint | $STORAGE_USERPROVIDER_ENDPOINT -: endpoint to use for the userprovider. Default: `flags.OverrideDefaultString(cfg.Reva.Users.Endpoint, "localhost:9144")`. +-grpc-addr | $STORAGE_HOME_GRPC_ADDR +: Address to bind storage service. Default: `flags.OverrideDefaultString(cfg.Reva.StorageHome.GRPCAddr, "0.0.0.0:9154")`. --groupprovider-endpoint | $STORAGE_GROUPPROVIDER_ENDPOINT -: endpoint to use for the groupprovider. Default: `flags.OverrideDefaultString(cfg.Reva.Groups.Endpoint, "localhost:9160")`. +-http-network | $STORAGE_HOME_HTTP_NETWORK +: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `flags.OverrideDefaultString(cfg.Reva.StorageHome.HTTPNetwork, "tcp")`. --sharing-endpoint | $STORAGE_SHARING_ENDPOINT -: endpoint to use for the storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Sharing.Endpoint, "localhost:9150")`. +-http-addr | $STORAGE_HOME_HTTP_ADDR +: Address to bind storage service. Default: `flags.OverrideDefaultString(cfg.Reva.StorageHome.HTTPAddr, "0.0.0.0:9155")`. --storage-home-endpoint | $STORAGE_HOME_ENDPOINT -: endpoint to use for the home storage. Default: `flags.OverrideDefaultString(cfg.Reva.StorageHome.Endpoint, "localhost:9154")`. +-driver | $STORAGE_HOME_DRIVER +: storage driver for home mount: eg. local, eos, owncloud, ocis or s3. Default: `flags.OverrideDefaultString(cfg.Reva.StorageHome.Driver, "ocis")`. --storage-home-mount-path | $STORAGE_HOME_MOUNT_PATH +-mount-path | $STORAGE_HOME_MOUNT_PATH : mount path. Default: `flags.OverrideDefaultString(cfg.Reva.StorageHome.MountPath, "/home")`. --storage-home-mount-id | $STORAGE_HOME_MOUNT_ID -: mount id. Default: `flags.OverrideDefaultString(cfg.Reva.StorageHome.MountID, "1284d238-aa92-42ce-bdc4-0b0000009154")`. - --storage-users-endpoint | $STORAGE_USERS_ENDPOINT -: endpoint to use for the users storage. Default: `flags.OverrideDefaultString(cfg.Reva.StorageUsers.Endpoint, "localhost:9157")`. - --storage-users-mount-path | $STORAGE_USERS_MOUNT_PATH -: mount path. Default: `flags.OverrideDefaultString(cfg.Reva.StorageUsers.MountPath, "/users")`. - --storage-users-mount-id | $STORAGE_USERS_MOUNT_ID -: mount id. Default: `flags.OverrideDefaultString(cfg.Reva.StorageUsers.MountID, "1284d238-aa92-42ce-bdc4-0b0000009157")`. - --public-link-endpoint | $STORAGE_PUBLIC_LINK_ENDPOINT -: endpoint to use for the public links service. Default: `flags.OverrideDefaultString(cfg.Reva.StoragePublicLink.Endpoint, "localhost:9178")`. - --storage-public-link-mount-path | $STORAGE_PUBLIC_LINK_MOUNT_PATH -: mount path. Default: `flags.OverrideDefaultString(cfg.Reva.StoragePublicLink.MountPath, "/public")`. - -### storage groups - -Start groups service +-mount-id | $STORAGE_HOME_MOUNT_ID +: mount id. Default: `flags.OverrideDefaultString(cfg.Reva.StorageHome.MountID, "1284d238-aa92-42ce-bdc4-0b0000009157")`. -Usage: `storage groups [command options] [arguments...]` +-expose-data-server | $STORAGE_HOME_EXPOSE_DATA_SERVER +: exposes a dedicated data server. Default: `flags.OverrideDefaultBool(cfg.Reva.StorageHome.ExposeDataServer, false)`. --debug-addr | $STORAGE_GROUPPROVIDER_DEBUG_ADDR -: Address to bind debug server. Default: `flags.OverrideDefaultString(cfg.Reva.Groups.DebugAddr, "0.0.0.0:9161")`. +-data-server-url | $STORAGE_HOME_DATA_SERVER_URL +: data server url. Default: `flags.OverrideDefaultString(cfg.Reva.StorageHome.DataServerURL, "http://localhost:9155/data")`. --network | $STORAGE_GROUPPROVIDER_NETWORK -: Network to use for the storage service, can be 'tcp', 'udp' or 'unix'. Default: `flags.OverrideDefaultString(cfg.Reva.Groups.GRPCNetwork, "tcp")`. +-http-prefix | $STORAGE_HOME_HTTP_PREFIX +: prefix for the http endpoint, without leading slash. Default: `flags.OverrideDefaultString(cfg.Reva.StorageHome.HTTPPrefix, "data")`. --addr | $STORAGE_GROUPPROVIDER_ADDR -: Address to bind storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Groups.GRPCAddr, "0.0.0.0:9160")`. +-tmp-folder | $STORAGE_HOME_TMP_FOLDER +: path to tmp folder. Default: `flags.OverrideDefaultString(cfg.Reva.StorageHome.TempFolder, "/var/tmp/ocis/tmp/home")`. --endpoint | $STORAGE_GROUPPROVIDER_ENDPOINT -: URL to use for the storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Groups.Endpoint, "localhost:9160")`. +-enable-home | $STORAGE_HOME_ENABLE_HOME +: enable the creation of home directories. Default: `flags.OverrideDefaultBool(cfg.Reva.Storages.Home.EnableHome, true)`. --driver | $STORAGE_GROUPPROVIDER_DRIVER -: group driver: 'json', 'ldap', or 'rest'. Default: `flags.OverrideDefaultString(cfg.Reva.Groups.Driver, "ldap")`. +-gateway-endpoint | $STORAGE_GATEWAY_ENDPOINT +: endpoint to use for the storage gateway service. Default: `flags.OverrideDefaultString(cfg.Reva.Gateway.Endpoint, "localhost:9142")`. --json-config | $STORAGE_GROUPPROVIDER_JSON -: Path to groups.json file. Default: `flags.OverrideDefaultString(cfg.Reva.Groups.JSON, "")`. +-users-endpoint | $STORAGE_USERPROVIDER_ENDPOINT +: endpoint to use for the storage service. Default: `flags.OverrideDefaultString(cfg.Reva.Users.Endpoint, "localhost:9144")`. ### storage storage-public-link diff --git a/extensions/store/configuration.md b/extensions/store/configuration.md index b49cb123ae2..63d2eaaeffc 100644 --- a/extensions/store/configuration.md +++ b/extensions/store/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-06-23T17:40:18+0000" +date: "2021-06-24T01:51:59+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/store/templates diff --git a/extensions/thumbnails/configuration.md b/extensions/thumbnails/configuration.md index edd44fbecde..09f106f1e5d 100644 --- a/extensions/thumbnails/configuration.md +++ b/extensions/thumbnails/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-06-23T17:40:19+0000" +date: "2021-06-24T01:51:59+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/thumbnails/templates diff --git a/extensions/web/configuration.md b/extensions/web/configuration.md index 704d79fc9cf..5ee9b6e9215 100644 --- a/extensions/web/configuration.md +++ b/extensions/web/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-06-23T17:40:19+0000" +date: "2021-06-24T01:52:00+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/web/templates diff --git a/extensions/webdav/configuration.md b/extensions/webdav/configuration.md index 030d236993d..72b95807fd1 100644 --- a/extensions/webdav/configuration.md +++ b/extensions/webdav/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-06-23T17:40:19+0000" +date: "2021-06-24T01:52:00+0000" weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/webdav/templates diff --git a/ocis/configuration.md b/ocis/configuration.md index fc72d74f4c9..0f72e90d9b6 100644 --- a/ocis/configuration.md +++ b/ocis/configuration.md @@ -1,6 +1,6 @@ --- title: "Configuration" -date: "2021-06-23T17:40:17+0000" +date: "2021-06-24T01:51:58+0000" weight: 2 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/ocis/templates @@ -86,18 +86,6 @@ Usage: `ocis [global options] command [command options] [arguments...]` ## Sub Commands -### ocis run - -Runs an extension - -Usage: `ocis run [command options] [arguments...]` - -### ocis kill - -Kill an extension by name - -Usage: `ocis kill [command options] [arguments...]` - ### ocis health Check health status @@ -107,12 +95,24 @@ Usage: `ocis health [command options] [arguments...]` -debug-addr | $OCIS_DEBUG_ADDR : Address to debug endpoint. Default: `0.0.0.0:9010`. +### ocis kill + +Kill an extension by name + +Usage: `ocis kill [command options] [arguments...]` + ### ocis list Lists running ocis extensions Usage: `ocis list [command options] [arguments...]` +### ocis run + +Runs an extension + +Usage: `ocis run [command options] [arguments...]` + ### ocis server Start fullstack server @@ -144,6 +144,10 @@ Usage: `ocis server [command options] [arguments...]` There are more subcommands to start the individual extensions. Please check the documentation about their usage and options in the dedicated section of the documentation. +#### ocis storage-gateway + +Start storage gateway + #### ocis storage-metadata Start storage and data service for metadata @@ -152,87 +156,83 @@ Start storage and data service for metadata Start thumbnails server -#### ocis storage-auth-bearer +#### ocis glauth -Start storage auth-bearer service +Start glauth server + +#### ocis storage-userprovider + +Start storage userprovider service #### ocis storage-sharing Start storage sharing service -#### ocis idp +#### ocis storage-auth-bearer -Start idp server +Start storage auth-bearer service -#### ocis storage-public-link +#### ocis storage-groupprovider -Start storage public link storage +Start storage groupprovider service -#### ocis version +#### ocis proxy -Lists running services with version +Start proxy server #### ocis web Start web server -#### ocis accounts +#### ocis storage-auth-basic -Start accounts server +Start storage auth-basic service -#### ocis ocs +#### ocis storage-public-link -Start ocs server +Start storage public link storage -#### ocis storage-auth-basic +#### ocis version -Start storage auth-basic service +Lists running services with version -#### ocis storage-users +#### ocis ocs -Start storage and data provider for /users mount +Start ocs server -#### ocis store +#### ocis settings -Start a go-micro store +Start settings server -#### ocis glauth +#### ocis storage-home -Start glauth server +Start storage and data provider for /home mount -#### ocis storage-gateway +#### ocis store -Start storage gateway +Start a go-micro store -#### ocis proxy +#### ocis accounts -Start proxy server +Start accounts server -#### ocis storage-userprovider +#### ocis storage-users -Start storage userprovider service +Start storage and data provider for /users mount #### ocis storage-frontend Start storage frontend -#### ocis storage-home - -Start storage and data provider for /home mount - #### ocis webdav Start webdav server -#### ocis onlyoffice - -Start onlyoffice server - -#### ocis settings +#### ocis idp -Start settings server +Start idp server -#### ocis storage-groupprovider +#### ocis onlyoffice -Start storage groupprovider service +Start onlyoffice server