Skip to content

dex_worker job from dex/1

Github source: 1e6a7519 or master branch

Properties

dex

worker

api_use_client_credentials

Forces API to authenticate using client credentials instead of ID token. Clients must be ‘admin clients’ to use the API

Default
false
clients

Clients configuration

Default
  |+
    []
connectors

Connectors configuration

Default
  |+
    [
      {
        "type": "local",
        "id": "local"
      }
    ]
db_max_idle_conns

maximum number of connections in the idle connection pool

db_max_open_conns

maximum number of open connections to the database

db_url

DSN-formatted database connection string

emailer

Email configuration

Default
  |+
    {
        "type": "fake",
        "from": "[email protected]"
    }
enable_automatic_registration

When a user logs in through a federated identity service, automatically register them if they don’t have an account

Default
false
enable_client_registration

Allow dynamic registration of clients

Default
false
enable_registration

Allows users to self-register

Default
false
issuer_host

the issuer’s host

issuer_logo_url

URL of an image representing the issuer

issuer_name

The name of this dex installation; will appear on most pages

key_secrets

A comma-separated list of base64 encoded 32 byte strings used as symmetric keys used to encrypt/decrypt signing key data in DB. The first key is considered the active key and used for encryption, while the others are used to decrypt

log_debug

log debug-level information

Default
false
log_timestamps

prefix log lines with timestamps

Default
true
no_db

manage entities in-process w/o any encryption, used only for single-node testing

Default
false
port

the port that the server will listen on

Default
5556
tls_cert

the server’s certificate for TLS connection

tls_key

the server’s private key for TLS connection

users

Users configuration

Default
  |+
    []

Templates

Templates are rendered and placed onto corresponding instances during the deployment process. This job's templates will be placed into /var/vcap/jobs/dex_worker/ directory (learn more).

  • bin/dex_worker_ctl (from bin/dex_worker_ctl)
  • bin/post-start (from bin/post-start)
  • config/clients.json (from config/clients.json)
  • config/connectors.json (from config/connectors.json)
  • config/emailer.json (from config/emailer.json)
  • config/tls_cert.pem (from config/tls_cert.pem)
  • config/tls_key.pem (from config/tls_key.pem)
  • config/users.json (from config/users.json)

Packages

Packages are compiled and placed onto corresponding instances during the deployment process. Packages will be placed into /var/vcap/packages/ directory.