Skip to content

Commit 8e76390

Browse files
authored
Update docs with latest env vars (#708)
1 parent dd3b4be commit 8e76390

4 files changed

Lines changed: 28 additions & 246 deletions

File tree

docs/_static/env-vars/extended_configvars.md

Lines changed: 5 additions & 223 deletions
Original file line numberDiff line numberDiff line change
@@ -2,234 +2,16 @@
22

33
| Name | Type | Default Value | Description |
44
|---|---|---|---|
5-
`0` | | | |
6-
`ACK_GINKGO_DEPRECATIONS` | | | |
7-
`ACK_GINKGO_RC` | | | |
8-
`ANSICON` | | | |
9-
`ANSICON_VER` | | | |
10-
`APP_ID` | | | |
11-
`APP_SECRET` | | | |
12-
`AWS_ACCESS_KEY` | | | |
13-
`AWS_ACCESS_KEY_ID` | | | |
14-
`AWS_CONTAINER_AUTHORIZATION_TOKEN` | | | |
15-
`AWS_CONTAINER_AUTHORIZATION_TOKEN_FILE` | | | |
16-
`AWS_CONTAINER_CREDENTIALS_FULL_URI` | | | |
17-
`AWS_CONTAINER_CREDENTIALS_RELATIVE_URI` | | | |
18-
`AWS_PROFILE` | | | |
19-
`AWS_REGION` | | | |
20-
`AWS_ROLE_ARN` | | | |
21-
`AWS_ROLE_SESSION_NAME` | | | |
22-
`AWS_SECRET_ACCESS_KEY` | | | |
23-
`AWS_SECRET_KEY` | | | |
24-
`AWS_SESSION_TOKEN` | | | |
25-
`AWS_SHARED_CREDENTIALS_FILE` | | | |
26-
`AWS_WEB_IDENTITY_TOKEN_FILE` | | | |
27-
`BASH_COMP_DEBUG_FILE` | | | |
28-
`CI` | | | |
29-
`CI_SYSTEM_NAME` | | | |
30-
`CLICOLOR` | | | |
31-
`CLI_TEMPLATE_ERROR_DEBUG` | | | |
32-
`COLORTERM` | | | |
33-
`COMSPEC` | | | |
34-
`CS3_GATEWAY` | | | |
35-
`CS3_MACHINE_AUTH_API_KEY` | | | |
36-
`ConEmuANSI` | | | |
37-
`DAYS` | | | |
38-
`DOCKER_AUTH_CONFIG` | | | |
39-
`DOCKER_CONFIG` | | | |
40-
`DOCKER_HOST` | | | |
41-
`ENV_VERIFY` | | | |
42-
`ETCD_CLIENT_DEBUG` | | | |
5+
`CS3_GATEWAY` | | | Adress of the CS3 backend |
6+
`CS3_MACHINE_AUTH_API_KEY` | | | Authentication API-Key for CS3 backend |
437
`EXPERIMENTAL_REGISTER_INTERVAL` | duration | 25s | The interval at which services will re-register themselves with the registry to prevent expiry. Only change on supervision of openCloud Support. |
448
`EXPERIMENTAL_REGISTER_TTL` | duration | 30s | The time-to-live for a service registration in the registry. Services must re-register before this time to prevent expiry. Only change on supervision of openCloud Support. |
45-
`EXPERIMENTAL_WASM_OPT` | | | |
46-
`EXPERIMENTAL_WASM_OPT_ARGS` | | | |
47-
`EnvAlacritty` | | | |
48-
`EnvConEmuANSI` | | | |
49-
`EnvLCAll` | | | |
50-
`EnvLCCtype` | | | |
51-
`EnvLang` | | | |
52-
`EnvOverrideAPIVersion` | | | |
53-
`EnvOverrideCertPath` | | | |
54-
`EnvOverrideHost` | | | |
55-
`EnvRuneWidthEastAsian` | | | |
56-
`EnvTLSVerify` | | | |
57-
`EnvTerm` | | | |
58-
`EnvTermProgram` | | | |
59-
`EnvTermProgramWsl` | | | |
60-
`EnvUnixSocketDir` | | | |
61-
`EnvUnixSocketGroup` | | | |
62-
`EnvVTEVersion` | | | |
63-
`EnvVarLabels` | | | |
64-
`EnvVarType` | | | |
65-
`EnvWTProfile` | | | |
66-
`FORCE_COLOR` | | | |
67-
`FSNOTIFY_DEBUG` | | | |
68-
`GINKGO_EDITOR_INTEGRATION` | | | |
69-
`GINKGO_PARALLEL_PROTOCOL` | | | |
70-
`GINKGO_PRESERVE_CACHE` | | | |
71-
`GINKGO_PRUNE_STACK` | | | |
72-
`GINKGO_TIME_FORMAT` | | | |
73-
`GITHUB_ACTIONS` | | | |
74-
`GO15VENDOREXPERIMENT` | | | |
75-
`GODEBUG` | | | |
76-
`GOOS` | | | |
77-
`GOPACKAGESPRINTDRIVERERRORS` | | | |
78-
`GOPROCESS` | | | |
79-
`GOPROTODEBUG` | | | |
80-
`GRACEFUL` | | | |
81-
`GRPC_GO_LOG_FORMATTER` | | | |
82-
`GRPC_GO_LOG_SEVERITY_LEVEL` | | | |
83-
`GRPC_GO_LOG_VERBOSITY_LEVEL` | | | |
84-
`GRPC_TEST_ONLY_GOOGLE_C2P_RESOLVER_TRAFFIC_DIRECTOR_URI` | | | |
85-
`HOME` | | | |
86-
`HOMEDRIVE` | | | |
87-
`HOMEPATH` | | | |
88-
`HOSTNAME` | | | |
89-
`HOST_ROOT` | | | |
90-
`IDENTITY_ENDPOINT` | | | |
91-
`IDENTITY_HEADER` | | | |
92-
`JOURNAL_STREAM` | | | |
93-
`KIDM_TEMPLATE_DEBUG` | | | |
94-
`KOPANO_DEBUG_SERVER_REQUEST_LOG` | | | |
95-
`KUBERNETES_SERVICE_HOST` | | | |
96-
`KUBERNETES_SERVICE_PORT` | | | |
97-
`LANG` | | | |
98-
`LC_ALL` | | | |
99-
`LC_CTYPE` | | | |
100-
`LDAP_BASEDN` | | | |
101-
`LDAP_BINDDN` | | | |
102-
`LDAP_BINDPW` | | | |
103-
`LDAP_EMAIL_ATTRIBUTE` | | | |
104-
`LDAP_FAMILY_NAME_ATTRIBUTE` | | | |
105-
`LDAP_FILTER` | | | |
106-
`LDAP_GIVEN_NAME_ATTRIBUTE` | | | |
107-
`LDAP_LOGIN_ATTRIBUTE` | | | |
108-
`LDAP_NAME_ATTRIBUTE` | | | |
109-
`LDAP_SCOPE` | | | |
110-
`LDAP_SUB_ATTRIBUTES` | | | |
111-
`LDAP_TLS_CACERT` | | | |
112-
`LDAP_UIDNUMBER_ATTRIBUTE` | | | |
113-
`LDAP_URI` | | | |
114-
`LDAP_UUID_ATTRIBUTE` | | | |
115-
`LDAP_UUID_ATTRIBUTE_TYPE` | | | |
116-
`LIBREGRAPH_SCOPED_URIS` | | | |
117-
`LIBREGRAPH_URI` | | | |
118-
`LogEnv` | | | |
119-
`MD2MAN_DEBUG` | | | |
9+
`GRPC_MAX_CONNECTION_AGE` | duration | 9223372036854775807 | Timeout for GRPC connections. After timeout, a new connection will be established automatically. The default value is in ns and is about 2.5 mio h. |
12010
`MICRO_LOG_LEVEL` | string | Error | Set the log level for the internal go micro framework. Only change on supervision of openCloud Support. |
121-
`MICRO_NETWORK` | | | |
122-
`MICRO_NETWORK_ADDRESS` | | | |
123-
`MICRO_PROXY` | | | |
12411
`MICRO_REGISTRY` | string | nats-js-kv | The type of registry to use. Only change on supervision of openCloud Support. |
12512
`MICRO_REGISTRY_ADDRESS` | string | 127.0.0.1:9233 | The bind address of the internal natsjs registry. Only change on supervision of openCloud Support. |
12613
`MICRO_REGISTRY_AUTH_PASSWORD` | string | | Optional when using nats to authenticate with the nats cluster. |
127-
`MINIO_ACCESS_KEY` | | | |
128-
`MINIO_ALIAS` | | | |
129-
`MINIO_GO_TEST_BUCKET_CORS` | | | |
130-
`MINIO_ROOT_PASSWORD` | | | |
131-
`MINIO_ROOT_USER` | | | |
132-
`MINIO_SECRET_KEY` | | | |
133-
`MINT_MODE` | | | |
134-
`MINT_NO_FULL_OBJECT` | | | |
135-
`MOBY_DISABLE_PIGZ` | | | |
136-
`MONTH` | | | |
137-
`MSYSTEM` | | | |
138-
`NOTIFY_ACCOUNTID` | | | |
139-
`NOTIFY_BUCKET` | | | |
140-
`NOTIFY_REGION` | | | |
141-
`NOTIFY_RESOURCE` | | | |
142-
`NOTIFY_SERVICE` | | | |
143-
`NO_COLOR` | | | |
14+
`MICRO_REGISTRY_AUTH_USERNAME` | string | | Optional when using nats to authenticate with the nats cluster. |
14415
`OC_BASE_DATA_PATH` | string | | The base directory location used by several services and for user data. See the General Info section in the documentation for more details on defaults. Services can have, if available, an individual setting with an own environment variable. |
14516
`OC_CONFIG_DIR` | string | | The default directory location for config files. See the General Info section in the documentation for more details on defaults. |
146-
`OC_GRPC_MAX_RECEIVED_MESSAGE_SIZE` | integer | 10240000 | Sets the maximum message size in bytes the GRPC client can receive. |
147-
`OPA_VERSION_CHECK_SERVICE_URL` | | | |
148-
`PATH` | | | |
149-
`PLUGIN_CLIENT_CERT` | | | |
150-
`PLUGIN_MAX_PORT` | | | |
151-
`PLUGIN_MIN_PORT` | | | |
152-
`PLUGIN_PROTOCOL_VERSIONS` | | | |
153-
`PSHOME` | | | |
154-
`PWD` | | | |
155-
`REVA_APPPROVIDER_IOPSECRET` | | | |
156-
`REVA_SMTP_SENDER_PASSWORD` | | | |
157-
`RUNEWIDTH_EASTASIAN` | | | |
158-
`RUN_CMD_TEST` | | | |
159-
`RUN_ON_FAIL` | | | |
160-
`RYUK_PORT` | | | |
161-
`SHELL` | | | |
162-
`SSH_AUTH_SOCK` | | | |
163-
`SSH_KNOWN_HOSTS` | | | |
164-
`SSL_CERT_FILE` | | | |
165-
`TERM` | | | |
166-
`TERMINAL_EMULATOR` | | | |
167-
`TERM_PROGRAM` | | | |
168-
`TERM_PROGRAM_VERSION` | | | |
169-
`TESTCONTAINERS_HUB_IMAGE_NAME_PREFIX` | | | |
170-
`TESTCONTAINERS_RYUK_CONTAINER_PRIVILEGED` | | | |
171-
`TESTCONTAINERS_RYUK_DISABLED` | | | |
172-
`USER` | | | |
173-
`USERPROFILE` | | | |
174-
`USE_TESTCONTAINERS` | | | |
175-
`WSL_DISTRO_NAME` | | | |
176-
`WT_SESSION` | | | |
177-
`XDG_CONFIG_HOME` | | | |
178-
`XDSBootstrapFileContentEnv` | | | |
179-
`XDSBootstrapFileNameEnv` | | | |
180-
`YEAR` | | | |
181-
`_registryAddressEnv` | | | |
182-
`_registryEnv` | | | |
183-
`_registryPasswordEnv` | | | |
184-
`_registryRegisterIntervalEnv` | | | |
185-
`_registryRegisterTTLEnv` | | | |
186-
`_registryUsernameEnv` | | | |
187-
`_serverMaxConnectionAgeEnv` | | | |
188-
`accessKey` | | | |
189-
`accessKeyEnvVar` | | | |
190-
`activeHelpEnvVar(cmd.Root(` | | | |
191-
`activeHelpGlobalEnvVar` | | | |
192-
`ansiterm.LogEnv` | | | |
193-
`awsConfigFileEnvVar` | | | |
194-
`awsCredentialsFileEnvVar` | | | |
195-
`awsDomainEnvVar` | | | |
196-
`awsProfileEnvVar` | | | |
197-
`awsRegionEnvVar` | | | |
198-
`awsRoleArnEnvVar` | | | |
199-
`awsWebIdentityTokenFileEnvVar` | | | |
200-
`configEnvVar(cmd.Root(` | | | |
201-
`configEnvVar(configEnvVarGlobalPrefix, suffix` | | | |
202-
`defaultHTTPRequestTimeoutEnv` | | | |
203-
`ecsFullPathEnvVar` | | | |
204-
`ecsRelativePathEnvVar` | | | |
205-
`enableHTTPS` | | | |
206-
`enableKMS` | | | |
207-
`env` | | | |
208-
`envAUTOMEMLIMIT_EXPERIMENT` | | | |
209-
`envMultiplexGRPC` | | | |
210-
`envName` | | | |
211-
`envObservabilityConfig` | | | |
212-
`envObservabilityConfigFile` | | | |
213-
`envStr` | | | |
214-
`envVar` | | | |
215-
`envVerify` | | | |
216-
`key` | | | |
217-
`n` | | | |
218-
`name` | | | |
219-
`opts.MagicCookieKey` | | | |
220-
`parts[0]` | | | |
221-
`prefix + envVar` | | | |
222-
`resourceAttrKey` | | | |
223-
`s` | | | |
224-
`secretKey` | | | |
225-
`secretKeyEnvVar` | | | |
226-
`securityTokenEnvVar` | | | |
227-
`serverEndpoint` | | | |
228-
`sessionTokenEnvVar` | | | |
229-
`skipCERTValidation` | | | |
230-
`strings.ToLower(key` | | | |
231-
`strings.ToUpper(key` | | | |
232-
`svcNameKey` | | | |
233-
`tlsClientCertEnvVar` | | | |
234-
`tlsClientKeyEnvVar` | | | |
235-
`v` | | | |
17+
`OC_GRPC_MAX_RECEIVED_MESSAGE_SIZE` | integer | 10240000 | Sets the maximum message size in bytes the GRPC client can receive. |

docs/_static/env-vars/frontend_configvars.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11

2-
2026-03-05-00-05-51
2+
2026-03-13-00-06-25
33

44
# Deprecation Notice
55

0 commit comments

Comments
 (0)