Private Relay
Private Relay provides generated email addresses to use in place of personal email addresses.
Recipients will still receive emails, but Private Relay keeps their personal email address from being harvested, and then bought, sold, traded, or combined with other data to personally identify, track, and/or target them.
Development
Requirements
- python 3.7 (suggest using virtualenv)
- SocketLabs Server
Install and Run the Site Locally
-
Clone and change to the directory:
git clone git@github.com:mozilla/fx-private-relay.git cd fx-private-relay
-
Create and activate a virtual environment:
virtualenv env source env/bin/activate
-
Install requirements:
pip install -r requirements.txt
-
Copy
.env
file fordecouple
config:cp .env-dist .env
-
Add a
SECRET_KEY
value to.env
:SECRET_KEY=secret-key-should-be-different-for-every-install
-
Migrate DB:
python manage.py migrate
-
Create superuser:
python manage.py createsuperuser
-
Run it:
python manage.py runserver
Next you'll need to enable Firefox Accounts auth ...
Enable Firefox Accounts Auth
To enable Firefox Accounts authentication on your local server, you can use the "private-relay (local)" OAuth app on oauth-stable.dev.lcip.org.
To do so:
-
Set
ADMIN_ENABLED=True
in your.env
file -
Change
example.com
to127.0.0.1:8000
and click Save. -
Go to the django-allauth social app admin page, sign in with the superuser account you created above, and add a social app for Firefox Accounts:
- Provider: Firefox Accounts
- Name: oauth-stable.dev.lcip.org
- Client id: 7477974d5019bdaf
- Secret key: ping groovecoder for this
- Sites: 127.0.0.1:8000 -> Chosen sites
Now you can sign into http://127.0.0.1:8000/ with an FxA. Remember: you'll need to use an account on oauth-stable.dev.lcip.org, not the production accounts.firefox.com.
Enable SocketLabs Inbound API
If you want to enable SocketLabs Inbound API to deliver email messages to your local server, you will need a domain where you can set MX records, and something like ngrok to forward public URLs to your local server.
-
In your DNS, add an MX record
- Priority: 10
- Value: mx.socketlabs.com
-
In your SocketLabs account, add a new server. ("Free" includes 500 messages per month.)
-
Under "Injection API", copy the Injection API Key into your
SOCKETLABS_API_KEY
env var -
Under "For Developers", choose "Inbound API", and enable Inbound Parsing.
-
Copy the Secret Key into your
SOCKETLABS_SECRET_KEY
env var -
Copy the Validation Key into your
SOCKETLABS_VALIDATION_KEY
env var -
Restart your
runserver
process -
With your server running on
127.0.0.1:8000
, usengrok
to forward a public domain to it:- ngrok http 127.0.0.1:8000
- You should see output like
Forwarding https://bec216e2.ngrok.io -> http://127.0.0.1:8000
- You should see output like
- ngrok http 127.0.0.1:8000
-
On the Inbound API screen, set the Endpoint URL to your ngrok domain, followed by
/emails/inbound
(e.g., https://bec216e2.ngrok.io/emails/inbound), and click "Validate".- It should say "Your Endpoint URL is valid"
-
At the "Add Address/Domains" prompt, enter your domain where you set the MX records.
- @domain should show up under "Current Entries"
-
Click "Update"
-
Test sending an email to test@domain
- You should see SocketLabs send the request to your local
runserver
process thru your public ngrok URL.
- You should see SocketLabs send the request to your local
Install and run the add-on locally
The add-on adds Firefox UI to generate and auto-fill email addresses. You may
want to build the add-on so that it communicates with your 127.0.0.1:8000
server instead of the production relay.firefox.com
server:
-
In the
extension/
directory, runnpm install
and thennpm run build
-
Use
about:debugging
to install the resultingstatic/downloads/addon/latest/private_relay.zip
file.- Note: A link to the
.zip
is also available at http://127.0.0.1:8000/accounts/profile/
- Note: A link to the
Production Environments
Requirements
In addition to the requirements for dev, production environments should use:
- PostgreSQL-compatible DB
Environment Variables
Production environments should also set some additional environment variables:
DATABASE_URL=postgresql://<username>:<password>@<host>:<port>/<database>
DJANGO_SECURE_HSTS_SECONDS=15768000
DJANGO_SECURE_SSL_REDIRECT=True