Configuration

Environment

This page holds a list of the environment variables that Koype looks for and uses when it’s running.

CANONICAL_HOST

Type String
Description The host (and port) used in URLs generated by Koype.
Example localhost:4000, koype.net

CANONICAL_SCHEME

Type String
Description The scheme used in URLs generated by Koype.
Example http, https

NOTE: Only http and https are valid here.

HMR_PORT

Type Integer
Description The port Parcel uses for hot module reloading.
Example 5010`

SESSION_SIGNING_SALT

Type String
Description A secret value used to sign session information.

You can generate a useful value by running openssl rand -hex 16 in your terminal and using the resulting output. Koype generates a key for you if none is provided.

PORT

Type Integer
Description The port number that Koype will listen on.

SECRET_KEY_BASE

Type String
Description A value used to build secret keys for session signing.

GUARDIAN_SECRET_KEY

Type String
Description A value used to build secret keys for authentication.

Object Storage

OBJECT_STORAGE_BUCKET

Type String
Description The name of the bucket/folder that Koype will store all of its assets in.

OBJECT_STORAGE_ACCESS_KEY

Type String
Description The key used to connect to the S3-emulating server.

OBJECT_STORAGE_SECRET_KEY

Type String
Description The secret used to connect to the S3-emulating server.

OBJECT_STORAGE_SCHEME

Type String
Description The protocol scheme used to connect to the S3-emulating server.

OBJECT_STORAGE_PORT

Type String
Description The port used to connect to the S3-emulating server.

OBJECT_STORAGE_HOST

Type String
Description The hostname used to connect to the S3-emulating server.

Testing

These variables are only used in the test environment.

TEST_HOST

TEST_PORT