Gateway Extension Configuration

Introduction

The Infinite Scale Frontend extension provides …​

Extensions are under development because of the beta badge 1 stage of Infinite Scale. Their service, environment variables and configuration may change. Forgive us if there are mistakes or information is missing. Feel free to report issues and we’ll take care of them as soon as possible on github. You want to fix them yourself? We’d appreciate that even more.

Configuration

Environment Variables

The gateway extension is configured via the following environment variables:

Environment variables for the gateway extension
Name Type Default Value Description

OCIS_TRACING_ENABLED
GATEWAY_TRACING_ENABLED

bool

false

Activates tracing.

OCIS_TRACING_TYPE
GATEWAY_TRACING_TYPE

string

OCIS_TRACING_ENDPOINT
GATEWAY_TRACING_ENDPOINT

string

The endpoint to the tracing collector.

OCIS_TRACING_COLLECTOR
GATEWAY_TRACING_COLLECTOR

string

OCIS_LOG_LEVEL
GATEWAY_LOG_LEVEL

string

The log level.

OCIS_LOG_PRETTY
GATEWAY_LOG_PRETTY

bool

false

Activates pretty log output.

OCIS_LOG_COLOR
GATEWAY_LOG_COLOR

bool

false

Activates colorized log output.

OCIS_LOG_FILE
GATEWAY_LOG_FILE

string

The target log file.

GATEWAY_DEBUG_ADDR

string

127.0.0.1:9143

Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed.

GATEWAY_DEBUG_TOKEN

string

Token to secure the metrics endpoint

GATEWAY_DEBUG_PPROF

bool

false

Enables pprof, which can be used for profiling

GATEWAY_DEBUG_ZPAGES

bool

false

Enables zpages, which can be used for collecting and viewing traces in-me

GATEWAY_GRPC_ADDR

string

127.0.0.1:9142

The address of the grpc service.

GATEWAY_GRPC_PROTOCOL

string

tcp

The transport protocol of the grpc service.

OCIS_JWT_SECRET
GATEWAY_JWT_SECRET

string

REVA_GATEWAY

string

127.0.0.1:9142

GATEWAY_SKIP_USER_GROUPS_IN_TOKEN

bool

false

GATEWAY_COMMIT_SHARE_TO_STORAGE_GRANT

bool

true

GATEWAY_COMMIT_SHARE_TO_STORAGE_REF

bool

true

GATEWAY_SHARE_FOLDER_NAME

string

Shares

GATEWAY_DISABLE_HOME_CREATION_ON_LOGIN

bool

true

STORAGE_TRANSFER_SECRET

string

GATEWAY_TRANSFER_EXPIRES

int

86400

GATEWAY_HOME_MAPPING

string

GATEWAY_ETAG_CACHE_TTL

int

0

OCIS_URL
GATEWAY_FRONTEND_PUBLIC_URL

string

https://localhost:9200

GATEWAY_USERS_ENDPOINT

string

localhost:9144

GATEWAY_GROUPS_ENDPOINT

string

localhost:9160

GATEWAY_PERMISSIONS_ENDPOINT

string

localhost:9191

GATEWAY_SHARING_ENDPOINT

string

localhost:9150

GATEWAY_AUTH_BASIC_ENDPOINT

string

localhost:9146

GATEWAY_AUTH_BEARER_ENDPOINT

string

localhost:9148

GATEWAY_AUTH_MACHINE_ENDPOINT

string

localhost:9166

GATEWAY_STORAGE_PUBLIC_LINK_ENDPOINT

string

localhost:9178

GATEWAY_STORAGE_USERS_ENDPOINT

string

localhost:9157

GATEWAY_STORAGE_SHARES_ENDPOINT

string

localhost:9154

GATEWAY_APP_REGISTRY_ENDPOINT

string

localhost:9242

Since Version: + added, - deprecated

YAML Example

# Autogenerated
# Filename: gateway-config-example.yaml

tracing:
  enabled: false
  type: ""
  endpoint: ""
  collector: ""
log:
  level: ""
  pretty: false
  color: false
  file: ""
debug:
  addr: 127.0.0.1:9143
  token: ""
  pprof: false
  zpages: false
grpc:
  addr: 127.0.0.1:9142
  protocol: tcp
token_manager:
  jwt_secret: ""
reva:
  address: 127.0.0.1:9142
skip_user_groups_in_token: false
commit_share_to_storage_grant: true
commit_share_to_storage_ref: true
share_folder_name: Shares
disable_home_creation_on_login: true
transfer_secret: ""
transfer_expires: 86400
home_mapping: ""
etag_cache_ttl: 0
frontend_public_url: https://localhost:9200
users_endpoint: localhost:9144
groups_endpoint: localhost:9160
permissions_endpoint: localhost:9191
sharing_endpoint: localhost:9150
auth_basic_endpoint: localhost:9146
auth_bearer_endpoint: localhost:9148
auth_machine_endpoint: localhost:9166
storage_public_link_endpoint: localhost:9178
storage_users_endpoint: localhost:9157
storage_shares_endpoint: localhost:9154
app_registry_endpoint: localhost:9242
storage_registry:
  driver: spaces
  rules: []
  json: ""