JavaScript HTML Other
Switch branches/tags
Latest commit 6fd020d Jun 22, 2017 @philbooth philbooth committed on GitHub fix(server): do not return flowId from consumeSigninCodes endpoint
#1952
r=vbudhram
Permalink
Failed to load latest commit information.
bin fix(mailer): escape json output (#1853) r=vladikoff Apr 26, 2017
config feat(bounces): add tiers to bounce blocklist Jun 8, 2017
docs chore(docs): document the newsletter flow events Jun 21, 2017
grunttasks fix(project): move mailer files into proper directories (#1676) r=vla… Feb 24, 2017
lib fix(server): do not return flowId from consumeSigninCodes endpoint Jun 22, 2017
scripts feat(server): add endpoint for consuming signinCodes May 29, 2017
test fix(server): do not return flowId from consumeSigninCodes endpoint Jun 22, 2017
.dockerignore feat(docker): Add Dockerfile for self-hosting Jan 26, 2016
.eslintrc test(lint): add lint for synchronous randomBytes usage Oct 27, 2016
.gitignore chore(files): remove vagrant config Mar 23, 2017
.nsprc fix(project): move mailer files into proper directories (#1676) r=vla… Feb 24, 2017
.travis.yml Make our test suite faster (again) (#1938) r=vladikoff Jun 9, 2017
AUTHORS chore(docs): update docs, AUTHORS Feb 22, 2017
CHANGELOG.md Release v1.89.0 Jun 14, 2017
CONTRIBUTING.md docs(contributing): Mention git commit guidelines Jan 21, 2016
Dockerfile-build chore(docker): Use official node image & update to Node.js v4.8.2 (#1840 Apr 19, 2017
Dockerfile-test fix(docker): prevent duplicate installation of dev dependencies (#1730)… Mar 17, 2017
Gruntfile.js fix(project): move mailer files into proper directories (#1676) r=vla… Feb 24, 2017
LICENSE Add a proper copy of the MPL May 16, 2014
README.md refactor(server): remove separate notifier process (#1800) r=vbudhram Apr 20, 2017
circle.yml Make our test suite faster (again) (#1938) r=vladikoff Jun 9, 2017
npm-shrinkwrap.json Release v1.89.0 Jun 14, 2017
package.json Release v1.89.0 Jun 14, 2017

README.md

Firefox Accounts Server

Build Status Coverage Status CircleCI

This project implements the core server-side API for Firefox Accounts. It provides account, device and encryption-key management for the Mozilla Cloud Services ecosystem.

Overview

Detailed design document

Detailed API spec

Guidelines for Contributing

Prerequisites

  • node 4.8.x+
  • npm 2
  • Grunt
  • postfix

Install

On some systems running the server as root will cause working directory permissions issues with node. It is recommended that you create a separate, standard user to ensure a clean and more secure installation.

Clone the git repository and install dependencies:

git clone git://github.com/mozilla/fxa-auth-server.git
cd fxa-auth-server
npm install

To start the server in dev memory store mode (ie. NODE_ENV=dev), run:

npm start

This runs a script scripts/start-local.sh as defined in package.json. This will start up 4 services, three of which listen on the following ports (by default):

  • bin/key_server.js on port 9000
  • test/mail_helper.js on port 9001
  • ./node_modules/fxa-customs-server/bin/customs_server.js on port 7000

When you Ctrl-c your server, all 4 processes will be stopped.

To start the server in dev MySQL store mode (ie. NODE_ENV=dev), run:

npm run start-mysql

Testing

Run tests with:

npm test

To select a specific glob of tests to run:

npm test -- test/local/account_routes.js test/local/password_*
  • Note: stop the auth-server before running tests. Otherwise, they will fail with obscure errors.
  • You can use LOG_LEVEL, such as LOG_LEVEL=debug to specify the test logging level.

Mailer

The mailer library is located in mailer/ directory.

The emails are written to postfix which tends sends them off to SES.

The auth-mailer also includes a restify API to send emails, but the auth server is using it as a library at the moment.

Changing Templates

If you are changing or adding templates then you need to update .html and .txt templates. In mailer/, use the /partials directory to make changes to the HTML templates, then run grunt templates to regenerate the template. This saves the HTML template into /templates. Then make changes to the .txt template in the /templates directory.

L10N

After updating a string in one of the templates in ./mailer/templates you'll need to extract the strings. Follow the instructions at mozilla/fxa-content-server-l10n.

Production

Use the FXA_L10N_SHA to pin L10N files to certain SHA. If not set then the master SHA will be used.

Reference Client

https://github.com/mozilla/fxa-js-client

Dev Deployment

Refer to https://github.com/mozilla/fxa-dev.git.

Configuration

Configuration of this project is managed by convict, using the schema in config/index.js.

Default values from this schema can be overridden in two ways:

  1. By setting individual environment variables, as indicated by the env property for each item in the schema.

    For example:

    export CONTENT_SERVER_URL="http://your.content.server.org"
  2. By specifying the path to a conforming JSON file, or a comma-separated list of paths, using the CONFIG_FILES environment variable. Files specified in this way are loaded when the server starts. If the server fails to start, it usually indicates that one of these JSON files does not conform to the schema; check the error message for more information.

    For example:

    export CONFIG_FILES="~/fxa-content-server.json,~/fxa-db.json"

Troubleshooting

Firefox Accounts authorization is a complicated flow. You can get verbose logging by adjusting the log level in the config.json on your deployed instance. Add a stanza like:

"log": {
  "level": "trace"
}

Valid level values (from least to most verbose logging) include: "fatal", "error", "warn", "info", "trace", "debug".

Database integration

This server depends on a database server from the fxa-auth-db-mysql repo. When running the tests, it uses a memory-store that mocks behaviour of the production MySQL server.

License

MPL 2.0