{"id":21478674,"url":"https://github.com/vwh/vwh-email","last_synced_at":"2025-07-15T11:31:13.898Z","repository":{"id":263622169,"uuid":"880456098","full_name":"vwh/vwh-email","owner":"vwh","description":"Open source temp mail service, anonymous and free","archived":false,"fork":false,"pushed_at":"2025-04-21T20:55:58.000Z","size":1579,"stargazers_count":14,"open_issues_count":0,"forks_count":4,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-21T21:39:27.098Z","etag":null,"topics":["email-api","email-notification","free-email","temp-email","temp-mail","temp-mail-api","temp-mail-website"],"latest_commit_sha":null,"homepage":"https://email.vwh.sh","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vwh.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-10-29T18:55:51.000Z","updated_at":"2025-04-21T20:56:01.000Z","dependencies_parsed_at":"2025-04-22T04:36:14.463Z","dependency_job_id":null,"html_url":"https://github.com/vwh/vwh-email","commit_stats":null,"previous_names":["vwh/vwh-email"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/vwh/vwh-email","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vwh%2Fvwh-email","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vwh%2Fvwh-email/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vwh%2Fvwh-email/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vwh%2Fvwh-email/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vwh","download_url":"https://codeload.github.com/vwh/vwh-email/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vwh%2Fvwh-email/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265431517,"owners_count":23764029,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["email-api","email-notification","free-email","temp-email","temp-mail","temp-mail-api","temp-mail-website"],"created_at":"2024-11-23T11:19:09.278Z","updated_at":"2025-07-15T11:31:13.555Z","avatar_url":"https://github.com/vwh.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\n\u003ca href=\"https://email.vwh.sh\" target=\"_blank\"\u003e\n    \u003cimg src=\"https://github.com/user-attachments/assets/c9f29d05-7652-46f6-baa1-1dd38e7814d1\" alt=\"logo\" width=\"128\"\u003e\n\u003c/a\u003e\n\n# VWH Email\n\nOpen-source temporary email service that provides quick, anonymous email solutions.\n\n[![License](https://img.shields.io/github/license/vwh/vwh-email?label=License)](https://github.com/vwh/sqlite-viewer/blob/main/LICENSE)\n[![Format Check](https://github.com/vwh/vwh-email/actions/workflows/format.yml/badge.svg)](https://github.com/vwh/vwh-email/actions/workflows/format.yml)\n[![Lint](https://github.com/vwh/vwh-email/actions/workflows/lint.yml/badge.svg)](https://github.com/vwh/vwh-email/actions/workflows/lint.yml)\n\n\u003ca href=\"https://email.vwh.sh\" target=\"_blank\"\u003e\n    Website\n\u003c/a\u003e\n•\n\u003ca href=\"https://email.vwh.sh/api\" target=\"_blank\"\u003e\n    API Docs\n\u003c/a\u003e\n\n\u003c/div\u003e\n\n---\n\n## Dockerized Installation (Coming Soon)\n\n**Status: Under Development**\n\n- Complete Docker containerization is in progress\n- Will include Postfix mail server\n- One-click deployment\n- Simplified configuration\n- Expected features:\n  - Pre-configured Postfix\n  - Integrated webhook\n  - Easy environment setup\n\n## Manual Installation\n\n### Prerequisites\n\n- **Domain**: vwh.sh\n- **DNS Provider**: Cloudflare\n- **Server**: Ubuntu VPS\n- **Mail Server Software**: Postfix\n\n---\n\n### Step 1: DNS Configuration (Cloudflare)\n\n1. Log in to your Cloudflare account\n2. Select your domain (vwh.sh)\n\n   **Note**: In all the following steps, replace `vwh.sh` with your domain name.\n\n3. Go to the DNS settings\n4. Add the following records:\n   - MX record:\n     - Name: `@`\n     - Value: `mail.vwh.sh`\n     - Priority: 10\n   - A record:\n     - Name: `mail`\n     - Value: `[Your VPS IP address]`\n   - TXT record (for SPF):\n     - Name: `@`\n     - Value: `v=spf1 mx ~all`\n\n---\n\n### Step 2: VPS Setup\n\n1. SSH into your Ubuntu VPS\n2. Update the system:\n   ```bash\n   sudo apt update \u0026\u0026 sudo apt upgrade -y\n   ```\n3. Set the hostname:\n   ```bash\n   sudo hostnamectl set-hostname mail.vwh.sh\n   ```\n4. Update `/etc/hosts`:\n   ```bash\n   sudo nano /etc/hosts\n   ```\n   Add: `[Your VPS IP] mail.vwh.sh vwh.sh`\n\n---\n\n### Step 3: Install and Configure Postfix\n\n1. Install Postfix:\n   ```bash\n   sudo apt install postfix -y\n   ```\n2. During installation, choose \"Internet Site\" and enter \"vwh.sh\" as the system mail name\n3. Edit the main Postfix configuration:\n   ```bash\n   sudo nano /etc/postfix/main.cf\n   ```\n   Add or modify these lines:\n   ```\n   myhostname = mail.vwh.sh\n   mydestination = $myhostname, vwh.sh, localhost.$mydomain, localhost\n   inet_interfaces = all\n   mynetworks = 127.0.0.0/8 [::ffff:127.0.0.0]/104 [::1]/128\n   smtpd_recipient_restrictions = permit_mynetworks, reject_unauth_destination\n   virtual_alias_domains = vwh.sh\n   virtual_alias_maps = regexp:/etc/postfix/virtual_regexp\n   ```\n4. Create and edit the `virtual_regexp` file:\n   ```bash\n   sudo nano /etc/postfix/virtual_regexp\n   ```\n   Add this line:\n   ```\n   /.+@vwh\\.sh/ catchall@vwh.sh\n   ```\n\n---\n\n5. Restart Postfix:\n   ```bash\n   sudo systemctl restart postfix\n   ```\n\n---\n\n### Step 4: Configure Postfix to Forward Emails to Webhook\n\n1. Install procmail:\n   ```bash\n   sudo apt install procmail -y\n   ```\n2. Create a script to forward emails:\n\n   ```bash\n   sudo nano /usr/local/bin/forward-to-webhook.sh\n   ```\n\n   Add the following content:\n\n   ```bash\n   #!/bin/bash\n   sed '/Content-Disposition: attachment/,/^\\s*$/d; /Content-Disposition: inline/,/^\\s*$/d' | \\\n   curl -X POST -H \"Content-Type: text/plain\" -H \"Secret: 12398\" --data-binary @- http://localhost:9169/webhook\n   ```\n\n   **Note**: Update the `Secret` to match your website/webhook environment variable\n\n   **Note**: It will forward the email to the webhook URL by default (http://localhost:9169/webhook). If you want to forward it to a different URL, you can change the URL in the script.\n\n3. Make the script executable:\n   ```bash\n   sudo chmod +x /usr/local/bin/forward-to-webhook.sh\n   ```\n4. Edit the Postfix aliases file:\n   ```bash\n   sudo nano /etc/aliases\n   ```\n   Add this line:\n   ```\n   catchall: \"|/usr/local/bin/forward-to-webhook.sh\"\n   ```\n5. Update the aliases database:\n   ```bash\n   sudo newaliases\n   ```\n6. Restart Postfix:\n   ```bash\n   sudo systemctl restart postfix\n   ```\n\n---\n\n### Step 5: Install and Configure Website\n\n1. Clone VWH Email repository:\n   ```bash\n   git clone https://github.com/vwh/vwh-email\n   cd vwh-email\n   ```\n2. Install dependencies:\n   ```bash\n   npm install --force\n   ```\n3. Configure environment variables:\n\n   - Add your `SECRET` to the environment configuration\n\n   ```bash\n   SECRET=\"12398\"\n   ```\n\n4. Start development server:\n   ```bash\n   npm run dev\n   ```\n\n---\n\n## Contributing\n\nContributions are welcome! Feel free to open a pull request with your improvements or fixes.\n\n## License\n\nUnder the MIT License. See [License](https://github.com/vwh/vwh-email/blob/main/LICENSE) for more information.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvwh%2Fvwh-email","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvwh%2Fvwh-email","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvwh%2Fvwh-email/lists"}