fxa-auth-server/config/config.js

/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

module.exports = function (fs, path, url, convict) {
  const AVAILABLE_BACKENDS = ["memory", "mysql"]

  var conf = convict({
    env: {
      doc: "The current node.js environment",
      default: "dev",
      format: [ "dev", "test", "stage", "prod" ],
      env: 'NODE_ENV'
    },
    log: {
      level: {
        default: 'info'
      }
    },
    publicUrl: {
      format: "url",
      // the real url is set by awsbox
      default: "http://127.0.0.1:9000",
      env: "PUBLIC_URL"
    },
    secretKeyFile: {
      default: path.resolve(__dirname, '../config/secret-key.json')
    },
    publicKeyFile: {
      default: path.resolve(__dirname, '../config/public-key.json')
    },
    db: {
      backend: {
        format: AVAILABLE_BACKENDS,
        default: "memory",
        env: 'DB_BACKEND'
      },
      available_backends: {
        doc: "List of available key-value stores",
        default: AVAILABLE_BACKENDS
      }
    },
    mysql: {
      createSchema: {
        default: true,
        env: 'CREATE_MYSQL_SCHEMA'
      },
      master: {
        user: {
          default: 'root',
          env: 'MYSQL_USERNAME'
        },
        password: {
          default: '',
          env: 'MYSQL_PASSWORD'
        },
        database: {
          default: 'fxa',
          env: 'MYSQL_DATABASE'
        },
        host: {
          default: '127.0.0.1',
          env: 'MYSQL_HOST'
        },
        port: {
          default: '3306',
          env: 'MYSQL_PORT'
        },
        connectionLimit: {
          doc: "The maximum number of connections to create at once.",
          default: 100,
          format: 'nat',
          env: 'CONNECTION_LIMIT'
        },
        waitForConnections: {
          doc: "Determines the pool's action when no connections are available and the limit has been reached.",
          default: true,
          format: Boolean,
          env: 'WAIT_FOR_CONNECTIONS'
        }
      },
      slave : {
        user: {
          default: 'root',
          env: 'MYSQL_SLAVE_USERNAME'
        },
        password: {
          default: '',
          env: 'MYSQL_SLAVE_PASSWORD'
        },
        database: {
          default: 'fxa',
          env: 'MYSQL_SLAVE_DATABASE'
        },
        host: {
          default: '127.0.0.1',
          env: 'MYSQL_SLAVE_HOST'
        },
        port: {
          default: '3306',
          env: 'MYSQL_SLAVE_PORT'
        },
        connectionLimit: {
          doc: "The maximum number of connections to create at once.",
          default: 100,
          format: 'nat',
          env: 'SLAVE_CONNECTION_LIMIT'
        },
        waitForConnections: {
          doc: "Determines the pool's action when no connections are available and the limit has been reached.",
          default: true,
          format: Boolean,
          env: 'SLAVE_WAIT_FOR_CONNECTIONS'
        }
      }
    },
    listen: {
      host: {
        doc: "The ip address the server should bind",
        default: '127.0.0.1',
        format: 'ipaddress',
        env: 'IP_ADDRESS'
      },
      port: {
        doc: "The port the server should bind",
        default: 9000,
        format: 'port',
        env: 'PORT'
      }
    },
    contentServer: {
      url: {
        doc: "The url of the correspoding fxa-content-server instance",
        default: 'http://127.0.0.1:3030',
        env: 'CONTENT_SERVER_URL'
      }
    },
    smtp: {
      api: {
        host: {
          doc: 'host for bin/mail_helper.js',
          default: '127.0.0.1',
          env: 'MAILER_HOST'
        },
        port: {
          doc: 'port for bin/mail_helper.js',
          default: 9001,
          env: 'MAILER_PORT'
        }
      },
      host: {
        doc: 'SMTP host for sending email',
        default: 'localhost',
        env: 'SMTP_HOST'
      },
      port: {
        doc: 'SMTP port',
        default: 25,
        env: 'SMTP_PORT'
      },
      secure: {
        doc: 'Connect to SMTP host securely',
        default: false,
        env: 'SMTP_SECURE'
      },
      user: {
        doc: 'SMTP username',
        format: String,
        default: undefined,
        env: 'SMTP_USER'
      },
      password: {
        doc: 'SMTP password',
        format: String,
        default: undefined,
        env: 'SMTP_PASS'
      },
      sender: {
        doc: 'email address of the sender',
        default: 'Firefox Accounts <no-reply@lcip.org>',
        env: 'SMTP_SENDER'
      },
      verificationUrl: {
        doc: 'The landing page for verify emails',
        format: String,
        default: undefined,
        env: 'VERIFY_URL',
        arg: 'verify-url'
      },
      passwordResetUrl: {
        doc: 'The landing page for password reset emails',
        format: String,
        default: undefined,
        env: 'RESET_URL',
        arg: 'reset-url'
      },
      reportUrl: {
        doc: 'A page where users can report suspicious activity',
        format: String,
        default: '#'
      },
      redirectDomain: {
        doc: 'Domain that mail urls are allowed to redirect to',
        format: String,
        default: 'firefox.com'
      },
      templatePath: {
        doc: 'path to the email template directory',
        default: path.resolve(__dirname, '../templates/email')
      }
    },
    redis: {
      host: {
        default: '',
        env: 'REDIS_HOST'
      },
      port: {
        default: 6379,
        env: 'REDIS_PORT'
      },
      database: {
        default: 0,
        env: 'REDIS_DATABASE'
      },
      password: {
        default: '',
        env: 'REDIS_PASSWORD'
      }
    },
    toobusy: {
      maxLag: {
        doc: "Max event-loop lag before toobusy reports failure",
        default: 70,
        env: 'TOOBUSY_MAX_LAG'
      }
    },
    i18n: {
      defaultLang: {
        format: String,
        default: "en"
      },
      supportedLanguages: {
        doc: "List of languages this deployment should detect and display localized strings.",
        format: Array,
        default: ['en', 'en-AU'],
        env: 'I18N_SUPPORTED_LANGUAGES'
      },
      translationDirectory: {
        doc: "The directory where per-locale .json files containing translations reside",
        format: String,
        default: "resources/i18n/",
        env: "I18N_TRANSLATION_DIR"
      },
      translationType: {
        doc: "The file format used for the translations",
        format: String,
        default: "key-value-json",
        env: "I18N_TRANSLATION_TYPE"
      }
    }
  })

  // handle configuration files.  you can specify a CSV list of configuration
  // files to process, which will be overlayed in order, in the CONFIG_FILES
  // environment variable. By default, the ./config/<env>.json file is loaded.

  var envConfig = path.join(__dirname, conf.get('env') + '.json')
  var files = (envConfig + ',' + process.env.CONFIG_FILES)
                .split(',').filter(fs.existsSync)
  conf.loadFile(files)

  // set the public url as the issuer domain for assertions
  conf.set('domain', url.parse(conf.get('publicUrl')).host)

  if (!conf.has('smtp.verificationUrl')) {
    conf.set('smtp.verificationUrl', conf.get('publicUrl') + '/v1/verify_email')
  }

  if (!conf.has('smtp.passwordResetUrl')) {
    conf.set('smtp.passwordResetUrl', conf.get('publicUrl') + '/v1/reset_password')
  }

  conf.validate()

  return conf
}