[Chore]: Readme Update
BIN
.github/assets/html.png
vendored
|
Before Width: | Height: | Size: 121 KiB After Width: | Height: | Size: 224 KiB |
BIN
.github/assets/inbox.png
vendored
|
Before Width: | Height: | Size: 138 KiB After Width: | Height: | Size: 266 KiB |
BIN
.github/assets/keys.png
vendored
Normal file
|
After Width: | Height: | Size: 257 KiB |
BIN
.github/assets/raw.png
vendored
|
Before Width: | Height: | Size: 172 KiB After Width: | Height: | Size: 265 KiB |
128
README.md
|
|
@ -4,20 +4,27 @@
|
||||||
<img align="center" src="https://i.imgur.com/zPzvSQJ.png" width="100%">
|
<img align="center" src="https://i.imgur.com/zPzvSQJ.png" width="100%">
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
|
<p align="center">
|
||||||
|
<a href="https://48hr.email" target="_blank">Official Instance</a> •
|
||||||
|
<a href="https://48hr.email/inbox/example@48hr.email" target="_blank">Example Inbox</a> •
|
||||||
|
<a href="https://discord.gg/crazyco" target="_blank">Discord</a>
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<br>
|
||||||
|
|
||||||
-----
|
-----
|
||||||
|
|
||||||
### 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!
|
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.
|
All data is being removed 48hrs after they have reached the mail server.
|
||||||
|
|
||||||
<p align="center"><a href="https://48hr.email" target="_blank">Try now</a> | <a href="https://48hr.email/inbox/example@48hr.email" target="_blank">Example Inbox</a> | <a href="https://discord.gg/crazyco" target="_blank">Discord</a></p>
|
<br>
|
||||||
<br><br>
|
|
||||||
|
|
||||||
-----
|
-----
|
||||||
|
|
||||||
### What are its features?
|
## Features
|
||||||
|
|
||||||
- Create a custom inbox with select name and domain, or get a fully randomized one
|
- 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
|
- 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
|
- Delete your emails ahead of time by pressing the delete button
|
||||||
- View the raw email, showing all the headers etc.
|
- View the raw email, showing all the headers etc.
|
||||||
- Download Attachments
|
- Download Attachments
|
||||||
|
- Automatic detection and display of cryptographic keys and signatures
|
||||||
|
- Password-protected inboxes
|
||||||
|
- Dark mode
|
||||||
- and more...
|
- and more...
|
||||||
|
|
||||||
<br><br>
|
<br>
|
||||||
|
|
||||||
-----
|
-----
|
||||||
|
|
||||||
### How does this work?
|
## Screenshots
|
||||||
|
|
||||||
|
| Inbox | Email using HTML and CSS |
|
||||||
|
|:---:|:---:|
|
||||||
|
| <img src=".github/assets/inbox.png" width="100%" style="min-width: 300px"> | <img src=".github/assets/html.png" width="100%" style="min-width: 300px"> |
|
||||||
|
|
||||||
|
| Email without CSS | Dropdown for cryptographic Keys and Signatures |
|
||||||
|
|:---:|:---:|
|
||||||
|
| <img src=".github/assets/raw.png" width="100%" style="min-width: 300px"> | <img src=".github/assets/keys.png" width="100%" style="min-width: 300px"> |
|
||||||
|
|
||||||
|
<br>
|
||||||
|
|
||||||
|
-----
|
||||||
|
|
||||||
|
## 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.
|
48hr.email uses an existing IMAP server for its handling. A single catch-all account and the accompanying credentials handle all the emails.
|
||||||
|
|
||||||
<br><br>
|
<br>
|
||||||
|
|
||||||
-----
|
-----
|
||||||
|
|
||||||
### How can I set this up myself?
|
## How can I set this up myself?
|
||||||
|
|
||||||
- Prerequisites:
|
**Prerequisites:**
|
||||||
- Mail server with IMAP
|
- Mail server with IMAP
|
||||||
- One or multiple domains dedicated to this
|
- One or multiple domains dedicated to this
|
||||||
- git & nodejs
|
- git & nodejs
|
||||||
|
|
||||||
<br>
|
<br>
|
||||||
|
|
||||||
<details>
|
<details>
|
||||||
<summary>Option 1 - bare-metal install:</summary>
|
<summary>Option 1 - bare-metal install</summary>
|
||||||
|
|
||||||
- #### Setup:
|
#### 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:
|
|
||||||
```bash
|
```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]
|
[Unit]
|
||||||
Description=48hr-email
|
Description=48hr-email
|
||||||
After=network-online.target
|
After=network-online.target
|
||||||
|
|
@ -83,48 +113,40 @@ WantedBy=multi-user.target
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
<details>
|
<details>
|
||||||
<summary>Option 2 - Docker:</summary>
|
<summary>Option 2 - Docker</summary>
|
||||||
|
|
||||||
- #### Setup:
|
#### Setup:
|
||||||
- `git clone https://github.com/Crazyco-xyz/48hr.email.git`
|
```bash
|
||||||
- `cd 48hr.email`
|
git clone https://github.com/Crazyco-xyz/48hr.email.git
|
||||||
- Change all settings to the desired values:
|
cd 48hr.email
|
||||||
- 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)
|
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)
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
<br><br>
|
<br>
|
||||||
|
|
||||||
-----
|
-----
|
||||||
### TODO (PRs welcome):
|
|
||||||
|
## TODO (PRs welcome)
|
||||||
|
|
||||||
- Add user registration:
|
- Add user registration:
|
||||||
- Optional "premium" domains that arent visible to the public to prevent them from being scraped and flagged
|
- Allow people to forward single emails, or an inbox in its current state
|
||||||
- Allow people to set up forwarding
|
|
||||||
|
|
||||||
#### Unsure:
|
<br>
|
||||||
- Possible payment integration once registration exists, to lock one or more of these new features behind a paywall (configurable, ofc)
|
|
||||||
|
|
||||||
<br><br>
|
|
||||||
|
|
||||||
-----
|
-----
|
||||||
|
|
||||||
### Screenshots:
|
## Support me
|
||||||
|
|
||||||
- #### Inbox:
|
If you find this project useful, consider supporting its development!
|
||||||
<img align="center" src=".github/assets/inbox.png">
|
|
||||||
|
|
||||||
- #### Email using HTML and CSS:
|
|
||||||
<img align="center" src=".github/assets/html.png">
|
|
||||||
|
|
||||||
- #### Email without CSS:
|
|
||||||
<img align="center" src=".github/assets/raw.png">
|
|
||||||
|
|
||||||
<br><br>
|
|
||||||
|
|
||||||
-----
|
|
||||||
|
|
||||||
## ❤️ Support me
|
|
||||||
|
|
||||||
<!--
|
<!--
|
||||||
Pwease support me >.<
|
Pwease support me >.<
|
||||||
|
|
|
||||||