Skip to content
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.
Branch: master
Clone or download
Björn I and mozilla-pontoon Pontoon: Update Norwegian Nynorsk (nn-NO) localization of Firefox Mon…
…itor Website

Localization authors:
- Björn I. <bjorni.svindseth@yahoo.com>
Latest commit 662e451 Mar 16, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci remove linting from circle; handled by travis Aug 30, 2018
controllers
db
docs
lib review changes for #738 Feb 15, 2019
loadtests
locales
public Fix ID dupes Mar 13, 2019
routes Merge branch 'master' into streamlined-scan-results Feb 14, 2019
scripts
tests
views Merge pull request #841 from mozilla/update-twitter-card Mar 15, 2019
.dockerignore
.env-dist
.eslintignore Credit sources and eslintignore polyfills Sep 25, 2018
.eslintrc.js
.gitignore for #172: make npm and Docker use minifcation Sep 21, 2018
.htmllintrc Add attr-bans to .htmllintrc Mar 12, 2018
.npmignore
.stylelintrc footer fixes Jun 10, 2018
.travis.yml separate lint job for fasterness Feb 5, 2019
Dockerfile
LICENSE Add LICENSE file and update package.json license Jun 7, 2018
README.md
app-constants.js use FXA_SETTINGS_URL for manage fxa link Mar 12, 2019
basket.js
email-utils.js Review updates Jan 15, 2019
hbs-helpers.js
hibp.js Megalaccountasaurus Jan 24, 2019
l10n.toml
locale-utils.js
log.js for #55: MOZLOG_FMT for formatting Sep 21, 2018
middleware.js
modified-strings.js Fixes #741 (Missing word in string). Feb 7, 2019
package-lock.json
package.json
scan-results.js Review updates / Resolve conflicts Feb 14, 2019
server.js
sha1-utils.js Remove .toUpperCase() from sha1() Feb 14, 2019

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

Note: npm start uses onchange and nodemon to automatically detect file changes, re-compile static assets, and restart the express process. If you want more control, see the scripts section of package.json for more commands.

  1. Navigate to localhost:6060/

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.

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.