Skip to content

Shroud-email/shroud.email

Repository files navigation

CI codecov

Shroud.email is an email privacy service. Protect your email address from spammers and creepy marketers by creating unlimited aliases that remove trackers and forward messages to your regular inbox.

This repo contains our source code. If you just want to set up your email aliases, sign up for our free 30-day trial.

Contributing

Shroud is built with Elixir and Phoenix. Make sure you have Elixir and mix installed.

To start the server:

  • Install dependencies with mix deps.get
  • Create and migrate your database with mix ecto.setup
  • Create seed data (if you want) using mix ecto.seed
  • Start Phoenix endpoint with mix phx.server or inside IEx with iex -S mix phx.server

Now you can visit localhost:4000 from your browser.

To send test emails, use e.g. Swaks:

swaks --to test@example.com --server 127.0.0.1 --port 2525

Libraries

Deploying

Set the environment variables in example.env.