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)

Install and Run

1. Clone and change to the directory:

   git clone git@github.com:groovecoder/private-relay.git
   cd private-relay
   

2. Create and activate a virtual environment:

   virtualenv env
   source env/bin/activate
   

3. Install requirements:

   pip install -r requirements.txt
   

4. Copy .env file for decouple config:

   cp .env-dist .env
   

5. Add a SECRET_KEY value to .env:

   SECRET_KEY=secret-key-should-be-different-for-every-install
   

6. Migrate DB:

   python manage.py migrate
   

7. Create superuser:

   python manage.my createsuperuser
   

8. 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, 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: example.com -> 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.