Bhasher/kill-the-newsletter
Bhasher
/
kill-the-newsletter
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Convert email newsletters into Atom feeds
111 Commits 1 Branch 0 Tags 2 MiB
TypeScript 67.9%
JavaScript 31.6%
Dockerfile 0.5%
Go to file
Leandro Facchinetti d1a30baa52 Better treatment of ports 2020-03-24 11:13:07 -04:00
.github/workflows . 2020-03-21 02:16:34 -04:00
.vscode . 2020-03-20 02:52:49 -04:00
src Better treatment of ports 2020-03-24 11:13:07 -04:00
static . 2020-03-18 00:26:41 -04:00
.gitignore . 2020-03-18 21:49:32 -04:00
CODE_OF_CONDUCT.md . 2020-03-17 21:05:16 -04:00
Caddyfile . 2020-03-21 13:01:08 -04:00
LICENSE . 2020-03-17 21:05:16 -04:00
README.md . 2020-03-23 21:22:30 -04:00
package-lock.json . 2020-03-21 02:07:10 -04:00
package.json Better treatment of ports 2020-03-24 11:13:07 -04:00
tsconfig.json . 2020-03-21 12:01:55 -04:00

README.md

Kill the Newsletter!

Convert email newsletters into Atom feeds

Convert email newsletters into Atom feeds

Source Continuous Integration

Running Locally

Install Node.js and run:

$ npm install
$ npm start

The web server will be running at http://localhost:8000 and the email server at smtp://localhost:2525.

Deployment

  1. Create a deployment SSH key pair:

    $ ssh-keygen

    Private key (id_rsa): Add to GitHub as a Secret called SSH_PRIVATE_KEY.

    Public key (id_rsa.pub): Add to DigitalOcean and to GitHub as a Deploy key for the repository.

  2. Create a DigitalOcean droplet:
    Image Ubuntu 18.04.3 (LTS) x64
    Plan Starter Standard $5/mo
    Additional options Monitoring
    Authentication Deployment SSH Key
    Hostname kill-the-newsletter.com
    Backups Enable

    Firewall
    Name kill-the-newsletter.com
    Inbound Rules ICMP
    SSH 22
    Custom 25 (SMTP)
    HTTP 80
    HTTPS 443

    Floating IP

  3. Configure DNS in Namecheap:

    Type Host Value
    A @ <droplet-ip>
    CNAME www kill-the-newsletter.com
    MX @ kill-the-newsletter.com

  4. Setup the server:

    $ ssh-add
$ npx pm2 deploy package.json production setup

  5. Migrate the existing feeds:

    $ ssh-add
$ ssh -A root@kill-the-newsletter.com
root@kill-the-newsletter.com $ rsync -av <path-to-previous-feeds> /root/www.kill-the-newsletter.com/current/static/feeds/

  6. Push to GitHub, which will trigger the Action that deploys the code and starts the server.