Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/skyfallwastaken/vortex.email
https://github.com/skyfallwastaken/vortex.email
Last synced: 23 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/skyfallwastaken/vortex.email
- Owner: SkyfallWasTaken
- License: other
- Created: 2024-05-21T11:33:54.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-06-21T17:22:10.000Z (5 months ago)
- Last Synced: 2024-06-22T09:51:26.439Z (5 months ago)
- Language: Rust
- Homepage: https://vortex-email.vercel.app
- Size: 226 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# 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 !
## 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:
```bash
cargo b --release
```
The server will be located at `/target/debug/vortex-server`.
### Building the frontend
Run:
```bash
cd frontend
bun run build
```
## Running Vortex
Ensure you've built everything first.
### In development
In one terminal, run:
```bash
RUST_LOG=debug cargo run
```
Ensure you have permissions to bind to port 25.
In another, run:
```bash
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.](https://docs.docker.com/engine/security/rootless) for the Vortex user.
Then this Docker command:
```bash
docker run --cap-drop=ALL --cap-add=NET_BIND_SERVICE ghcr.io/skyfallwastaken/vortex.email:latest
```
And finally, this Caddy reverse proxy command:
```bash
caddy reverse-proxy --from --to :3000
```