Skip to content

Commit

Permalink
commit 4d021ae
Browse files Browse the repository at this point in the history
Merge: 05f60af 192fa11
Author: Alex Unger <6905948+refs@users.noreply.github.com>
Date:   Wed Mar 17 22:51:30 2021 +0100

    Merge pull request #1816 from owncloud/file-logging-ocis-1666
  • Loading branch information
refs committed Mar 17, 2021
1 parent 30b8048 commit e006cfe
Show file tree
Hide file tree
Showing 15 changed files with 436 additions and 403 deletions.
75 changes: 39 additions & 36 deletions extensions/accounts/configuration.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Configuration"
date: "2021-03-17T14:28:19+0000"
date: "2021-03-17T21:52:18+0000"
weight: 20
geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/accounts/templates
Expand Down Expand Up @@ -35,33 +35,39 @@ 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 rebuildIndex
### accounts inspect

Rebuilds the service's index, i.e. deleting and then re-adding all existing documents
Show detailed data on an existing account

Usage: `accounts rebuildIndex [command options] [arguments...]`
Usage: `accounts inspect [command options] [arguments...]`

### accounts ocis-accounts
-grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE
: Set the base namespace for the grpc namespace. Default: `flags.OverrideDefaultString(cfg.GRPC.Namespace, "com.owncloud.api")`.

Provide accounts and groups for oCIS
-name | $ACCOUNTS_NAME
: service name. Default: `flags.OverrideDefaultString(cfg.Server.Name, "accounts")`.

Usage: `accounts ocis-accounts [command options] [arguments...]`
### accounts remove

-log-level | $ACCOUNTS_LOG_LEVEL , $OCIS_LOG_LEVEL
: Set logging level.
Removes an existing account

-log-pretty | $ACCOUNTS_LOG_PRETTY , $OCIS_LOG_PRETTY
: Enable pretty logging.
Usage: `accounts remove [command options] [arguments...]`

-log-color | $ACCOUNTS_LOG_COLOR , $OCIS_LOG_COLOR
: Enable colored logging.
-grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE
: Set the base namespace for the grpc namespace. Default: `flags.OverrideDefaultString(cfg.GRPC.Namespace, "com.owncloud.api")`.

-name | $ACCOUNTS_NAME
: service name. Default: `flags.OverrideDefaultString(cfg.Server.Name, "accounts")`.

### accounts server

Start ocis accounts service

Usage: `accounts server [command options] [arguments...]`

-log-file | $ACCOUNTS_LOG_FILE , $OCIS_LOG_FILE
: Enable log to file.

-tracing-enabled | $ACCOUNTS_TRACING_ENABLED
: Enable sending traces.

Expand Down Expand Up @@ -122,17 +128,17 @@ 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 inspect
### accounts update

Show detailed data on an existing account
Make changes to an existing account

Usage: `accounts inspect [command options] [arguments...]`
Usage: `accounts update [command options] [arguments...]`

-grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE
: Set the base namespace for the grpc namespace. Default: `flags.OverrideDefaultString(cfg.GRPC.Namespace, "com.owncloud.api")`.
### accounts add

-name | $ACCOUNTS_NAME
: service name. Default: `flags.OverrideDefaultString(cfg.Server.Name, "accounts")`.
Create a new account

Usage: `accounts add [command options] [arguments...]`

### accounts list

Expand All @@ -146,23 +152,26 @@ Usage: `accounts list [command options] [arguments...]`
-name | $ACCOUNTS_NAME
: service name. Default: `flags.OverrideDefaultString(cfg.Server.Name, "accounts")`.

### accounts remove
### accounts rebuildIndex

Removes an existing account
Rebuilds the service's index, i.e. deleting and then re-adding all existing documents

Usage: `accounts remove [command options] [arguments...]`
Usage: `accounts rebuildIndex [command options] [arguments...]`

-grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE
: Set the base namespace for the grpc namespace. Default: `flags.OverrideDefaultString(cfg.GRPC.Namespace, "com.owncloud.api")`.
### accounts ocis-accounts

-name | $ACCOUNTS_NAME
: service name. Default: `flags.OverrideDefaultString(cfg.Server.Name, "accounts")`.
Provide accounts and groups for oCIS

### accounts update
Usage: `accounts ocis-accounts [command options] [arguments...]`

Make changes to an existing account
-log-level | $ACCOUNTS_LOG_LEVEL , $OCIS_LOG_LEVEL
: Set logging level.

Usage: `accounts update [command options] [arguments...]`
-log-pretty | $ACCOUNTS_LOG_PRETTY , $OCIS_LOG_PRETTY
: Enable pretty logging.

-log-color | $ACCOUNTS_LOG_COLOR , $OCIS_LOG_COLOR
: Enable colored logging.

### accounts version

Expand All @@ -176,9 +185,3 @@ 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...]`

53 changes: 28 additions & 25 deletions extensions/glauth/configuration.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Configuration"
date: "2021-03-17T14:29:12+0000"
date: "2021-03-17T21:53:03+0000"
weight: 20
geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/glauth/templates
Expand Down Expand Up @@ -35,12 +35,39 @@ 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

Usage: `glauth ocis-glauth [command options] [arguments...]`

-log-level | $GLAUTH_LOG_LEVEL , $OCIS_LOG_LEVEL
: Set logging level.

-log-pretty | $GLAUTH_LOG_PRETTY , $OCIS_LOG_PRETTY
: Enable pretty logging.

-log-color | $GLAUTH_LOG_COLOR , $OCIS_LOG_COLOR
: Enable colored logging.

### 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, "")`.

Expand Down Expand Up @@ -134,27 +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")`.

### glauth ocis-glauth

Serve GLAuth API for oCIS

Usage: `glauth ocis-glauth [command options] [arguments...]`

-log-level | $GLAUTH_LOG_LEVEL , $OCIS_LOG_LEVEL
: Set logging level.

-log-pretty | $GLAUTH_LOG_PRETTY , $OCIS_LOG_PRETTY
: Enable pretty logging.

-log-color | $GLAUTH_LOG_COLOR , $OCIS_LOG_COLOR
: Enable colored logging.

5 changes: 4 additions & 1 deletion extensions/graph-explorer/configuration.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Configuration"
date: "2021-03-17T14:29:12+0000"
date: "2021-03-17T21:53:03+0000"
weight: 20
geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/graph-explorer/templates
Expand Down Expand Up @@ -58,6 +58,9 @@ Start integrated server

Usage: `graph-explorer server [command options] [arguments...]`

-log-file | $GRAPH_EXPLORER_LOG_FILE , $OCIS_LOG_FILE
: Enable log to file.

-tracing-enabled | $GRAPH_EXPLORER_TRACING_ENABLED
: Enable sending traces.

Expand Down
5 changes: 4 additions & 1 deletion extensions/graph/configuration.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Configuration"
date: "2021-03-17T14:29:12+0000"
date: "2021-03-17T21:53:03+0000"
weight: 20
geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/graph/templates
Expand Down Expand Up @@ -68,6 +68,9 @@ Start integrated server

Usage: `graph server [command options] [arguments...]`

-log-file | $GRAPH_LOG_FILE , $OCIS_LOG_FILE
: Enable log to file.

-tracing-enabled | $GRAPH_TRACING_ENABLED
: Enable sending traces.

Expand Down
5 changes: 4 additions & 1 deletion extensions/idp/configuration.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Configuration"
date: "2021-03-17T14:29:12+0000"
date: "2021-03-17T21:53:03+0000"
weight: 20
geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/idp/templates
Expand Down Expand Up @@ -65,6 +65,9 @@ Start integrated server

Usage: `idp server [command options] [arguments...]`

-log-file | $IDP_LOG_FILE , $OCIS_LOG_FILE
: Enable log to file.

-config-file | $IDP_CONFIG_FILE
: Path to config file. Default: `flags.OverrideDefaultString(cfg.File, "")`.

Expand Down
5 changes: 4 additions & 1 deletion extensions/ocs/configuration.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Configuration"
date: "2021-03-17T14:29:12+0000"
date: "2021-03-17T21:53:03+0000"
weight: 20
geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/ocs/templates
Expand Down Expand Up @@ -56,6 +56,9 @@ Start integrated server

Usage: `ocs server [command options] [arguments...]`

-log-file | $OCS_LOG_FILE , $OCIS_LOG_FILE
: Enable log to file.

-log-level | $OCS_LOG_LEVEL , $OCIS_LOG_LEVEL
: Set logging level.

Expand Down
5 changes: 4 additions & 1 deletion extensions/onlyoffice/configuration.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Configuration"
date: "2021-03-17T14:29:12+0000"
date: "2021-03-17T21:53:03+0000"
weight: 20
geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/onlyoffice/templates
Expand Down Expand Up @@ -74,6 +74,9 @@ Start integrated server

Usage: `onlyoffice server [command options] [arguments...]`

-log-file | $ONLYOFFICE_LOG_FILE , $OCIS_LOG_FILE
: Enable log to file.

-tracing-enabled | $ONLYOFFICE_TRACING_ENABLED
: Enable sending traces.

Expand Down
26 changes: 13 additions & 13 deletions extensions/proxy/configuration.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Configuration"
date: "2021-03-17T14:29:12+0000"
date: "2021-03-17T21:53:03+0000"
weight: 20
geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/proxy/templates
Expand Down Expand Up @@ -35,18 +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 version

Print the versions of the running instances

Usage: `proxy version [command options] [arguments...]`

--service-namespace | $PROXY_SERVICE_NAMESPACE
: Set the base namespace for the service namespace. Default: `flags.OverrideDefaultString(cfg.OIDC.Issuer, "com.owncloud.web")`.

--service-name | $PROXY_SERVICE_NAME
: Service name. Default: `flags.OverrideDefaultString(cfg.Service.Name, "proxy")`.

### proxy health

Check health status
Expand Down Expand Up @@ -77,3 +65,15 @@ Start integrated server

Usage: `proxy server [command options] [arguments...]`

### proxy version

Print the versions of the running instances

Usage: `proxy version [command options] [arguments...]`

--service-namespace | $PROXY_SERVICE_NAMESPACE
: Set the base namespace for the service namespace. Default: `flags.OverrideDefaultString(cfg.OIDC.Issuer, "com.owncloud.web")`.

--service-name | $PROXY_SERVICE_NAME
: Service name. Default: `flags.OverrideDefaultString(cfg.Service.Name, "proxy")`.

20 changes: 10 additions & 10 deletions extensions/settings/configuration.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Configuration"
date: "2021-03-17T14:29:12+0000"
date: "2021-03-17T21:53:03+0000"
weight: 20
geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/settings/templates
Expand Down Expand Up @@ -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.

### 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
Expand Down Expand Up @@ -134,3 +125,12 @@ Usage: `settings version [command options] [arguments...]`
-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")`.

Loading

0 comments on commit e006cfe

Please sign in to comment.