From eb82c646c0b8e06366413b8228519d12ebc89357 Mon Sep 17 00:00:00 2001 From: Willy Kloucek Date: Mon, 2 May 2022 15:14:43 +0200 Subject: [PATCH] app provider config docs --- docs/extensions/appprovider/_index.md | 16 +++++++++++ .../{storage => appprovider}/apps.md | 2 +- docs/extensions/appprovider/configuration.md | 15 +++++++++++ docs/extensions/auth-basic/_index.md | 2 +- docs/helpers/configenvextractor.go | 4 +-- ...vironment-variable-docs-generator.go.tmpl} | 0 extensions/appprovider/pkg/command/command.go | 5 ++-- extensions/appprovider/pkg/config/config.go | 27 +++++++++---------- 8 files changed, 50 insertions(+), 21 deletions(-) create mode 100644 docs/extensions/appprovider/_index.md rename docs/extensions/{storage => appprovider}/apps.md (99%) create mode 100644 docs/extensions/appprovider/configuration.md rename docs/helpers/{extractor.go.tmpl => environment-variable-docs-generator.go.tmpl} (100%) diff --git a/docs/extensions/appprovider/_index.md b/docs/extensions/appprovider/_index.md new file mode 100644 index 000000000..6f1ff50f0 --- /dev/null +++ b/docs/extensions/appprovider/_index.md @@ -0,0 +1,16 @@ +--- +title: App Provider +date: 2022-03-02T00:00:00+00:00 +weight: 20 +geekdocRepo: https://github.com/owncloud/ocis +geekdocEditPath: edit/master/docs/extensions/appprovider +geekdocFilePath: _index.md +geekdocCollapseSection: true +--- + +## Abstract + + +## Table of Contents + +{{< toc-tree >}} diff --git a/docs/extensions/storage/apps.md b/docs/extensions/appprovider/apps.md similarity index 99% rename from docs/extensions/storage/apps.md rename to docs/extensions/appprovider/apps.md index 93d7b19e7..32a18287b 100644 --- a/docs/extensions/storage/apps.md +++ b/docs/extensions/appprovider/apps.md @@ -3,7 +3,7 @@ title: "Apps" date: 2018-05-02T00:00:00+00:00 weight: 10 geekdocRepo: https://github.com/owncloud/ocis -geekdocEditPath: edit/master/docs/extensions/storage +geekdocEditPath: edit/master/docs/extensions/appprovider geekdocFilePath: apps.md --- diff --git a/docs/extensions/appprovider/configuration.md b/docs/extensions/appprovider/configuration.md new file mode 100644 index 000000000..1f828107d --- /dev/null +++ b/docs/extensions/appprovider/configuration.md @@ -0,0 +1,15 @@ +--- +title: Service Configuration +date: 2018-05-02T00:00:00+00:00 +weight: 20 +geekdocRepo: https://github.com/owncloud/ocis +geekdocEditPath: edit/master/docs/extensions/appprovider +geekdocFilePath: configuration.md +geekdocCollapseSection: true +--- + +## Example YAML Config + +{{< include file="extensions/_includes/appprovider-config-example.yaml" language="yaml" >}} + +{{< include file="extensions/_includes/appprovider_configvars.md" >}} diff --git a/docs/extensions/auth-basic/_index.md b/docs/extensions/auth-basic/_index.md index 3cae23b14..0f47e2297 100644 --- a/docs/extensions/auth-basic/_index.md +++ b/docs/extensions/auth-basic/_index.md @@ -3,7 +3,7 @@ title: Auth-Basic date: 2022-03-02T00:00:00+00:00 weight: 20 geekdocRepo: https://github.com/owncloud/ocis -geekdocEditPath: edit/master/docs/extensions/auth-baisc +geekdocEditPath: edit/master/docs/extensions/auth-basic geekdocFilePath: _index.md geekdocCollapseSection: true --- diff --git a/docs/helpers/configenvextractor.go b/docs/helpers/configenvextractor.go index d7afd5295..f78d1671b 100644 --- a/docs/helpers/configenvextractor.go +++ b/docs/helpers/configenvextractor.go @@ -13,8 +13,8 @@ import ( ) var targets = map[string]string{ - "example-config-generator.go.tmpl": "output/exampleconfig/example-config-generator.go", - "extractor.go.tmpl": "output/env/runner.go", + "example-config-generator.go.tmpl": "output/exampleconfig/example-config-generator.go", + "environment-variable-docs-generator.go.tmpl": "output/env/environment-variable-docs-generator.go", } func main() { diff --git a/docs/helpers/extractor.go.tmpl b/docs/helpers/environment-variable-docs-generator.go.tmpl similarity index 100% rename from docs/helpers/extractor.go.tmpl rename to docs/helpers/environment-variable-docs-generator.go.tmpl diff --git a/extensions/appprovider/pkg/command/command.go b/extensions/appprovider/pkg/command/command.go index e2cbfd42c..a3abd2207 100644 --- a/extensions/appprovider/pkg/command/command.go +++ b/extensions/appprovider/pkg/command/command.go @@ -97,9 +97,8 @@ func appProviderConfigFromStruct(c *cli.Context, cfg *config.Config) map[string] "tracing_service_name": c.Command.Name, }, "shared": map[string]interface{}{ - "jwt_secret": cfg.TokenManager.JWTSecret, - "gatewaysvc": cfg.Reva.Address, - "skip_user_groups_in_token": cfg.SkipUserGroupsInToken, + "jwt_secret": cfg.TokenManager.JWTSecret, + "gatewaysvc": cfg.Reva.Address, }, "grpc": map[string]interface{}{ "network": cfg.GRPC.Protocol, diff --git a/extensions/appprovider/pkg/config/config.go b/extensions/appprovider/pkg/config/config.go index 9f0c0e9c5..c8be7463a 100644 --- a/extensions/appprovider/pkg/config/config.go +++ b/extensions/appprovider/pkg/config/config.go @@ -15,10 +15,9 @@ type Config struct { TokenManager *TokenManager `yaml:"token_manager"` Reva *Reva `yaml:"reva"` - SkipUserGroupsInToken bool `yaml:"skip_user_groups_in_token"` - ExternalAddr string `yaml:"external_addr"` - Driver string `yaml:"driver"` - Drivers Drivers `yaml:"drivers"` + ExternalAddr string `yaml:"external_addr"` + Driver string `yaml:"driver"` + Drivers Drivers `yaml:"drivers"` } type Tracing struct { @@ -52,17 +51,17 @@ type GRPCConfig struct { } type Drivers struct { - WOPI WOPIDriver + WOPI WOPIDriver `yaml:"wopi" desc:"driver for the CS3org WOPI server"` } type WOPIDriver struct { - AppAPIKey string `yaml:"app_api_key"` - AppDesktopOnly bool `yaml:"app_desktop_only"` - AppIconURI string `yaml:"app_icon_uri"` - AppInternalURL string `yaml:"app_internal_url"` - AppName string `yaml:"app_name"` - AppURL string `yaml:"app_url"` - Insecure bool `yaml:"insecure"` - IopSecret string `yaml:"ipo_secret"` - WopiURL string `yaml:"wopi_url"` + AppAPIKey string `yaml:"app_api_key" env:"APP_PROVIDER_WOPI_APP_API_KEY" desc:"api key for the wopi app"` + AppDesktopOnly bool `yaml:"app_desktop_only" env:"APP_PROVIDER_WOPI_APP_DESKTOP_ONLY" desc:"offer this app only on desktop"` + AppIconURI string `yaml:"app_icon_uri" env:"APP_PROVIDER_WOPI_APP_ICON_URI" desc:"uri to an app icon to be used by clients"` + AppInternalURL string `yaml:"app_internal_url" env:"APP_PROVIDER_WOPI_APP_INTERNAL_URL" desc:"internal url to the app, eg in your DMZ"` + AppName string `yaml:"app_name" env:"APP_PROVIDER_WOPI_APP_NAME" desc:"human readable app name"` + AppURL string `yaml:"app_url" env:"APP_PROVIDER_WOPI_APP_URL" desc:"url for end users to access the app"` + Insecure bool `yaml:"insecure" env:"APP_PROVIDER_WOPI_INSECURE" desc:"allow insecure connections to the app"` + IopSecret string `yaml:"wopi_server_iop_secret" env:"APP_PROVIDER_WOPI_WOPI_SERVER_IOP_SECRET" desc:"shared secret of the CS3org WOPI server"` + WopiURL string `yaml:"wopi_server_external_url" env:"APP_PROVIDER_WOPI_WOPI_SERVER_EXTERNAL_URL" desc:"external url of the CS3org WOPI server"` }