Skip to content
This repository was archived by the owner on Feb 25, 2019. It is now read-only.

Files

Latest commit

 

History

History
53 lines (37 loc) · 2.1 KB

configuration.md

File metadata and controls

53 lines (37 loc) · 2.1 KB

Configuration

Server Settings

Anvil Connect loads its configuration from a JSON file in the config directory of the current working directory for the process. File names must match the NODE_ENV value. If NODE_ENV is not set, config/development.json will be loaded.

Setting Type Default Description
issuer string (none) URI used to identify issuer of authentication
port integer 3000 Port the Connect server is bound to
cookie_secret string (generated) Secret string used to sign secure cookies
session_secret string (generated) Secret string used to sign session ID cookies
client_registration string scoped Type of client registration - dynamic, token, or scoped (Explanation)
trusted_registration_scope string realm Scope used to identify trusted clients.

OpenID Metadata

OpenID Provider Metadata default values can be overridden by defining them in the configuration file. Don't change these unless you know what you're doing.

Key pairs

If you generated a deployment repository with nv init, a new RSA key pair will be generated for you in connect/config/keys. This pair of files is required for signing and verifying tokens. If the server does not find key pairs when starting, it will attempt to generate them for you using the OpenSSL package installed on your system. Mac and most Unix and Linux based systems include OpenSSL by default. You can also install it on Windows.

If you want to provide your own RSA key pair files, you can generate them manually with OpenSSL.

$ cd PROJECT_ROOT
$ mkdir -p connect/config/keys
$ openssl genrsa -out connect/config/keys/private.pem 4096
$ openssl rsa -pubout -in connect/config/keys/private.pem -out connect/config/keys/public.pem