Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fterh/heimdall
Self-hosted personal email guardian with one-step deployment
https://github.com/fterh/heimdall
email hacktoberfest serverless
Last synced: about 7 hours ago
JSON representation
Self-hosted personal email guardian with one-step deployment
- Host: GitHub
- URL: https://github.com/fterh/heimdall
- Owner: fterh
- License: mit
- Created: 2020-01-16T08:02:35.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-08T17:31:11.000Z (almost 2 years ago)
- Last Synced: 2024-11-06T11:52:11.324Z (7 days ago)
- Topics: email, hacktoberfest, serverless
- Language: TypeScript
- Homepage:
- Size: 671 KB
- Stars: 521
- Watchers: 12
- Forks: 24
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# heimdall
[](https://app.travis-ci.com/github/fterh/heimdall)
[](https://codeclimate.com/github/fterh/heimdall/maintainability)
[](https://codeclimate.com/github/fterh/heimdall/test_coverage)
Heimdall is a self-hosted email alias/forwarding service.
I built this as a privacy tool to fight spam and also better manage access to my personal email address.
As a self-hosted and self-managed service, you have complete control over your data.
With 3rd party email forwarding services, you are forced to trust a company with your emails.
This has also been a really fun project for me to learn more about AWS and the Serverless framework.
Check out: [How I built Heimdall, an open-source personal email guardian.](https://medium.com/@fabianterh/how-i-built-heimdall-an-open-source-personal-email-guardian-68e306d172d1)
Changelog can be found under Releases.
## Motivations
1. With Heimdall, you completely own and manage your data and the service. No feature limitations or having to trust a third-party company with your data.
2. Heimdall is meant for individual users to deploy and use and contains user-friendly setup instructions.
3. Heimdall is easy to run - it utilizes the idea of serverless computing, so there is zero server configuration or provisioning.
4. Heimdall is easy to deploy - it uses the Serverless framework (not to be confused with small-letter serverless in Point 3 above) so you can deploy with a single command.
## Features
### Overview
1. **Receive safely:** Receive emails on single-use aliases and forward them to your personal inbox.
2. **Reply anonymously:** Reply to emails from your alias without revealing your personal email address.
3. **Attachments:** Attachments are supported on incoming and outgoing emails (subject to size limits - see below).
4. **Email commands:** Manage your aliases through email directly - no separate app or website required.
5. **Usage stats:** Easily check the usage stats of each alias.
### Receiving emails
Heimdall operates as a whitelisting (default-deny) service.
All incoming emails to your domain are rejected by default unless they are to valid aliases.
Emails received on valid aliases will be forwarded to your personal email address.
Forwarded emails will preserve metadata information, such as any other recipients in the "to" or "CC" headers.
### Replying
To reply, simply reply normally to the received email.
Other recipients in the original email will not receive your reply.
You may include other recipients in the "to" and "CC" list,
either by manually inserting them, or using "reply-all".
**Note:** If you do that, you will disclose your email address to them.
However, the original sender will still not be able to see your email address, provided you are replying to the original sender through the alias.
The original sender will also not be able to see the other recipients.
### Attachments
Attachments are supported, although size limits apply to the entire email message.
This is a hard limitation imposed by AWS and cannot be circumvented.
See Limitations below.
### Commands
To interact with the service, send a single email to one of the following email addresses.
#### Generate an alias
Email `[email protected]` with the description as the subject. You will receive the generated alias as a reply.
The description lets you identify an alias and its use. E.g. "Sign up for Service X".
#### List aliases
Email `[email protected]`. You will receive a list of all aliases as a reply.
Dev note: This reads up to a maximum of 1MB of data (due to AWS's limitations).
#### Remove an alias
Email `[email protected]` with the alias as the title (case-sensitive). You will receive the operation outcome (success/failure) as a reply.
#### Usage stats
Email `[email protected]` with the alias as the title (case-sensitive).
You will receive usage information for the particular alias.
Supported usage stats:
- Alias creation date
- Emails received
- Emails sent
- Date of last received email
- Date of last sent email
#### Update an alias
Coming soon - not supported yet.
### Known Limitations
Received emails must be <30MB. Outgoing emails must be <10MB.
## Setup
**Pre-requisites:** You need to own a domain and have an AWS account.
For reasonable use cases, you should not exceed AWS's free tier (which is very generous).
You should also already have Yarn and NodeJS installed.
**Optional:** To be able to reply to emails, you need to request AWS Support to [un-sandbox your SES account](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/request-production-access.html).
1. Add and verify your domain in AWS Simple Email Service (SES).
2. In AWS's SES console, generate a set of SMTP credentials.
Take note of that, and also your connection information on SES's "SMTP Settings" page.
3. Populate required environment variables in `.env.sample`, and rename to `.env`.
It is important that `EMAIL` matches your personal email exactly.
Also note that you should avoid port 25, due to [AWS's default blocking of outbound traffic](https://aws.amazon.com/premiumsupport/knowledge-center/ec2-port-25-throttle/).
4. Run `yarn global add serverless`. Then, check out [Serverless's guide](https://www.serverless.com/framework/docs/providers/aws/guide/credentials) to set up Serverless's credentials for accessing your AWS account programmatically.
5. Run `yarn install`.
6. [Set up Serverless](https://www.serverless.com/framework/docs/providers/aws/guide/credentials), then run `yarn run deploy-prod`.
7. Add a receipt rule in SES to trigger your S3 bucket (created in step 6).
For "recipients", enter your domain name (e.g. `yourverifieddomain.com`).
Preferably, name your rule descriptively (e.g. `prod`).
### Development (optional)
If you want to build new features or tweak existing features, you can set up a parallel development environment that runs alongside production (above).
1. Ensure that the `DEV_SUBDOMAIN` environment variable is set in `.env` (e.g. `test`).
2. Run `yarn run deploy-dev`.
This creates a parallel development CloudFormation stack.
3. Add a new receipt rule in SES **before your production rule** to trigger your development S3 bucket.
For "recipients", enter the same test subdomain as you set in step 1 (e.g. `test.yourverifieddomain.com`).
Preferably, name your rule descriptively (e.g. `dev`).
Note: You need to update your DNS records for `test.yourverifieddomain.com` as you did when verifying your domain for AWS SES.
## Migration
To run migration scripts, first compile using `tsc scripts/migrate_vX.ts`, then run using `node scripts/migrate_vX.js`.