Skip to main content

Environment Variables

Every field in the service's Go config struct tagged with env:"..." is parsed at runtime by the envdecode loader. The table below is regenerated whenever the service's config struct changes.

Environment variables for the synaplan service

NameIntroduction VersionTypeDescriptionDefault Value
OC_LOG_LEVEL
SYNAPLAN_LOG_LEVEL
stringThe log level. Valid values are: 'panic', 'fatal', 'error', 'warn', 'info', 'debug', 'trace'.``
SYNAPLAN_DEBUG_ADDRstringBind address of the debug server.127.0.0.1:9267
SYNAPLAN_DEBUG_TOKENstringToken to secure the metrics endpoint.``
SYNAPLAN_DEBUG_PPROFboolEnables pprof.false
SYNAPLAN_DEBUG_ZPAGESboolEnables zpages.false
SYNAPLAN_HTTP_ADDRstringThe bind address of the HTTP service.127.0.0.1:9106
SYNAPLAN_HTTP_ROOTstringSubdirectory that serves as the root for this HTTP service./api/synaplan
OC_CORS_ALLOW_ORIGINS
SYNAPLAN_CORS_ALLOW_ORIGINS
[]string``[*]
OC_CORS_ALLOW_METHODS
SYNAPLAN_CORS_ALLOW_METHODS
[]string``[GET POST PUT DELETE]
OC_CORS_ALLOW_HEADERS
SYNAPLAN_CORS_ALLOW_HEADERS
[]string``[Authorization Origin Content-Type Accept X-Requested-With X-Request-Id]
OC_CORS_ALLOW_CREDENTIALS
SYNAPLAN_CORS_ALLOW_CREDENTIALS
bool``true
OC_HTTP_TLS_ENABLED1.0.0boolActivates TLS for the http based services using the server certifcate and key configured via OC_HTTP_TLS_CERTIFICATE and OC_HTTP_TLS_KEY. If OC_HTTP_TLS_CERTIFICATE is not set a temporary server certificate is generated - to be used with PROXY_INSECURE_BACKEND=true.false
OC_HTTP_TLS_CERTIFICATE1.0.0stringPath/File name of the TLS server certificate (in PEM format) for the http services.``
OC_HTTP_TLS_KEY1.0.0stringPath/File name for the TLS certificate key (in PEM format) for the server certificate to use for the http services.``
OC_GRPC_CLIENT_TLS_MODE1.0.0stringTLS mode for grpc connection to the go-micro based grpc services. Possible values are 'off', 'insecure' and 'on'. 'off': disables transport security for the clients. 'insecure' allows using transport security, but disables certificate verification (to be used with the autogenerated self-signed certificates). 'on' enables transport security, including server certificate verification.off
OC_GRPC_CLIENT_TLS_CACERT1.0.0stringPath/File name for the root CA certificate (in PEM format) used to validate TLS server certificates of the go-micro based grpc services.``
OC_JWT_SECRET
SYNAPLAN_JWT_SECRET
stringThe secret to mint and validate jwt tokens.``
OC_REVA_GATEWAYstringCS3 gateway used to look up user metadataeu.opencloud.api.gateway
OC_INSECURE
SYNAPLAN_INSECURE
boolRun in insecure mode.false
SYNAPLAN_URLstringBase URL of the Synaplan instance.``
SYNAPLAN_API_KEYstringShared Synaplan API key (sk_...). When set, the backend uses this for every outbound call and skips OIDC token exchange. Discouraged: all calls appear to Synaplan as a single user with no per-user identity.``
SYNAPLAN_MAX_COPY_BYTESint64Largest file, in bytes, copied from Synaplan into OpenCloud. Defaults to 104857600 (100 MiB), the body size Cloudflare accepts. A film does not fit in that; raise it where a larger body is allowed. The file is buffered in this service, so the process needs the memory.104857600
OC_OIDC_ISSUER
SYNAPLAN_OIDC_ISSUER
stringIssuer of the identity provider OpenCloud and Synaplan share. The endpoints below are read from its OpenID Connect discovery document unless they are set.``
SYNAPLAN_OIDC_AUTHORIZATION_ENDPOINTstringOptional. Authorization endpoint the person's browser asks for a code, instead of the published one.``
SYNAPLAN_OIDC_TOKEN_ENDPOINTstringOptional. Token endpoint as this service reaches it, instead of the published one (an internal address).``
SYNAPLAN_OIDC_REVOCATION_ENDPOINTstringOptional. Revocation endpoint (RFC 7009) as this service reaches it, instead of the published one.``
SYNAPLAN_OIDC_EXCHANGE_CLIENT_IDstringClient ID for the token exchange confidential client.``
SYNAPLAN_OIDC_EXCHANGE_CLIENT_SECRETstringClient secret for the token exchange confidential client.``
SYNAPLAN_OIDC_TARGET_AUDIENCEstringTarget audience (Synaplan client ID) for token exchange.``
SYNAPLAN_DEFAULT_ANSWER_LANGUAGEstringLanguage Synaplan answers in (ISO 639-1: en, de, fr, es, it, pt, nl, pl, tr, ru, ja, zh, ko or ar) until an administrator saves another one on the Synaplan page. Another value stops the service at start.en
SYNAPLAN_USE_USER_LANGUAGEboolAnswer in each person's OpenCloud interface language when it is supported, with the default answer language as the fallback, until an administrator saves another choice on the Synaplan page.true
OC_MACHINE_AUTH_API_KEY
SYNAPLAN_MACHINE_AUTH_API_KEY
stringOpenCloud's machine auth API key. Watches and folder reads use it to read a person's files while that person is away, and only for people who allowed Synaplan to work while they are away. Empty turns that off: watched files are then only sent when the person checks a watch themselves.``
SYNAPLAN_USER_OIDC_CLAIMstringClaim of the person's token that names their OpenCloud user. Set it to OpenCloud's PROXY_USER_OIDC_CLAIM.preferred_username
SYNAPLAN_USER_CS3_CLAIMstringOpenCloud user attribute that claim is matched against: 'username', 'mail' or 'userid'. Set it to OpenCloud's PROXY_USER_CS3_CLAIM.username
OC_PERSISTENT_STORE
SYNAPLAN_STORE
stringWhere the offline tokens of people who allowed work while away, each person's own settings, and the administrator's settings are kept. 'nats-js-kv' is OpenCloud's JetStream key-value store, shared by every replica of this service. 'memory' keeps them in this process: a restart forgets them and other replicas never see them. Other values OpenCloud knows, such as redis-sentinel, are not supported here.nats-js-kv
OC_PERSISTENT_STORE_NODES
SYNAPLAN_STORE_NODES
[]stringAddresses of OpenCloud's NATS, as host:port. A comma-separated list when there is more than one. Only applies when the store is nats-js-kv. NATS must be 2.11 or later.[127.0.0.1:9233]
SYNAPLAN_STORE_DATABASEstringJetStream key-value bucket for the offline tokens.synaplan-delegation
SYNAPLAN_STORE_PREFERENCES_DATABASEstringJetStream key-value bucket for each person's own Synaplan settings, such as what Synaplan may read. Kept in the same store as the offline tokens.synaplan-preferences
SYNAPLAN_STORE_SETTINGS_DATABASEstringJetStream key-value bucket for the administrator's settings from the Synaplan page.synaplan-settings
SYNAPLAN_STORE_SYNCED_DATABASEstringJetStream key-value bucket for the searchable files people keep up to date: which file, in which knowledge folder, and the version Synaplan last took. The memory store keeps them in this process instead.synaplan-synced
SYNAPLAN_STORE_REPLICASintHow many NATS servers keep a copy of each bucket, in a NATS cluster. The buckets' settings are applied at every start, so they replace changes made to them by hand.1
OC_PERSISTENT_STORE_AUTH_USERNAME
SYNAPLAN_STORE_AUTH_USERNAME
stringUsername for OpenCloud's NATS. Only applies when the store is nats-js-kv.``
OC_PERSISTENT_STORE_AUTH_PASSWORD
SYNAPLAN_STORE_AUTH_PASSWORD
stringPassword for OpenCloud's NATS. Only applies when the store is nats-js-kv.``
OC_PERSISTENT_STORE_ENABLE_TLS
SYNAPLAN_STORE_ENABLE_TLS
boolUse TLS to reach OpenCloud's NATS. Only applies when the store is nats-js-kv.false
OC_INSECURE
OC_PERSISTENT_STORE_TLS_INSECURE
SYNAPLAN_STORE_TLS_INSECURE
boolSkip verification of NATS's certificate. Only applies when TLS is enabled and no root CA is set.false
OC_PERSISTENT_STORE_TLS_ROOT_CA_CERTIFICATE
SYNAPLAN_STORE_TLS_ROOT_CA_CERTIFICATE
stringRoot CA used to verify NATS's certificate. When set, insecure verification is ignored.``
SYNAPLAN_STORE_ENCRYPTION_SECRETstringSecret the key that encrypts the offline tokens is derived from. Keep it like any other secret; anyone with it and a copy of the store can read the tokens. Defaults to the exchange client secret, so changing that secret then makes everyone allow again.``
SYNAPLAN_STORE_ENCRYPTION_PREVIOUS_SECRETS[]stringEarlier encryption secrets, still used to read tokens written before a rotation. A token moves to the current secret the next time it is used. A comma-separated list.[]