compsoc email studio

what?

This service bridges our Sendy instance with an MJML-powered designer, and allows for creation of S3-backed image files with simple asset management. This project also ships with some code for easily building and deploying new CompSoc microservices, through some makefile abuse.

This project is built on:

• MJML
• express
• Passport + Passport Google OAuth 2.0
• EJS
• dotenv
• debug
• SQLite

why?

MJML is nice for writing emails, Sendy is nice for sending emails.

running?

You'll need to create a project on CompSoc's GCP, issue a client ID and secret for a web oauth application, and properly configure the callback urls.

More verbosely:

1. Log into GCP, and create a new project by clicking the project header on the title bar and clicking "New Project." Ideally this should be created under the "comp-soc.com" domain.

2. Once you've created the project, go to the sidebar > APIs & Services > Credentials. You should mark it as an internal service, given the option (Google seems to keep changing this). You'll need to add routes like so:

Here are the authorized javascript origins so you can copy/paste them:

https://your-service.comp-soc.com
http://localhost:3000

And similarly for the authorized redirect URIs:

https://your-service.comp-soc.com/auth/google/callback
http://localhost:3000/auth/google/callback

Once you've done that, you'll need to add the relevant config details to the .env file:

# google-related auth
GOOGLE_CLIENT_ID=GOOGLE_CLIENT_ID
GOOGLE_CLIENT_SECRET=GOOGLE_CLIENT_SECRET
GOOGLE_CALLBACK_URL=GOOGLE_CALLBACK_URL

You'll also need to tweak the session key in the same file to make sure that session cookies are all signed:

# signs session cookies
SESSION_SECRET=please set me

Install all the packages for the project:

$ npm install

Then you should be good to go! Start the server with:

$ node server.js

deploying?

Deploying the application is slightly more involved than just running it, but it's not horrendously complicated either.

First, you'll need to look inside of ./makefile, and tweak the variables at the top to point at your server.

Next, you'll need to edit the ./docker-compose.yml. Similar to before, just make sure everything in there looks right (you will likely need to change the image name).

To actually deploy your application, you will need to first initialize the deployment folder on the remote:

$ make init-deploy

To build and upload the project:

$ make deploy

Finally, you'll need to hook up a reverse proxy webserver. I recommend NGINX, and have provided a default configuration in docs/compsoc-sso.nginx.conf. Copy that to /etc/nginx/sites-available, and then enable the vhost by running:

$ sudo ln -s /etc/nginx/sites-available/compsoc-sso.nginx.conf /etc/nginx/sites-enabled/compsoc-sso.nginx.conf

Obtain a certificate for free (thanks Let's Encrypt!) by running:

$ sudo certbot

make?

That's right, this absolutely abuses make.

Make commands available are:

command	stage	effect
init	dev	install all the required deps
init-db	dev	clear and initialize the database by running schema.sql
run	dev	start the local dev server
watch	dev	live reload the server on file changes
run-docker	dev	runs the project in docker
clean	deploy	clean up the last build if necessary
build	deploy	build the docker image
export	deploy	export the docker image
upload	deploy	upload the image to the server
init-deploy	deploy	prepare the server to receive deployments
deploy	deploy	deploy the project
upload-reg	deploy	upload to the docker registry
deploy-reg	deploy	deploy to the target server through the registry
connect	maintain	connect to the server for convenience

who?

This was written in a fit of procrastination by @pkage. Thanks to @penalosa for the docker help :)