mirror/opencloud
1
0
Fork 0
mirror of https://github.com/opencloud-eu/opencloud.git synced 2026-01-04 11:19:39 -06:00
Code Issues Packages Projects Releases Wiki Activity

include env config options in the docs

Browse Source 
Co-Authored-By: Christian Richter <crichter@owncloud.com>
Co-Authored-By: Willy Kloucek <wkloucek@owncloud.com>
This commit is contained in:
David Christofas
2022-03-02 12:16:34 +01:00
parent 017de20520
commit c53a922096
50 changed files with 554 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
docs/extensions/_includes/_index.md Normal file
View File

@@ -0,0 +1,3 @@
---
GeekdocHidden: true
---

27
docs/extensions/_includes/accounts_configvars.md Normal file
View File

@@ -0,0 +1,27 @@
## Environment Variables
| Name | Type | Default Value | Description |
|------|------|---------------|-------------|
| ACCOUNTS_DEBUG_ADDR | string | 127.0.0.1:9182 | |
| ACCOUNTS_DEBUG_TOKEN | string | | |
| ACCOUNTS_DEBUG_PPROF | bool | false | |
| ACCOUNTS_DEBUG_ZPAGES | bool | false | |
| ACCOUNTS_HTTP_ADDR | string | 127.0.0.1:9181 | The address of the http service.|
| ACCOUNTS_HTTP_ROOT | string | / | The root path of the http service.|
| ACCOUNTS_CACHE_TTL | int | 604800 | The cache time for the static assets.|
| ACCOUNTS_GRPC_ADDR | string | 127.0.0.1:9180 | The address of the grpc service.|
| OCIS_JWT_SECRET;ACCOUNTS_JWT_SECRET | string | Pive-Fumkiu4 | The secret to mint jwt tokens.|
| ACCOUNTS_ASSET_PATH | string | | The path to the ui assets.|
| ACCOUNTS_STORAGE_BACKEND | string | CS3 | Defines which storage implementation is to be used|
| ACCOUNTS_STORAGE_DISK_PATH | string | ~/.ocis/accounts | The path where the accounts data is stored.|
| ACCOUNTS_STORAGE_CS3_PROVIDER_ADDR | string | localhost:9215 | The address to the storage provider.|
| ACCOUNTS_UID_INDEX_LOWER_BOUND | int64 | 0 | The lowest possible uid value for the indexer.|
| ACCOUNTS_UID_INDEX_UPPER_BOUND | int64 | 1000 | The highest possible uid value for the indexer.|
| ACCOUNTS_GID_INDEX_LOWER_BOUND | int64 | 0 | The lowest possible gid value for the indexer.|
| ACCOUNTS_GID_INDEX_UPPER_BOUND | int64 | 1000 | The highest possible gid value for the indexer.|
| ACCOUNTS_SERVICE_USER_UUID | string | 95cb8724-03b2-11eb-a0a6-c33ef8ef53ad | The id of the accounts service user.|
| ACCOUNTS_SERVICE_USER_USERNAME | string | | The username of the accounts service user.|
| ACCOUNTS_SERVICE_USER_UID | int64 | 0 | The uid of the accounts service user.|
| ACCOUNTS_SERVICE_USER_GID | int64 | 0 | The gid of the accounts service user.|
| ACCOUNTS_HASH_DIFFICULTY | int | 11 | The hash difficulty makes sure that validating a password takes at least a certain amount of time.|
| ACCOUNTS_DEMO_USERS_AND_GROUPS | bool | true | If this flag is set the service will setup the demo users and groups.|

15
docs/extensions/_includes/glauth_configvars.md Normal file
View File

@@ -0,0 +1,15 @@
## Environment Variables
| Name | Type | Default Value | Description |
|------|------|---------------|-------------|
| GLAUTH_DEBUG_ADDR | string | 127.0.0.1:9129 | |
| GLAUTH_DEBUG_TOKEN | string | | |
| GLAUTH_DEBUG_PPROF | bool | false | |
| GLAUTH_DEBUG_ZPAGES | bool | false | |
| GLAUTH_LDAP_ENABLED | bool | true | |
| GLAUTH_LDAP_ADDR | string | 127.0.0.1:9125 | |
| GLAUTH_LDAPS_ENABLED | bool | true | |
| GLAUTH_LDAPS_ADDR | string | 127.0.0.1:9126 | |
| GLAUTH_LDAPS_CERT | string | ~/.ocis/ldap/ldap.crt | |
| GLAUTH_LDAPS_KEY | string | ~/.ocis/ldap/ldap.key | |
| GLAUTH_ROLE_BUNDLE_ID | string | 71881883-1768-46bd-a24d-a356a2afdf7f | |

14
docs/extensions/_includes/graph-explorer_configvars.md Normal file
View File

@@ -0,0 +1,14 @@
## Environment Variables
| Name | Type | Default Value | Description |
|------|------|---------------|-------------|
| GRAPH_EXPLORER_DEBUG_ADDR | string | 127.0.0.1:9136 | |
| GRAPH_EXPLORER_DEBUG_TOKEN | string | | |
| GRAPH_EXPLORER_DEBUG_PPROF | bool | false | |
| GRAPH_EXPLORER_DEBUG_ZPAGES | bool | false | |
| GRAPH_EXPLORER_HTTP_ADDR | string | 127.0.0.1:9135 | |
| GRAPH_EXPLORER_HTTP_ROOT | string | /graph-explorer | |
| GRAPH_EXPLORER_CLIENT_ID | string | ocis-explorer.js | |
| OCIS_URL;GRAPH_EXPLORER_ISSUER | string | https://localhost:9200 | |
| OCIS_URL;GRAPH_EXPLORER_GRAPH_URL_BASE | string | https://localhost:9200 | |
| GRAPH_EXPLORER_GRAPH_URL_PATH | string | /graph | |

36
docs/extensions/_includes/graph_configvars.md Normal file
View File

@@ -0,0 +1,36 @@
## Environment Variables
| Name | Type | Default Value | Description |
|------|------|---------------|-------------|
| GRAPH_DEBUG_ADDR | string | 127.0.0.1:9124 | |
| GRAPH_DEBUG_TOKEN | string | | |
| GRAPH_DEBUG_PPROF | bool | false | |
| GRAPH_DEBUG_ZPAGES | bool | false | |
| GRAPH_HTTP_ADDR | string | 127.0.0.1:9120 | |
| GRAPH_HTTP_ROOT | string | /graph | |
| REVA_GATEWAY | string | 127.0.0.1:9142 | |
| OCIS_JWT_SECRET;OCS_JWT_SECRET | string | Pive-Fumkiu4 | |
| OCIS_URL;GRAPH_SPACES_WEBDAV_BASE | string | https://localhost:9200 | |
| GRAPH_SPACES_WEBDAV_PATH | string | /dav/spaces/ | |
| GRAPH_SPACES_DEFAULT_QUOTA | string | 1000000000 | |
| OCIS_INSECURE;GRAPH_SPACES_INSECURE | bool | false | |
| GRAPH_SPACES_EXTENDED_SPACE_PROPERTIES_CACHE_TTL | int | 0 | |
| GRAPH_IDENTITY_BACKEND | string | cs3 | |
| GRAPH_LDAP_URI | string | ldap://localhost:9125 | |
| OCIS_INSECURE;GRAPH_LDAP_INSECURE | bool | false | |
| GRAPH_LDAP_BIND_DN | string | | |
| GRAPH_LDAP_BIND_PASSWORD | string | | |
| GRAPH_LDAP_SERVER_UUID | bool | false | |
| GRAPH_LDAP_SERVER_WRITE_ENABLED | bool | false | |
| GRAPH_LDAP_USER_BASE_DN | string | ou=users,dc=ocis,dc=test | |
| GRAPH_LDAP_USER_SCOPE | string | sub | |
| GRAPH_LDAP_USER_FILTER | string | (objectClass=inetOrgPerson) | |
| GRAPH_LDAP_USER_EMAIL_ATTRIBUTE | string | mail | |
| GRAPH_LDAP_USER_DISPLAYNAME_ATTRIBUTE | string | displayName | |
| GRAPH_LDAP_USER_NAME_ATTRIBUTE | string | uid | |
| GRAPH_LDAP_USER_UID_ATTRIBUTE | string | owncloudUUID | |
| GRAPH_LDAP_GROUP_BASE_DN | string | ou=groups,dc=ocis,dc=test | |
| GRAPH_LDAP_GROUP_SEARCH_SCOPE | string | sub | |
| GRAPH_LDAP_GROUP_FILTER | string | (objectclass=groupOfNames) | |
| GRAPH_LDAP_GROUP_NAME_ATTRIBUTE | string | cn | |
| GRAPH_LDAP_GROUP_ID_ATTRIBUTE | string | owncloudUUID | |

13
docs/extensions/_includes/idm_configvars.md Normal file
View File

@@ -0,0 +1,13 @@
## Environment Variables
| Name | Type | Default Value | Description |
|------|------|---------------|-------------|
| IDM_DEBUG_ADDR | string | | |
| IDM_DEBUG_TOKEN | string | | |
| IDM_DEBUG_PPROF | bool | false | |
| IDM_DEBUG_ZPAGES | bool | false | |
| IDM_LDAPS_ADDR | string | 127.0.0.1:9235 | |
| IDM_LDAPS_CERT | string | ~/.ocis/idm/ldap.crt | |
| IDM_LDAPS_KEY | string | ~/.ocis/idm/ldap.key | |
| IDM_DATABASE_PATH | string | ~/.ocis/idm/ocis.boltdb | |
| IDM_ADMIN_PASSWORD | string | admin | |

47
docs/extensions/_includes/idp_configvars.md Normal file
View File

@@ -0,0 +1,47 @@
## Environment Variables
| Name | Type | Default Value | Description |
|------|------|---------------|-------------|
| IDP_DEBUG_ADDR | string | 127.0.0.1:9134 | |
| IDP_DEBUG_TOKEN | string | | |
| IDP_DEBUG_PPROF | bool | false | |
| IDP_DEBUG_ZPAGES | bool | false | |
| IDP_HTTP_ADDR | string | 127.0.0.1:9130 | |
| IDP_HTTP_ROOT | string | / | |
| IDP_TRANSPORT_TLS_CERT | string | ~/.ocis/idp/server.crt | |
| IDP_TRANSPORT_TLS_KEY | string | ~/.ocis/idp/server.key | |
| IDP_TLS | bool | false | |
| IDP_ASSET_PATH | string | | |
| OCIS_URL;IDP_ISS | string | https://localhost:9200 | |
| IDP_IDENTITY_MANAGER | string | ldap | |
| IDP_URI_BASE_PATH | string | | |
| IDP_SIGN_IN_URI | string | | |
| IDP_SIGN_OUT_URI | string | | |
| IDP_ENDPOINT_URI | string | | |
| IDP_ENDSESSION_ENDPOINT_URI | string | | |
| IDP_INSECURE | bool | false | |
| IDP_ALLOW_CLIENT_GUESTS | bool | false | |
| IDP_ALLOW_DYNAMIC_CLIENT_REGISTRATION | bool | false | |
| IDP_ENCRYPTION_SECRET | string | | |
| IDP_DISABLE_IDENTIFIER_WEBAPP | bool | true | |
| IDP_IDENTIFIER_CLIENT_PATH | string | ~/.ocis/idp | |
| IDP_IDENTIFIER_REGISTRATION_CONF | string | ~/.ocis/idp/identifier-registration.yaml | |
| IDP_IDENTIFIER_SCOPES_CONF | string | | |
| IDP_SIGNING_KID | string | | |
| IDP_SIGNING_METHOD | string | PS256 | |
| IDP_VALIDATION_KEYS_PATH | string | | |
| IDP_ACCESS_TOKEN_EXPIRATION | uint64 | 600 | |
| IDP_ID_TOKEN_EXPIRATION | uint64 | 3600 | |
| IDP_REFRESH_TOKEN_EXPIRATION | uint64 | 94608000 | |
| | uint64 | 0 | |
| IDP_LDAP_URI | string | ldap://localhost:9125 | |
| IDP_LDAP_BIND_DN | string | cn=idp,ou=sysusers,dc=ocis,dc=test | |
| IDP_LDAP_BIND_PASSWORD | string | idp | |
| IDP_LDAP_BASE_DN | string | ou=users,dc=ocis,dc=test | |
| IDP_LDAP_SCOPE | string | sub | |
| IDP_LDAP_LOGIN_ATTRIBUTE | string | cn | |
| IDP_LDAP_EMAIL_ATTRIBUTE | string | mail | |
| IDP_LDAP_NAME_ATTRIBUTE | string | sn | |
| IDP_LDAP_UUID_ATTRIBUTE | string | uid | |
| IDP_LDAP_UUID_ATTRIBUTE_TYPE | string | text | |
| IDP_LDAP_FILTER | string | (objectClass=posixaccount) | |

10
docs/extensions/_includes/nats_configvars.md Normal file
View File

@@ -0,0 +1,10 @@
## Environment Variables
| Name | Type | Default Value | Description |
|------|------|---------------|-------------|
| NATS_DEBUG_ADDR | string | | |
| NATS_DEBUG_TOKEN | string | | |
| NATS_DEBUG_PPROF | bool | false | |
| NATS_DEBUG_ZPAGES | bool | false | |
| NATS_NATS_HOST | string | 127.0.0.1 | |
| NATS_NATS_PORT | int | 9233 | |

17
docs/extensions/_includes/notifications_configvars.md Normal file
View File

@@ -0,0 +1,17 @@
## Environment Variables
| Name | Type | Default Value | Description |
|------|------|---------------|-------------|
| NOTIFICATIONS_DEBUG_ADDR | string | | |
| NOTIFICATIONS_DEBUG_TOKEN | string | | |
| NOTIFICATIONS_DEBUG_PPROF | bool | false | |
| NOTIFICATIONS_DEBUG_ZPAGES | bool | false | |
| NOTIFICATIONS_SMTP_HOST | string | 127.0.0.1 | |
| NOTIFICATIONS_SMTP_PORT | string | 1025 | |
| NOTIFICATIONS_SMTP_SENDER | string | god@example.com | |
| NOTIFICATIONS_SMTP_PASSWORD | string | godisdead | |
| NOTIFICATIONS_EVENTS_ENDPOINT | string | 127.0.0.1:9233 | |
| NOTIFICATIONS_EVENTS_CLUSTER | string | test-cluster | |
| NOTIFICATIONS_EVENTS_GROUP | string | notifications | |
| REVA_GATEWAY;NOTIFICATIONS_REVA_GATEWAY | string | 127.0.0.1:9142 | |
| OCIS_MACHINE_AUTH_API_KEY;NOTIFICATIONS_MACHINE_AUTH_API_KEY | string | change-me-please | |

16
docs/extensions/_includes/ocs_configvars.md Normal file
View File

@@ -0,0 +1,16 @@
## Environment Variables
| Name | Type | Default Value | Description |
|------|------|---------------|-------------|
| OCS_DEBUG_ADDR | string | 127.0.0.1:9114 | |
| OCS_DEBUG_TOKEN | string | | |
| OCS_DEBUG_PPROF | bool | false | |
| OCS_DEBUG_ZPAGES | bool | false | |
| OCS_HTTP_ADDR | string | 127.0.0.1:9110 | |
| OCS_HTTP_ROOT | string | /ocs | |
| OCIS_JWT_SECRET;OCS_JWT_SECRET | string | Pive-Fumkiu4 | |
| REVA_GATEWAY | string | 127.0.0.1:9142 | |
| OCIS_URL;OCS_IDM_ADDRESS | string | https://localhost:9200 | |
| OCS_ACCOUNT_BACKEND_TYPE | string | accounts | |
| STORAGE_USERS_DRIVER;OCS_STORAGE_USERS_DRIVER | string | ocis | |
| OCIS_MACHINE_AUTH_API_KEY;OCS_MACHINE_AUTH_API_KEY | string | change-me-please | |

27
docs/extensions/_includes/proxy_configvars.md Normal file
View File

@@ -0,0 +1,27 @@
## Environment Variables
| Name | Type | Default Value | Description |
|------|------|---------------|-------------|
| PROXY_DEBUG_ADDR | string | 127.0.0.1:9205 | |
| PROXY_DEBUG_TOKEN | string | | |
| PROXY_DEBUG_PPROF | bool | false | |
| PROXY_DEBUG_ZPAGES | bool | false | |
| PROXY_HTTP_ADDR | string | 0.0.0.0:9200 | |
| PROXY_HTTP_ROOT | string | / | |
| PROXY_TRANSPORT_TLS_CERT | string | ~/.ocis/proxy/server.crt | |
| PROXY_TRANSPORT_TLS_KEY | string | ~/.ocis/proxy/server.key | |
| PROXY_TLS | bool | true | |
| REVA_GATEWAY | string | 127.0.0.1:9142 | |
| OCIS_URL;PROXY_OIDC_ISSUER | string | https://localhost:9200 | |
| OCIS_INSECURE;PROXY_OIDC_INSECURE | bool | true | |
| PROXY_OIDC_USERINFO_CACHE_SIZE | int | 1024 | |
| PROXY_OIDC_USERINFO_CACHE_TTL | int | 10 | |
| OCIS_JWT_SECRET;PROXY_JWT_SECRET | string | Pive-Fumkiu4 | |
| PROXY_ENABLE_PRESIGNEDURLS | bool | true | |
| PROXY_ACCOUNT_BACKEND_TYPE | string | accounts | |
| PROXY_USER_OIDC_CLAIM | string | email | |
| PROXY_USER_CS3_CLAIM | string | mail | |
| OCIS_MACHINE_AUTH_API_KEY;PROXY_MACHINE_AUTH_API_KEY | string | change-me-please | |
| PROXY_AUTOPROVISION_ACCOUNTS | bool | false | |
| PROXY_ENABLE_BASIC_AUTH | bool | false | |
| PROXY_INSECURE_BACKENDS | bool | false | |

15
docs/extensions/_includes/settings_configvars.md Normal file
View File

@@ -0,0 +1,15 @@
## Environment Variables
| Name | Type | Default Value | Description |
|------|------|---------------|-------------|
| SETTINGS_DEBUG_ADDR | string | 127.0.0.1:9194 | |
| SETTINGS_DEBUG_TOKEN | string | | |
| SETTINGS_DEBUG_PPROF | bool | false | |
| SETTINGS_DEBUG_ZPAGES | bool | false | |
| SETTINGS_HTTP_ADDR | string | 127.0.0.1:9190 | |
| SETTINGS_HTTP_ROOT | string | / | |
| SETTINGS_CACHE_TTL | int | 604800 | |
| SETTINGS_GRPC_ADDR | string | 127.0.0.1:9191 | |
| SETTINGS_DATA_PATH | string | ~/.ocis/settings | |
| SETTINGS_ASSET_PATH | string | | |
| OCIS_JWT_SECRET;SETTINGS_JWT_SECRET | string | Pive-Fumkiu4 | |

10
docs/extensions/_includes/store_configvars.md Normal file
View File

@@ -0,0 +1,10 @@
## Environment Variables
| Name | Type | Default Value | Description |
|------|------|---------------|-------------|
| STORE_DEBUG_ADDR | string | 127.0.0.1:9464 | |
| STORE_DEBUG_TOKEN | string | | |
| STORE_DEBUG_PPROF | bool | false | |
| STORE_DEBUG_ZPAGES | bool | false | |
| STORE_GRPC_ADDR | string | 127.0.0.1:9460 | |
| STORE_DATA_PATH | string | ~/.ocis/store | |

14
docs/extensions/_includes/thumbnails_configvars.md Normal file
View File

@@ -0,0 +1,14 @@
## Environment Variables
| Name | Type | Default Value | Description |
|------|------|---------------|-------------|
| THUMBNAILS_DEBUG_ADDR | string | 127.0.0.1:9189 | |
| THUMBNAILS_DEBUG_TOKEN | string | | |
| THUMBNAILS_DEBUG_PPROF | bool | false | |
| THUMBNAILS_DEBUG_ZPAGES | bool | false | |
| THUMBNAILS_GRPC_ADDR | string | 127.0.0.1:9185 | |
| THUMBNAILS_FILESYSTEMSTORAGE_ROOT | string | ~/.ocis/thumbnails | |
| OCIS_INSECURE;THUMBNAILS_WEBDAVSOURCE_INSECURE | bool | true | |
| OCIS_INSECURE;THUMBNAILS_CS3SOURCE_INSECURE | bool | false | |
| REVA_GATEWAY | string | 127.0.0.1:9142 | |
| THUMBNAILS_TXT_FONTMAP_FILE | string | | |

24
docs/extensions/_includes/web_configvars.md Normal file
View File

@@ -0,0 +1,24 @@
## Environment Variables
| Name | Type | Default Value | Description |
|------|------|---------------|-------------|
| WEB_DEBUG_ADDR | string | 127.0.0.1:9104 | |
| WEB_DEBUG_TOKEN | string | | |
| WEB_DEBUG_PPROF | bool | false | |
| WEB_DEBUG_ZPAGES | bool | false | |
| WEB_HTTP_ADDR | string | 127.0.0.1:9100 | |
| WEB_HTTP_ROOT | string | / | |
| WEB_CACHE_TTL | int | 604800 | |
| WEB_ASSET_PATH | string | | |
| WEB_UI_CONFIG | string | | |
| WEB_UI_PATH | string | | |
| OCIS_URL;WEB_UI_THEME_SERVER | string | https://localhost:9200 | |
| WEB_UI_THEME_PATH | string | /themes/owncloud/theme.json | |
| OCIS_URL;WEB_UI_CONFIG_SERVER | string | https://localhost:9200 | |
| | string | | |
| WEB_UI_CONFIG_VERSION | string | 0.1.0 | |
| WEB_OIDC_METADATA_URL | string | | |
| OCIS_URL;WEB_OIDC_AUTHORITY | string | https://localhost:9200 | |
| WEB_OIDC_CLIENT_ID | string | web | |
| WEB_OIDC_RESPONSE_TYPE | string | code | |
| WEB_OIDC_SCOPE | string | openid profile email | |

13
docs/extensions/_includes/webdav_configvars.md Normal file
View File

@@ -0,0 +1,13 @@
## Environment Variables
| Name | Type | Default Value | Description |
|------|------|---------------|-------------|
| WEBDAV_DEBUG_ADDR | string | 127.0.0.1:9119 | |
| WEBDAV_DEBUG_TOKEN | string | | |
| WEBDAV_DEBUG_PPROF | bool | false | |
| WEBDAV_DEBUG_ZPAGES | bool | false | |
| WEBDAV_HTTP_ADDR | string | 127.0.0.1:9115 | |
| WEBDAV_HTTP_ROOT | string | / | |
| OCIS_URL;OCIS_PUBLIC_URL | string | https://127.0.0.1:9200 | |
| STORAGE_WEBDAV_NAMESPACE | string | /users/{{.Id.OpaqueId}} | |
| REVA_GATEWAY | string | 127.0.0.1:9142 | |

1
docs/extensions/accounts/.gitignore vendored
View File

@@ -1,2 +1 @@
configuration.md
grpc.md

12
docs/extensions/accounts/configuration.md Normal file
View File

@@ -0,0 +1,12 @@
---
title: Service Configuration
date: 2018-05-02T00:00:00+00:00
weight: 20
geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs/extensions/accounts
geekdocFilePath: configuration.md
geekdocCollapseSection: true
---
{{< include file="extensions/_includes/accounts_configvars.md" >}}

1
docs/extensions/glauth/.gitignore vendored
View File

@@ -1,2 +1 @@
configuration.md
grpc.md

12
docs/extensions/glauth/configuration.md Normal file
View File

@@ -0,0 +1,12 @@
---
title: Service Configuration
date: 2018-05-02T00:00:00+00:00
weight: 20
geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs/extensions/glauth
geekdocFilePath: configuration.md
geekdocCollapseSection: true
---
{{< include file="extensions/_includes/glauth_configvars.md" >}}

1
docs/extensions/graph-explorer/.gitignore vendored
View File

@@ -1 +0,0 @@
configuration.md

12
docs/extensions/graph-explorer/configuration.md Normal file
View File

@@ -0,0 +1,12 @@
---
title: Service Configuration
date: 2018-05-02T00:00:00+00:00
weight: 20
geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs/extensions/graph-explorer
geekdocFilePath: configuration.md
geekdocCollapseSection: true
---
{{< include file="extensions/_includes/graph-explorer_configvars.md" >}}

1
docs/extensions/graph/.gitignore vendored
View File

@@ -1 +0,0 @@
configuration.md

12
docs/extensions/graph/configuration.md Normal file
View File

@@ -0,0 +1,12 @@
---
title: Service Configuration
date: 2018-05-02T00:00:00+00:00
weight: 20
geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs/extensions/graph
geekdocFilePath: configuration.md
geekdocCollapseSection: true
---
{{< include file="extensions/_includes/graph_configvars.md" >}}

16
docs/extensions/idm/_index.md Normal file
View File

@@ -0,0 +1,16 @@
---
title: IDM
date: 2022-03-02T00:00:00+00:00
weight: 20
geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs/extensions/idm
geekdocFilePath: _index.md
geekdocCollapseSection: true
---
## Abstract
## Table of Contents
{{< toc-tree >}}

12
docs/extensions/idm/configuration.md Normal file
View File

@@ -0,0 +1,12 @@
---
title: Service Configuration
date: 2018-05-02T00:00:00+00:00
weight: 20
geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs/extensions/idm
geekdocFilePath: configuration.md
geekdocCollapseSection: true
---
{{< include file="extensions/_includes/idm_configvars.md" >}}

1
docs/extensions/idp/.gitignore vendored
View File

@@ -1,2 +1 @@
configuration.md
grpc.md

12
docs/extensions/idp/configuration.md Normal file
View File

@@ -0,0 +1,12 @@
---
title: Service Configuration
date: 2018-05-02T00:00:00+00:00
weight: 20
geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs/extensions/idp
geekdocFilePath: configuration.md
geekdocCollapseSection: true
---
{{< include file="extensions/_includes/idp_configvars.md" >}}

16
docs/extensions/nats/_index.md Normal file
View File

@@ -0,0 +1,16 @@
---
title: NATS
date: 2022-03-02T00:00:00+00:00
weight: 20
geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs/extensions/nats
geekdocFilePath: _index.md
geekdocCollapseSection: true
---
## Abstract
## Table of Contents
{{< toc-tree >}}

12
docs/extensions/nats/configuration.md Normal file
View File

@@ -0,0 +1,12 @@
---
title: Service Configuration
date: 2018-05-02T00:00:00+00:00
weight: 20
geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs/extensions/nats
geekdocFilePath: configuration.md
geekdocCollapseSection: true
---
{{< include file="extensions/_includes/nats_configvars.md" >}}

16
docs/extensions/notifications/_index.md Normal file
View File

@@ -0,0 +1,16 @@
---
title: Notifications
date: 2022-03-02T00:00:00+00:00
weight: 20
geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs/extensions/notifications
geekdocFilePath: _index.md
geekdocCollapseSection: true
---
## Abstract
## Table of Contents
{{< toc-tree >}}

12
docs/extensions/notifications/configuration.md Normal file
View File

@@ -0,0 +1,12 @@
---
title: Service Configuration
date: 2018-05-02T00:00:00+00:00
weight: 20
geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs/extensions/notifications
geekdocFilePath: configuration.md
geekdocCollapseSection: true
---
{{< include file="extensions/_includes/notifications_configvars.md" >}}

1
docs/extensions/ocs/.gitignore vendored
View File

@@ -1,2 +1 @@
configuration.md
grpc.md

12
docs/extensions/ocs/configuration.md Normal file
View File

@@ -0,0 +1,12 @@
---
title: Service Configuration
date: 2018-05-02T00:00:00+00:00
weight: 20
geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs/extensions/ocs
geekdocFilePath: configuration.md
geekdocCollapseSection: true
---
{{< include file="extensions/_includes/ocs_configvars.md" >}}

1
docs/extensions/proxy/.gitignore vendored
View File

@@ -1,2 +1 @@
configuration.md
grpc.md

12
docs/extensions/proxy/configuration.md Normal file
View File

@@ -0,0 +1,12 @@
---
title: Service Configuration
date: 2018-05-02T00:00:00+00:00
weight: 20
geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs/extensions/proxy
geekdocFilePath: configuration.md
geekdocCollapseSection: true
---
{{< include file="extensions/_includes/proxy_configvars.md" >}}

1
docs/extensions/settings/.gitignore vendored
View File

@@ -1,2 +1 @@
configuration.md
grpc.md

12
docs/extensions/settings/configuration.md Normal file
View File

@@ -0,0 +1,12 @@
---
title: Service Configuration
date: 2018-05-02T00:00:00+00:00
weight: 20
geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs/extensions/settings
geekdocFilePath: configuration.md
geekdocCollapseSection: true
---
{{< include file="extensions/_includes/settings_configvars.md" >}}

1
docs/extensions/storage/.gitignore vendored
View File

@@ -1,2 +1 @@
configuration.md
grpc.md

1
docs/extensions/store/.gitignore vendored
View File

@@ -1,2 +1 @@
configuration.md
grpc.md

12
docs/extensions/store/configuration.md Normal file
View File

@@ -0,0 +1,12 @@
---
title: Service Configuration
date: 2018-05-02T00:00:00+00:00
weight: 20
geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs/extensions/store
geekdocFilePath: configuration.md
geekdocCollapseSection: true
---
{{< include file="extensions/_includes/store_configvars.md" >}}

1
docs/extensions/thumbnails/.gitignore vendored
View File

@@ -1,2 +1 @@
configuration.md
grpc.md

12
docs/extensions/thumbnails/configuration.md Normal file
View File

@@ -0,0 +1,12 @@
---
title: Service Configuration
date: 2018-05-02T00:00:00+00:00
weight: 20
geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs/extensions/thumbnails
geekdocFilePath: configuration.md
geekdocCollapseSection: true
---
{{< include file="extensions/_includes/thumbnails_configvars.md" >}}

1
docs/extensions/web/.gitignore vendored
View File

@@ -1,2 +1 @@
configuration.md
grpc.md

12
docs/extensions/web/configuration.md Normal file
View File

@@ -0,0 +1,12 @@
---
title: Service Configuration
date: 2018-05-02T00:00:00+00:00
weight: 20
geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs/extensions/web
geekdocFilePath: configuration.md
geekdocCollapseSection: true
---
{{< include file="extensions/_includes/web_configvars.md" >}}

1
docs/extensions/webdav/.gitignore vendored
View File

@@ -1,2 +1 @@
configuration.md
grpc.md

12
docs/extensions/webdav/configuration.md Normal file
View File

@@ -0,0 +1,12 @@
---
title: Service Configuration
date: 2018-05-02T00:00:00+00:00
weight: 20
geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs/extensions/webdav
geekdocFilePath: configuration.md
geekdocCollapseSection: true
---
{{< include file="extensions/_includes/webdav_configvars.md" >}}

1
docs/helpers/configenvextractor.go
View File

@@ -35,6 +35,7 @@ func main() {
}
tpl.Execute(runner, paths)
os.Chdir("output")
os.Setenv("OCIS_BASE_DATA_PATH", "~/.ocis")
out, err := exec.Command("go", "run", "runner.go").Output()
if err != nil {
log.Fatal(err)

35
docs/helpers/extractor.go.tmpl
View File

@@ -5,8 +5,9 @@ import (
"io/ioutil"
"log"
"os"
"path/filepath"
"reflect"
"strings"
"strings"
"text/template"
{{- range $key, $value := .}}
@@ -32,19 +33,27 @@ replacer := strings.NewReplacer(
var fields []ConfigField
var targetFile *os.File
tpl := template.Must(template.New("").Parse(string(content)))
{{ range $key, $value := .}}
fields = GetAnnotatedVariables(*pkg{{ $key }}.DefaultConfig())
if len(fields) > 0 {
targetFolder := "../../../docs/extensions/" + replacer.Replace("{{ $value }}")
os.MkdirAll(targetFolder, 0700)
targetFile, err = os.Create(targetFolder + "/configvars.md")
if err != nil {
log.Fatal(err)
}
tpl.Execute(targetFile, fields)
targetFile.Close()
m := map[string]interface{}{
{{- range $key, $value := .}}
"{{$value}}": *pkg{{$key}}.DefaultConfig(),
{{- end }}
}
targetFolder := "../../../docs/extensions/_includes/"
for pkg, conf := range m {
fields = GetAnnotatedVariables(conf)
if len(fields) > 0 {
targetFile, err = os.Create(filepath.Join(targetFolder, replacer.Replace(pkg) + "_configvars.md"))
if err != nil {
log.Fatalf("Failed to create target file: %s", err)
}
defer targetFile.Close()
if err := tpl.Execute(targetFile, fields); err != nil {
log.Fatalf("Failed to execute template: %s", err)
}
}
}
{{ end }}
}
func GetAnnotatedVariables(s interface{}) []ConfigField {

2
docs/templates/CONFIGURATION.tmpl vendored
View File

@@ -1,3 +1,5 @@
## Environment Variables
| Name | Type | Default Value | Description |
|------|------|---------------|-------------|
{{- range .}}