Firefox Monitor arms you with tools to keep your personal information safe. Find out what hackers already know about you and learn how to stay a step ahead of them.
Перейти к файлу
lesleyjanenorton 51f8ca273e Adds npm scripts for autoprefixing & minifying.
- Concatenates and minifies JS files for production
- Minifies CSS and transpiles variables into something less harrowing for IE11.
- Updates default.hbs to import the new files.
2018-09-20 16:30:08 -05:00
.circleci remove linting from circle; handled by travis 2018-08-30 15:34:02 -05:00
controllers for #255: more friendly error messages 2018-09-18 07:19:28 -05:00
db fix #364: show error when unsubscribe token isn't found 2018-09-10 16:16:05 -05:00
loadtests change loadtests to locust 2018-08-28 15:29:32 -05:00
public Adds npm scripts for autoprefixing & minifying. 2018-09-20 16:30:08 -05:00
routes Fix test / review updates 2018-09-12 15:48:41 -05:00
scripts fix #107: DELETE_UNVERIFIED_SUBSCRIBERS_TIMER and logic 2018-08-26 23:27:07 -05:00
tests Merge pull request #432 from mozilla/check-hibp-scan-response-415 2018-09-20 15:29:37 -05:00
views Adds npm scripts for autoprefixing & minifying. 2018-09-20 16:30:08 -05:00
.dockerignore Removes version.json from the .dockerignore file. 2018-06-08 16:21:54 -04:00
.env-dist correct doc for HIBP_THROTTLE_DELAY 2018-09-20 15:18:41 -05:00
.eslintignore eslintignore locust-generated js pages 2018-08-29 09:14:15 -05:00
.eslintrc.js Add ESLint eol-last and no-trailing-spaces rules 2018-09-13 12:06:13 -07:00
.gitignore for #254: convert testing scripts to jest 2018-08-17 14:11:02 -05:00
.htmllintrc Add attr-bans to .htmllintrc 2018-03-08 11:22:13 -06:00
.npmignore fix #24: add Travis and Coveralls 2018-02-09 07:37:47 -06:00
.stylelintrc footer fixes 2018-06-10 14:16:42 -05:00
.travis.yml upgrade npm on CI so they can audit 2018-08-30 15:21:30 -05:00
Dockerfile for #55: add Dockerfile for dockerflow 2018-05-31 09:55:32 -05:00
LICENSE Add LICENSE file and update package.json license 2018-06-07 14:49:16 -07:00
README.md fix #360: FXA_ENABLED flag and default to false 2018-09-07 15:04:46 -05:00
app-constants.js fix #415: move throttle to env vars and test 2018-09-20 09:50:11 -05:00
basket.js fix #431: fixes for basket API calls 2018-09-20 11:57:29 -05:00
email-utils.js move SERVER_URL into sendEmail for all email templates 2018-09-10 11:12:55 -05:00
hbs-helpers.js hbs-helpers.test.js 2018-09-11 16:33:06 -05:00
hibp.js for #415: 404 can mean "no results" - not error 2018-09-20 15:18:07 -05:00
middleware.js fix #310: reload breaches to find breach; else error 2018-09-06 16:38:42 -05:00
package-lock.json Adds npm scripts for autoprefixing & minifying. 2018-09-20 16:30:08 -05:00
package.json Adds npm scripts for autoprefixing & minifying. 2018-09-20 16:30:08 -05:00
server.js review updates + send SERVER_URL to password tips. 2018-09-10 15:52:48 -05:00
sha1-utils.js Fix a bunch of ESLint errors 2018-04-18 16:39:05 +02:00
tips.js Updates templates with latest copy. 2018-09-18 12:45:40 -05:00
unsubscribe_reasons.js Adds unsubscribe form 2018-08-27 08:44:49 -05:00

README.md

Firefox Monitor Server

Summary

Firefox Monitor notifies users when their credentials have been compromised in a data breach.

This code is for the monitor.firefox.com service & website.

Breach data is powered by haveibeenpwned.com.

See the Have I Been Pwned about page for the "what" and "why" of data breach alerts.

Development

Requirements

Install

  1. Clone and change to the directory:

    git clone https://github.com/mozilla/blurts-server.git
    cd blurts-server
    
  2. Install dependencies:

    npm install
    
  3. Copy the .env-dist file to .env:

    cp .env-dist .env
    

Run

  1. Run the server:

    npm start
    
  2. Navigate to localhost:6060/

Note: In development, you may want to use nodemon to run the server; it will automatically refresh the server.js process when files are changed:

nodemon server.js

Database

To create the database tables ...

  1. Create the blurts database:

    createdb blurts
    
  2. Update the DATABASE_URL value in your .env file with your local db credentials:

    DATABASE_URL="postgres://<username>@localhost:<port>/blurts"
    
  3. Run the migrations:

    npm run db:migrate
    

Emails

The included .env-dist sets DEBUG_DUMMY_SMTP=1 which disables emails.

To send emails, you'll need to unset DEBUG_DUMMY_SMTP and supply real SMTP config values for sending email.

You can set and source these via the .env file, or set them directly:

export DEBUG_DUMMY_SMTP=
export SMTP_HOST=<your-smtp-host>
export SMTP_PORT=<your-smtp-port>
export SMTP_USERNAME=<your-username>
export SMTP_PASSWORD=<your-password>

Firefox Accounts

Subscribe with a Firefox Account is controlled via the FXA_ENABLED environment variable. (See .env-dist)

The repo comes with a development FxA oauth app pre-configured in .env, which should work fine running the app on http://localhost:6060

To use a different Firefox Accounts oauth relying party, you'll need to create an FxA Oauth Client and then set some OAUTH config values.

You can set and source these via the .env file:

OAUTH_CLIENT_ID=<your-fxa-oauth-client-id>
OAUTH_CLIENT_SECRET=<your-fxa-oauth-client-secret>
OAUTH_AUTHORIZATION_URI="https://oauth-stable.dev.lcip.org/v1/authorization"
OAUTH_PROFILE_URI="https://stable.dev.lcip.org/profile/v1/profile"
OAUTH_TOKEN_URI="https://oauth-stable.dev.lcip.org/v1/token"

Testing

The full test suite can be run via npm test.

Individual tests

To run individual tests, use NODE_ENV=tests and jest:

NODE_ENV=tests jest --runInBand tests/home.test.js

To run tests with interactive debugger lines enabled:

NODE_ENV=tests node inspect --harmony ./node_modules/.bin/jest tests/home.test.js

Lint

After installing the dependencies, you can lint the code by calling:

npm run lint

Deployment

Firefox Monitor Breach Alerts is designed with 12-factor methodology.

Deploy on Heroku

You will need to set some required environment variables on Heroku.

heroku config:set COOKIE_SECRET=unsafe-cookie-secret-for-heroku
heroku config:set DEBUG_DUMMY_SMTP=1

And any others, depending on the features you're running on Heroku - e.g., Email or Firefox Accounts.