Skip to content
This repository has been archived by the owner on Mar 20, 2022. It is now read-only.

Configuration

Axel Rindle edited this page May 6, 2021 · 6 revisions

Configuration is done using environment variables. The following variables are available:

General

NODE_ENV

Indicates the runtime mode.

Possible values

  • debug: will enable debugging features.
  • production: recommended runtime mode.

GITHUB_API_TOKEN required

A GitHub token used to authorize against the API.

Application

APP_KEY required

This key is used mainly for encryption of session data, passwords, etc.

APP_LOCALE

The default application locale.

Default value: en

APP_HOST

The address the server will bind to.

Default value: 127.0.0.1

APP_PORT

The port the server should listen on.

Default value: 8080

APP_URL

The absolute URL the app will be reachable on. Using a HTTPS protocol will make the server listen on HTTPS.

Default value: http://${APP_HOST}:${APP_PORT}

MongoDB

MONGO_HOST

Default value: localhost

MONGO_PORT

Default value: 27017

MONGO_USER

Default value: root

MONGO_PASS

Default value: root

MONGO_DB

Default value: github-starred-index

MONGO_URI

Default value: mongodb://${MONGO_HOST}:${MONGO_PORT}/${MONGO_DB}?retryWrites=true&w=majority

Server

HTTP_LOGGING_ENABLED

Whether to log HTTP requests.

Default value: true

HTTP_LOGGING_FORMAT

Defines the log format for HTTP request logging.

Default value: short

See here for available values.

HTTPS_CERTIFICATE_FILE

HTTPS_CERTIFICATE_KEY

Scheduler

SCHEDULER_UPDATE_INDEX_INTERVAL

Defines the cron interval at which the repository index should be updated.

Default value: 0 * * * * (hourly)