Merge pull request #51 from dxw/feature/add-dockerfile-and-docker-com…

…pose

Add `Dockerfile` and `docker-compose.yml` files

.env.example

@@ -1,5 +1,5 @@
 APP_ID=123456
-PRIVATE_KEY_PATH=/path/to/app.private-key.pem
+PRIVATE_KEY= # Use `script/encode-key <path-to-pem-file>` to encode the private key 
 CLIENT_ID=SomeClientId123
 CLIENT_SECRET=secret
 WEBHOOK_SECRET=secret

Dockerfile

@@ -0,0 +1,24 @@
+FROM node:22.8.0-slim
+
+WORKDIR /towtruck
+VOLUME /data
+
+ARG APP_ID
+ARG PRIVATE_KEY
+ARG CLIENT_ID
+ARG CLIENT_SECRET
+ARG WEBHOOK_SECRET
+
+COPY . .
+
+RUN touch .env \
+  && echo "APP_ID=$APP_ID" >> .env \
+  && echo "PRIVATE_KEY=$PRIVATE_KEY" >> .env \
+  && echo "CLIENT_ID=$CLIENT_ID" >> .env \
+  && echo "CLIENT_SECRET=$CLIENT_SECRET" >> .env \
+  && echo "WEBHOOK_SECRET=$WEBHOOK_SECRET" >> .env
+
+RUN npm install
+
+EXPOSE 3000
+CMD [ "sh", "-c", "npm run seed && exec npm run start" ]

README.md

@@ -60,7 +60,9 @@ The environment variables are available here: https://github.com/organizations/d
 
 In order for Towtruck to communicate with the GitHub API, it needs several pieces of information, configured through environment variables:
 - `APP_ID`: The unique numeric ID assigned to the GitHub App. This can be found in the dxw-towtruck app settings.
-- `PRIVATE_KEY_PATH`: The private key used to sign access token requests. Towtruck expects this to be an absolute path to a `.pem` file stored locally and generated by GitHub in the app settings.
+- `PRIVATE_KEY`: The private key used to sign access token requests.
+  Towtruck expects this to be a `.pem` file generated by GitHub in the app settings and encoded using Base64.
+  This can be generated from the `.pem` file by running `script/encode-key <path-to-pem-file>` in the terminal and copying the output.
 - `CLIENT_ID`: A unique alphanumeric ID assigned to the GitHub App. This can be found in the dxw-towtruck app settings
 - `CLIENT_SECRET`: A token used to authenticate API requests. These are generated by GitHub in the dxw-towtruck app settings.
 - `WEBHOOK_SECRET`: A user-defined secret used to authenticate GitHub to Towtruck for receiving webhooks. This must be exactly the same as it is entered in the app settings on GitHub.

docker-compose.yml

@@ -0,0 +1,5 @@
+services:
+  towtruck:
+    build: .
+    ports:
+      - "3000:3000"

heroku.yml

@@ -0,0 +1,3 @@
+build:
+  docker:
+    web: Dockerfile

index.js

@@ -36,7 +36,7 @@ const httpServer = createServer(async (request, response) => {
   return response.end(template);
 });
 
-const PORT = 3000;
+const PORT = process.env.PORT || 3000;
 httpServer.listen(PORT, () => {
   console.info(`Server is running on port ${PORT}`);
 });

octokitApp.js

@@ -1,13 +1,12 @@
-import { readFileSync } from "fs";
 import { App, createNodeMiddleware } from "@octokit/app";
 
 const APP_ID = process.env.APP_ID;
-const PRIVATE_KEY_PATH = process.env.PRIVATE_KEY_PATH;
+const PRIVATE_KEY = process.env.PRIVATE_KEY;
 const CLIENT_ID = process.env.CLIENT_ID;
 const CLIENT_SECRET = process.env.CLIENT_SECRET;
 const WEBHOOK_SECRET = process.env.WEBHOOK_SECRET;
 
-const privateKey = readFileSync(PRIVATE_KEY_PATH).toString();
+const privateKey = Buffer.from(PRIVATE_KEY, 'base64').toString('ascii');
 
 const app = new App({
   appId: APP_ID,

script/encode-key

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+
+cat $1 | openssl base64 | tr -d '\n'
+echo