README.md

Vortex

Vortex is a solution to the common problem of email inbox clutter. It provides temporary email addresses for signing up to newsletters, websites, and services that require an email, without compromising your primary email address. A hosted instance is available at https://vortex.skyfall.dev!

Why Vortex?

• Generate disposable email addresses
• Protect your primary email from spam and unwanted newsletters
• Ideal for one-time signups and temporary accounts (looking at you, Quora)

Building

You will need:

• Rust
• Bun
• Node.js (to actually run the project)

Additionally, if you want to run the server, we recommend:

• Docker
• Caddy

Building the SMTP server

Run:

cargo b --release

The server will be located at /target/debug/vortex-server.

Building the frontend

Run:

cd frontend
bun run build

Running Vortex

Ensure you've built everything first.

In development

In one terminal, run:

RUST_LOG=debug cargo run

Ensure you have permissions to bind to port 25.

In another, run:

cd frontend
bun dev

In production

Frontend

Run it anywhere, e.g. Cloudflare Pages. Ensure environment variables are set.

Backend

This assumes that you are using Docker and Caddy.

Firstly, create a new user for Vortex.

Secondly, install rootless Docker. for the Vortex user.

Then this Docker command:

docker run --cap-drop=ALL --cap-add=NET_BIND_SERVICE ghcr.io/skyfallwastaken/vortex.email:latest

And finally, this Caddy reverse proxy command:

caddy reverse-proxy --from <your api domain> --to :3000