App-Registry Service Configuration

Introduction

The Infinite Scale App-Registry service

Default Values

  • App-Registry listens on port 9240 by default.

Configuration

Environment Variables

The app-registry service is configured via the following environment variables:

  • latest

  • 4.0.1

  • 3.0.0

Deprecation notes for the app-registry service
Deprecation Info Deprecation Version Removal Version Deprecation Replacement
Environment variables for the app-registry service
Name Type Default Value Description

OCIS_TRACING_ENABLED
APP_REGISTRY_TRACING_ENABLED

bool

false

Activates tracing.

OCIS_TRACING_TYPE
APP_REGISTRY_TRACING_TYPE

string

The type of tracing. Defaults to '', which is the same as 'jaeger'. Allowed tracing types are 'jaeger' and '' as of now.

OCIS_TRACING_ENDPOINT
APP_REGISTRY_TRACING_ENDPOINT

string

The endpoint of the tracing agent.

OCIS_TRACING_COLLECTOR
APP_REGISTRY_TRACING_COLLECTOR

string

The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. Only used if the tracing endpoint is unset.

OCIS_LOG_LEVEL
APP_REGISTRY_LOG_LEVEL

string

The log level. Valid values are: 'panic', 'fatal', 'error', 'warn', 'info', 'debug', 'trace'.

OCIS_LOG_PRETTY
APP_REGISTRY_LOG_PRETTY

bool

false

Activates pretty log output.

OCIS_LOG_COLOR
APP_REGISTRY_LOG_COLOR

bool

false

Activates colorized log output.

OCIS_LOG_FILE
APP_REGISTRY_LOG_FILE

string

The path to the log file. Activates logging to this file if set.

APP_REGISTRY_DEBUG_ADDR

string

127.0.0.1:9243

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

APP_REGISTRY_DEBUG_TOKEN

string

Token to secure the metrics endpoint.

APP_REGISTRY_DEBUG_PPROF

bool

false

Enables pprof, which can be used for profiling.

APP_REGISTRY_DEBUG_ZPAGES

bool

false

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

APP_REGISTRY_GRPC_ADDR

string

127.0.0.1:9242

The bind address of the GRPC service.

APP_REGISTRY_GRPC_PROTOCOL

string

tcp

The transport protocol of the GRPC service.

OCIS_JWT_SECRET
APP_REGISTRY_JWT_SECRET

string

The secret to mint and validate jwt tokens.

OCIS_REVA_GATEWAY

string

com.owncloud.api.gateway

The CS3 gateway endpoint.

OCIS_GRPC_CLIENT_TLS_MODE

string

TLS 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.

OCIS_GRPC_CLIENT_TLS_CACERT

string

Path/File name for the root CA certificate (in PEM format) used to validate TLS server certificates of the go-micro based grpc services.
Deprecation notes for the app-registry service
Deprecation Info Deprecation Version Removal Version Deprecation Replacement
Environment variables for the app-registry service
Name Type Default Value Description

OCIS_TRACING_ENABLED
APP_REGISTRY_TRACING_ENABLED

bool

false

Activates tracing.

OCIS_TRACING_TYPE
APP_REGISTRY_TRACING_TYPE

string

The type of tracing. Defaults to '', which is the same as 'jaeger'. Allowed tracing types are 'jaeger' and '' as of now.

OCIS_TRACING_ENDPOINT
APP_REGISTRY_TRACING_ENDPOINT

string

The endpoint of the tracing agent.

OCIS_TRACING_COLLECTOR
APP_REGISTRY_TRACING_COLLECTOR

string

The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. Only used if the tracing endpoint is unset.

OCIS_LOG_LEVEL
APP_REGISTRY_LOG_LEVEL

string

The log level. Valid values are: 'panic', 'fatal', 'error', 'warn', 'info', 'debug', 'trace'.

OCIS_LOG_PRETTY
APP_REGISTRY_LOG_PRETTY

bool

false

Activates pretty log output.

OCIS_LOG_COLOR
APP_REGISTRY_LOG_COLOR

bool

false

Activates colorized log output.

OCIS_LOG_FILE
APP_REGISTRY_LOG_FILE

string

The path to the log file. Activates logging to this file if set.

APP_REGISTRY_DEBUG_ADDR

string

127.0.0.1:9243

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

APP_REGISTRY_DEBUG_TOKEN

string

Token to secure the metrics endpoint.

APP_REGISTRY_DEBUG_PPROF

bool

false

Enables pprof, which can be used for profiling.

APP_REGISTRY_DEBUG_ZPAGES

bool

false

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

APP_REGISTRY_GRPC_ADDR

string

127.0.0.1:9242

The bind address of the GRPC service.

APP_REGISTRY_GRPC_PROTOCOL

string

tcp

The transport protocol of the GRPC service.

OCIS_JWT_SECRET
APP_REGISTRY_JWT_SECRET

string

The secret to mint and validate jwt tokens.

OCIS_REVA_GATEWAY

string

com.owncloud.api.gateway

The CS3 gateway endpoint.

OCIS_GRPC_CLIENT_TLS_MODE

string

TLS 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.

OCIS_GRPC_CLIENT_TLS_CACERT

string

Path/File name for the root CA certificate (in PEM format) used to validate TLS server certificates of the go-micro based grpc services.
Deprecation notes for the app-registry service
Deprecation Info Deprecation Version Removal Version Deprecation Replacement

REVA_GATEWAY changing name for consistency

3.0

4.0.0

OCIS_REVA_GATEWAY
Environment variables for the app-registry service
Name Type Default Value Description

OCIS_TRACING_ENABLED
APP_REGISTRY_TRACING_ENABLED

bool

false

Activates tracing.

OCIS_TRACING_TYPE
APP_REGISTRY_TRACING_TYPE

string

The type of tracing. Defaults to "", which is the same as "jaeger". Allowed tracing types are "jaeger" and "" as of now.

OCIS_TRACING_ENDPOINT
APP_REGISTRY_TRACING_ENDPOINT

string

The endpoint of the tracing agent.

OCIS_TRACING_COLLECTOR
APP_REGISTRY_TRACING_COLLECTOR

string

The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces. Only used if the tracing endpoint is unset.

OCIS_LOG_LEVEL
APP_REGISTRY_LOG_LEVEL

string

The log level. Valid values are: "panic", "fatal", "error", "warn", "info", "debug", "trace".

OCIS_LOG_PRETTY
APP_REGISTRY_LOG_PRETTY

bool

false

Activates pretty log output.

OCIS_LOG_COLOR
APP_REGISTRY_LOG_COLOR

bool

false

Activates colorized log output.

OCIS_LOG_FILE
APP_REGISTRY_LOG_FILE

string

The path to the log file. Activates logging to this file if set.

APP_REGISTRY_DEBUG_ADDR

string

127.0.0.1:9243

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

APP_REGISTRY_DEBUG_TOKEN

string

Token to secure the metrics endpoint.

APP_REGISTRY_DEBUG_PPROF

bool

false

Enables pprof, which can be used for profiling.

APP_REGISTRY_DEBUG_ZPAGES

bool

false

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

APP_REGISTRY_GRPC_ADDR

string

127.0.0.1:9242

The bind address of the GRPC service.

APP_REGISTRY_GRPC_PROTOCOL

string

tcp

The transport protocol of the GRPC service.

OCIS_JWT_SECRET
APP_REGISTRY_JWT_SECRET

string

The secret to mint and validate jwt tokens.

OCIS_REVA_GATEWAY
REVA_GATEWAY
Deprecation Note

string

127.0.0.1:9142

The CS3 gateway endpoint.

OCIS_GRPC_CLIENT_TLS_MODE

string

TLS 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.

OCIS_GRPC_CLIENT_TLS_CACERT

string

Path/File name for the root CA certificate (in PEM format) used to validate TLS server certificates of the go-micro based grpc services.

YAML Example

Note that the filename shown below has been chosen on purpose.
See the Configuration File Naming for details when setting up your own configuration.

  • latest

  • 4.0.1

  • 3.0.0

# Autogenerated
# Filename: app-registry-config-example.yaml

tracing:
  enabled: false
  type: ""
  endpoint: ""
  collector: ""
log:
  level: ""
  pretty: false
  color: false
  file: ""
debug:
  addr: 127.0.0.1:9243
  token: ""
  pprof: false
  zpages: false
grpc:
  addr: 127.0.0.1:9242
  tls: null
  protocol: tcp
token_manager:
  jwt_secret: ""
reva:
  address: com.owncloud.api.gateway
  tls:
    mode: ""
    cacert: ""
app_registry:
  mimetypes:
  - mime_type: application/pdf
    extension: pdf
    name: PDF
    description: PDF document
    icon: ""
    default_app: ""
    allow_creation: false
  - mime_type: application/vnd.oasis.opendocument.text
    extension: odt
    name: OpenDocument
    description: OpenDocument text document
    icon: ""
    default_app: ""
    allow_creation: true
  - mime_type: application/vnd.oasis.opendocument.spreadsheet
    extension: ods
    name: OpenSpreadsheet
    description: OpenDocument spreadsheet document
    icon: ""
    default_app: ""
    allow_creation: true
  - mime_type: application/vnd.oasis.opendocument.presentation
    extension: odp
    name: OpenPresentation
    description: OpenDocument presentation document
    icon: ""
    default_app: ""
    allow_creation: true
  - mime_type: application/vnd.openxmlformats-officedocument.wordprocessingml.document
    extension: docx
    name: Microsoft Word
    description: Microsoft Word document
    icon: ""
    default_app: ""
    allow_creation: true
  - mime_type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
    extension: xlsx
    name: Microsoft Excel
    description: Microsoft Excel document
    icon: ""
    default_app: ""
    allow_creation: true
  - mime_type: application/vnd.openxmlformats-officedocument.presentationml.presentation
    extension: pptx
    name: Microsoft PowerPoint
    description: Microsoft PowerPoint document
    icon: ""
    default_app: ""
    allow_creation: true
  - mime_type: application/vnd.jupyter
    extension: ipynb
    name: Jupyter Notebook
    description: Jupyter Notebook
    icon: ""
    default_app: ""
    allow_creation: false
  - mime_type: text/markdown
    extension: md
    name: Markdown file
    description: Markdown file
    icon: ""
    default_app: ""
    allow_creation: true
  - mime_type: application/compressed-markdown
    extension: zmd
    name: Compressed markdown file
    description: Compressed markdown file
    icon: ""
    default_app: ""
    allow_creation: false
# Autogenerated
# Filename: app-registry-config-example.yaml

tracing:
  enabled: false
  type: ""
  endpoint: ""
  collector: ""
log:
  level: ""
  pretty: false
  color: false
  file: ""
debug:
  addr: 127.0.0.1:9243
  token: ""
  pprof: false
  zpages: false
grpc:
  addr: 127.0.0.1:9242
  tls: null
  protocol: tcp
token_manager:
  jwt_secret: ""
reva:
  address: com.owncloud.api.gateway
  tls:
    mode: ""
    cacert: ""
app_registry:
  mimetypes:
  - mime_type: application/pdf
    extension: pdf
    name: PDF
    description: PDF document
    icon: ""
    default_app: ""
    allow_creation: false
  - mime_type: application/vnd.oasis.opendocument.text
    extension: odt
    name: OpenDocument
    description: OpenDocument text document
    icon: ""
    default_app: ""
    allow_creation: true
  - mime_type: application/vnd.oasis.opendocument.spreadsheet
    extension: ods
    name: OpenSpreadsheet
    description: OpenDocument spreadsheet document
    icon: ""
    default_app: ""
    allow_creation: true
  - mime_type: application/vnd.oasis.opendocument.presentation
    extension: odp
    name: OpenPresentation
    description: OpenDocument presentation document
    icon: ""
    default_app: ""
    allow_creation: true
  - mime_type: application/vnd.openxmlformats-officedocument.wordprocessingml.document
    extension: docx
    name: Microsoft Word
    description: Microsoft Word document
    icon: ""
    default_app: ""
    allow_creation: true
  - mime_type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
    extension: xlsx
    name: Microsoft Excel
    description: Microsoft Excel document
    icon: ""
    default_app: ""
    allow_creation: true
  - mime_type: application/vnd.openxmlformats-officedocument.presentationml.presentation
    extension: pptx
    name: Microsoft PowerPoint
    description: Microsoft PowerPoint document
    icon: ""
    default_app: ""
    allow_creation: true
  - mime_type: application/vnd.jupyter
    extension: ipynb
    name: Jupyter Notebook
    description: Jupyter Notebook
    icon: ""
    default_app: ""
    allow_creation: false
  - mime_type: text/markdown
    extension: md
    name: Markdown file
    description: Markdown file
    icon: ""
    default_app: ""
    allow_creation: true
  - mime_type: application/compressed-markdown
    extension: zmd
    name: Compressed markdown file
    description: Compressed markdown file
    icon: ""
    default_app: ""
    allow_creation: false
# Autogenerated
# Filename: app-registry-config-example.yaml

tracing:
  enabled: false
  type: ""
  endpoint: ""
  collector: ""
log:
  level: ""
  pretty: false
  color: false
  file: ""
debug:
  addr: 127.0.0.1:9243
  token: ""
  pprof: false
  zpages: false
grpc:
  addr: 127.0.0.1:9242
  tls: null
  protocol: tcp
token_manager:
  jwt_secret: ""
reva:
  address: 127.0.0.1:9142
  tls:
    mode: ""
    cacert: ""
app_registry:
  mimetypes:
  - mime_type: application/pdf
    extension: pdf
    name: PDF
    description: PDF document
    icon: ""
    default_app: ""
    allow_creation: false
  - mime_type: application/vnd.oasis.opendocument.text
    extension: odt
    name: OpenDocument
    description: OpenDocument text document
    icon: ""
    default_app: ""
    allow_creation: true
  - mime_type: application/vnd.oasis.opendocument.spreadsheet
    extension: ods
    name: OpenSpreadsheet
    description: OpenDocument spreadsheet document
    icon: ""
    default_app: ""
    allow_creation: true
  - mime_type: application/vnd.oasis.opendocument.presentation
    extension: odp
    name: OpenPresentation
    description: OpenDocument presentation document
    icon: ""
    default_app: ""
    allow_creation: true
  - mime_type: application/vnd.openxmlformats-officedocument.wordprocessingml.document
    extension: docx
    name: Microsoft Word
    description: Microsoft Word document
    icon: ""
    default_app: ""
    allow_creation: true
  - mime_type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
    extension: xlsx
    name: Microsoft Excel
    description: Microsoft Excel document
    icon: ""
    default_app: ""
    allow_creation: true
  - mime_type: application/vnd.openxmlformats-officedocument.presentationml.presentation
    extension: pptx
    name: Microsoft PowerPoint
    description: Microsoft PowerPoint document
    icon: ""
    default_app: ""
    allow_creation: true
  - mime_type: application/vnd.jupyter
    extension: ipynb
    name: Jupyter Notebook
    description: Jupyter Notebook
    icon: ""
    default_app: ""
    allow_creation: false
  - mime_type: text/markdown
    extension: md
    name: Markdown file
    description: Markdown file
    icon: ""
    default_app: ""
    allow_creation: true
  - mime_type: application/compressed-markdown
    extension: zmd
    name: Compressed markdown file
    description: Compressed markdown file
    icon: ""
    default_app: ""
    allow_creation: false