Skip to content

Commit

Permalink
refactor: Changed name from helium (Atomic Emails) to MorphMails
Browse files Browse the repository at this point in the history
  • Loading branch information
kyee-rs committed Jul 30, 2023
1 parent 0a95458 commit d9e839c
Show file tree
Hide file tree
Showing 10 changed files with 63 additions and 65 deletions.
2 changes: 1 addition & 1 deletion .env.example
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
SECRET_KEY=very_secreted_secret
DATABASE_URL=postgres://user:password@localhost:5432/atomic
DATABASE_URL=postgres://user:password@localhost:5432/morph
DOMAIN=decline.live# Domain connected to Mailgun Servers. (No validation is performed at this stage of development, fill carefuly)
4 changes: 2 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
build
dist/

helium.exe
helium
morph_mails.exe
morph_mails
14 changes: 7 additions & 7 deletions .goreleaser.yaml
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# yaml-language-server: $schema=https://goreleaser.com/static/schema.json
# vim: set ts=2 sw=2 tw=0 fo=cnqoj

project_name: helium
project_name: morph_mails
before:
hooks:
- go mod tidy
builds:
- env:
- CGO_ENABLED=0
main: ./internal
binary: helium
binary: morph_mails
goos:
- windows
- darwin
Expand Down Expand Up @@ -65,13 +65,13 @@ changelog:

dockers:
- image_templates:
- "ghcr.io/atomicemails/app:latest"
- "ghcr.io/atomicemails/app:{{ .Tag }}-amd64"
- "ghcr.io/morph-ua/mails:latest"
- "ghcr.io/morph-ua/mails:{{ .Tag }}-amd64"
dockerfile: Dockerfile
use: buildx
build_flag_templates:
- "--pull"
- "--label=io.artifacthub.package.readme-url=https://raw.githubusercontent.com/AtomicEmails/AtomicEmails/main/README.md"
- "--label=io.artifacthub.package.readme-url=https://raw.githubusercontent.com/morph-ua/MorphMails/main/README.md"
- '--label=io.artifacthub.package.maintainers=[{"name":"Saputskyi Petro","email":"hello@lowt.live"}]'
- "--label=io.artifacthub.package.license=MIT"
- "--label=org.opencontainers.image.description=Temporary email wherever you need it."
Expand All @@ -82,12 +82,12 @@ dockers:
- "--label=org.opencontainers.image.source={{.GitURL}}"
- "--platform=linux/amd64"
- image_templates:
- "ghcr.io/atomicemails/app:{{ .Tag }}-arm64"
- "ghcr.io/morph-ua/mails:{{ .Tag }}-arm64"
dockerfile: Dockerfile
use: buildx
build_flag_templates:
- "--pull"
- "--label=io.artifacthub.package.readme-url=https://raw.githubusercontent.com/AtomicEmails/AtomicEmails/main/README.md"
- "--label=io.artifacthub.package.readme-url=https://raw.githubusercontent.com/morph-ua/MorphMails/main/README.md"
- '--label=io.artifacthub.package.maintainers=[{"name":"Saputskyi Petro","email":"hello@lowt.live"}]'
- "--label=io.artifacthub.package.license=MIT"
- "--label=org.opencontainers.image.description=Temporary email wherever you need it."
Expand Down
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
FROM scratch
COPY helium /bin/server
COPY morph_mails /bin/server
ENTRYPOINT ["server"]
46 changes: 20 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,20 @@
<p align="center">
<a href="https://www.decline.live/" rel="noopener" target="_blank"><img width="300" src="/docs/public/logo.svg" alt="Atomic Emails Logo"></a>
<a href="https://www.decline.live/" rel="noopener" target="_blank"><img width="300" src="/docs/public/logo.svg" alt="Morph Mails Logo"></a>
</p>

<hr/>

**Atomic Emails** is an open-source temporary email service that relies on [**Mailgun**](https://mailgun.com) and can integrate with _**any possible client**_.

- [_Atomic Emails Core_](https://github.com/AtomicEmails/AtomicEmails/) is a service itself which contains **Parser**, **Uploader**, and synchronizes all connected clients.

- [_AtomicEmails/telegram_](https://github.com/AtomicEmails/telegram/) is the first available client which I develop by myself written on [**Deno**](https://deno.land).
**Morph Mails** (*Formerly `Helium`*) is an open-source service that relies on [**Mailgun**](https://mailgun.com) and can integrate with _**any possible client**_. It creates an unlimited amount of random addresses, receives, parses, and sends a minified version of the letter to the user's chat.

<div align="center">

**[`v2.0.2-co2`](https://github.com/AtomicEmails/AtomicEmails/releases/latest/)**
**[`v2.0.2-co2`](https://github.com/morph-ua/MorphMails/releases/latest/)**

[![Latest Tag](https://ghcr-badge.egpl.dev/AtomicEmails/app/latest_tag?color=red&label=latest)](https://ghcr.io/AtomicEmails/app "Latest Tag")
[![Image Size](https://ghcr-badge.egpl.dev/AtomicEmails/app/size)](https://ghcr.io/AtomicEmails/app "Image Size")
![license](https://img.shields.io/github/license/AtomicEmails/AtomicEmails)
[![Average time to resolve an issue](https://isitmaintained.com/badge/resolution/AtomicEmails/AtomicEmails.svg)](https://isitmaintained.com/project/AtomicEmails/AtomicEmails 'Average time to resolve an issue')
[![Percentage of issues still open](http://isitmaintained.com/badge/open/AtomicEmails/AtomicEmails.svg)](http://isitmaintained.com/project/AtomicEmails/AtomicEmails "Percentage of issues still open")
[![Latest Tag](https://ghcr-badge.egpl.dev/morph-ua/app/latest_tag?color=red&label=latest)](https://ghcr.io/MorphMails/app "Latest Tag")
[![Image Size](https://ghcr-badge.egpl.dev/morph-ua/app/size)](https://ghcr.io/morph-ua/app "Image Size")
![license](https://img.shields.io/github/license/morph-ua/MorphMails)
[![Average time to resolve an issue](https://isitmaintained.com/badge/resolution/morph-ua/MorphMails.svg)](https://isitmaintained.com/project/morph-ua/MorphMails 'Average time to resolve an issue')
[![Percentage of issues still open](http://isitmaintained.com/badge/open/morph-ua/MorphMails.svg)](http://isitmaintained.com/project/morph-ua/MorphMails "Percentage of issues still open")

</div>

Expand All @@ -39,28 +35,28 @@
docker run \
-e DATABASE_URL=<your_db_dsn> \
-e SECRET_KEY=<secret> \
-p 8080:8080 -d ghcr.io/atomicemails/app:v2.0.1-h2o-amd64
-p 8080:8080 -d ghcr.io/morph-ua/mails:v2.0.2-co2-amd64
```
> 📝 **Note**: You can generate the secret using this shell command:
> ```shell
> openssl rand -hex 16
> ```
* Next steps from [**Network Setup**](#network-setup) section.
* Next steps from the [**Network Setup**](#network-setup) section

#### Using Pre-built Binaries

* Install the [**latest version**](https://github.com/AtomicEmails/AtomicEmails/releases/latest) of Atomic Emails binary for your OS and Architecture
* Unpack the tarball
* Install the [**latest version**](https://github.com/morph-ua/MorphMails/releases/latest) of MorphMails for your OS and architecture.
* Unpack the tarball.
* Open your Linux **Terminal** and run the following command:
```shell
DATABASE_URL=<your_db_dns> SECRET_KEY=<secret> ./helium
DATABASE_URL=<your_db_dns> SECRET_KEY=<secret> ./morph_mails
```
* Next steps from [**Network Setup**](#network-setup) section.
* Next steps from the [**Network Setup**](#network-setup) section


### Network Setup

Here is the configuration guide for [Mailgun](https://mailgun.com) and your [VPS/VDS](https://hetzner.com) server.
Here is the configuration guide for [Mailgun](https://mailgun.com) and your [VPS or VDS](https://hetzner.com) server.

- Login to your [Mailgun](https://mailgun.com) account and add your custom domain.
Follow the instructions on the [Mailgun](https://mailgun.com) website to connect and verify your domain.
Expand All @@ -73,7 +69,7 @@ Here is the configuration guide for [Mailgun](https://mailgun.com) and your [VPS
```

- Host a client for your desired platform. You can find a list of clients
[here](https://github.com/AtomicEmails/clients).
[here](https://github.com/morph-ua/MailClients).

## Contributing

Expand All @@ -83,19 +79,17 @@ and how to build and test your changes.

## Changelog

The [changelog](https://github.com/AtomicEmails/AtomicEmails/releases) is regularly updated
The [changelog](https://github.com/morph-ua/MorphMails/releases) is regularly updated
to reflect what's changed in each new release.

## Roadmap

Future plans and high-priority features and enhancements can be found in our [roadmap](https://github.com/orgs/AtomicEmails/projects/1).
Future plans and high-priority features and enhancements can be found in our [roadmap](https://github.com/orgs/morph-ua/projects/1).

## License

This project is licensed under the terms of the
[CC0-1.0](/LICENSE.md).
This project is licensed under the terms of [CC0-1.0](/LICENSE.md).

## Security

For details of supported versions and contact details for reporting security issues,
please refer to the [security policy](https://github.com/AtomicEmails/AtomicEmails/security/policy).
For details on supported versions and contact details for reporting security issues, please refer to the [security policy](https://github.com/morph-ua/MorphMails/security/policy).
Loading

0 comments on commit d9e839c

Please sign in to comment.