diff --git a/.github/assets/html.png b/.github/assets/html.png index 8510778..c55c823 100644 Binary files a/.github/assets/html.png and b/.github/assets/html.png differ diff --git a/.github/assets/inbox.png b/.github/assets/inbox.png index 05ed592..22ea607 100644 Binary files a/.github/assets/inbox.png and b/.github/assets/inbox.png differ diff --git a/.github/assets/keys.png b/.github/assets/keys.png new file mode 100644 index 0000000..5775bb4 Binary files /dev/null and b/.github/assets/keys.png differ diff --git a/.github/assets/raw.png b/.github/assets/raw.png index 656ea74..d7577f9 100644 Binary files a/.github/assets/raw.png and b/.github/assets/raw.png differ diff --git a/README.md b/README.md index dba457d..3b236c8 100644 --- a/README.md +++ b/README.md @@ -4,20 +4,27 @@

+

+ Official Instance • + Example Inbox • + Discord +

+ +
+ ----- -### What is this? +## What is this? 48hr.email is my very own tempmail service. You can create emails on the fly with one click, not needing to worry about corporations do with your email. They can sell that one all they want! All data is being removed 48hrs after they have reached the mail server. -

Try now | Example Inbox | Discord

-

+
----- -### What are its features? +## Features - Create a custom inbox with select name and domain, or get a fully randomized one - Receive emails with a clean preview in your inbox, with optional browser notifications @@ -25,42 +32,65 @@ All data is being removed 48hrs after they have reached the mail server. - Delete your emails ahead of time by pressing the delete button - View the raw email, showing all the headers etc. - Download Attachments +- Automatic detection and display of cryptographic keys and signatures +- Password-protected inboxes +- Dark mode - and more... -

+
----- -### How does this work? +## Screenshots + +| Inbox | Email using HTML and CSS | +|:---:|:---:| +| | | + +| Email without CSS | Dropdown for cryptographic Keys and Signatures | +|:---:|:---:| +| | | + +
+ +----- + +## How does this work? 48hr.email uses an existing IMAP server for its handling. A single catch-all account and the accompanying credentials handle all the emails. -

+
----- -### How can I set this up myself? +## How can I set this up myself? -- Prerequisites: - - Mail server with IMAP - - One or multiple domains dedicated to this - - git & nodejs +**Prerequisites:** +- Mail server with IMAP +- One or multiple domains dedicated to this +- git & nodejs
-Option 1 - bare-metal install: +Option 1 - bare-metal install -- #### Setup: - - `git clone https://github.com/Crazyco-xyz/48hr.email.git` - - `cd 48hr.email` - - `npm i` - - Change all settings to the desired values: - - Either use environmental variables, or modify `.env` (see `.env.example`) - - `npm run start` - -- #### Service file example: +#### Setup: ```bash +git clone https://github.com/Crazyco-xyz/48hr.email.git +cd 48hr.email +npm i +``` + +Change all settings to the desired values: +- Either use environmental variables, or modify `.env` (see `.env.example`) + +```bash +npm run start +``` + +#### Service file example: +```ini [Unit] Description=48hr-email After=network-online.target @@ -83,48 +113,40 @@ WantedBy=multi-user.target
-Option 2 - Docker: +Option 2 - Docker -- #### Setup: - - `git clone https://github.com/Crazyco-xyz/48hr.email.git` - - `cd 48hr.email` - - Change all settings to the desired values: - - Either use environmental variables, or modify `.env`, see `.env.example` - - `docker compose up -d` - - If desired, you can also move the config file somewhere else (change volume mount accordingly) +#### Setup: +```bash +git clone https://github.com/Crazyco-xyz/48hr.email.git +cd 48hr.email +``` + +Change all settings to the desired values: +- Either use environmental variables, or modify `.env`, see `.env.example` + +```bash +docker compose up -d +``` + +If desired, you can also move the config file somewhere else (change volume mount accordingly)
-

+
----- -### TODO (PRs welcome): + +## TODO (PRs welcome) + - Add user registration: - - Optional "premium" domains that arent visible to the public to prevent them from being scraped and flagged - - Allow people to set up forwarding + - Allow people to forward single emails, or an inbox in its current state -#### Unsure: -- Possible payment integration once registration exists, to lock one or more of these new features behind a paywall (configurable, ofc) - -

+
----- -### Screenshots: +## Support me -- #### Inbox: - - -- #### Email using HTML and CSS: - - -- #### Email without CSS: - - -

- ------ - -## ❤️ Support me +If you find this project useful, consider supporting its development!