Dockerize (#246)

.env.sample

@@ -0,0 +1,32 @@
+# temporary stuff, this will be handled in the db eventually
+TEMP_GUILD_ID=
+TEMP_CHANNEL_AUTOMATION_CHANNEL_ID=
+TEMP_LOGGING_CHANNEL_ID=
+TEMP_JOINING_CHANNEL_ID=
+TEMP_LEAVING_CHANNEL_ID=
+TEMP_DELETION_LOGGING_CHANNEL_ID=
+
+# Mongo database information
+MONGODB_CONNECTION_URI=mongodb://localhost
+MONGODB_DATABASE=test
+
+# Discord bot options
+DISCORD_TOKEN=discord bot token goes here
+DISCORD_PREFIX=.
+DISCORD_CLIENT_ID=discord app client ID goes here
+DISCORD_CLIENT_SECRET=discord app client secret goes here
+DISCORD_REDIRECT_URI=discord redirect URI goes here
+
+# Reddit API authorization info
+REDDIT_CLIENT_ID=reddit app client ID goes here
+REDDIT_CLIENT_SECRET=reddit app client secret goes here
+REDDIT_USER_AGENT=put in a user agent that includes your /u/
+REDDIT_REDIRECT_URI=reddit redirect URI goes here
+
+# Web server config
+PORT=4567
+HOST=http://localhost:4567
+SESSION_SECRET=something sufficiently secret
+
+# Third party APIs for command functionality
+FREECURRENCYAPI_KEY=

.github/workflows/build-docker.yml

@@ -0,0 +1,44 @@
+name: Build and publish Docker image
+
+on:
+  push:
+    branches: ['main']
+
+env:
+  REGISTRY: ghcr.io
+  IMAGE_NAME: ${{ github.repository }}
+
+jobs:
+  build-and-push-image:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Log in to the Container registry
+        uses: docker/login-action@v2
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta
+        uses: docker/metadata-action@v4
+        with:
+          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+
+      - name: Build and push Docker image
+        uses: docker/build-push-action@v4
+        with:
+          context: .
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          build-args: |
+            GIT_COMMIT_HASH=${{ github.sha }}
+            GIT_REPO_URL=${{ github.repostitoryUrl }}

.gitignore

@@ -3,6 +3,7 @@ node_modules
 
 # Secrets
 config.*
+.env
 
 # Migration tracking
 .migrate

Dockerfile

@@ -0,0 +1,20 @@
+# https://nodejs.org/en/docs/guides/nodejs-docker-webapp
+FROM node:18-alpine
+WORKDIR /usr/src/app
+
+# copy package.json/package-lock.json and install dependencies
+COPY package*.json ./
+RUN npm ci --omit=dev
+
+# copy everything else
+COPY . .
+
+# pull in git references from build args
+ARG GIT_COMMIT_HASH
+ENV GIT_COMMIT_HASH=$GIT_COMMIT_HASH
+ARG GIT_REPO_URI
+ENV GIT_REPO_URI=$GIT_REPO_URI
+
+EXPOSE 8080
+USER node
+CMD ["sh", "-c", "PORT=8080 NODE_ENV=production npx ts-node --transpile-only src/index.js"]

README.md

@@ -1,4 +1,4 @@
-# misato [![deploy status](https://img.shields.io/github/deployments/r-anime/discord-mod-bot/production?label=deploy)](https://github.com/r-anime/discord-mod-bot/deployments/activity_log?environment=production)
+# misato
 
 It's not much, but it's ours.
 
@@ -11,8 +11,8 @@ You'll want [Node](https://nodejs.org/en/download/) 12+ and a [MongoDB](https://
 ```bash
 # Install dependencies
 npm install
-# Create your config file from the sample and fill it in
-cp sample.config.js config.js && $EDITOR config.js
+# Create your environment file from the sample and fill it in
+cp .env.sample .env && $EDITOR .env
 # Migrate the database
 npx migrate up
 ```
@@ -26,6 +26,9 @@ npm install
 npm run start
 ```
 
+## Usage with Docker
+
+
 ## Contributing
 
 See [CONTRIBUTING.md](CONTRIBUTING.md).

logger.config.js

@@ -1,6 +1,4 @@
 // Describes custom log levels for the `another-logger` package.
-import config from './config';
-
 module.exports = {
 	levels: {
 		erisError: {style: 'red', text: 'error (eris)'},

migrations/1587086572450-create-collection-reminders.js

@@ -1,10 +1,11 @@
 const {MongoClient} = require('mongodb');
-const config = require('../config');
+
+const {MONGODB_CONNECTION_URI, MONGODB_DATABASE} = process.env;
 
 module.exports.up = async () => {
-	const mongoClient = new MongoClient(config.mongodb.url, {useUnifiedTopology: true});
+	const mongoClient = new MongoClient(MONGODB_CONNECTION_URI, {useUnifiedTopology: true});
 	await mongoClient.connect();
-	const db = mongoClient.db(config.mongodb.databaseName);
+	const db = mongoClient.db(MONGODB_DATABASE);
 
 	await db.createCollection('reminders', {
 		validator: {
@@ -34,9 +35,9 @@ module.exports.up = async () => {
 };
 
 module.exports.down = async () => {
-	const mongoClient = new MongoClient(config.mongodb.url, {useUnifiedTopology: true});
+	const mongoClient = new MongoClient(MONGODB_CONNECTION_URI, {useUnifiedTopology: true});
 	await mongoClient.connect();
-	const db = mongoClient.db(config.mongodb.databaseName);
+	const db = mongoClient.db(MONGODB_DATABASE);
 
 	await db.dropCollection('reminders');
 };

migrations/1588376720668-create-collection-discordUsers.js

@@ -1,10 +1,10 @@
 const {MongoClient} = require('mongodb');
-const config = require('../config');
+const {MONGODB_CONNECTION_URI, MONGODB_DATABASE} = process.env;
 
 module.exports.up = async () => {
-	const mongoClient = new MongoClient(config.mongodb.url, {useUnifiedTopology: true});
+	const mongoClient = new MongoClient(MONGODB_CONNECTION_URI, {useUnifiedTopology: true});
 	await mongoClient.connect();
-	const db = mongoClient.db(config.mongodb.databaseName);
+	const db = mongoClient.db(MONGODB_DATABASE);
 
 	await db.createCollection('redditAccounts', {
 		validator: {
@@ -25,9 +25,9 @@ module.exports.up = async () => {
 };
 
 module.exports.down = async () => {
-	const mongoClient = new MongoClient(config.mongodb.url, {useUnifiedTopology: true});
+	const mongoClient = new MongoClient(MONGODB_CONNECTION_URI, {useUnifiedTopology: true});
 	await mongoClient.connect();
-	const db = mongoClient.db(config.mongodb.databaseName);
+	const db = mongoClient.db(MONGODB_DATABASE);
 
 	await db.dropCollection('redditAccounts');
 };

migrations/1592636841669-create-collection-messageFilters.js

@@ -1,10 +1,10 @@
 const {MongoClient} = require('mongodb');
-const config = require('../config');
+const {MONGODB_CONNECTION_URI, MONGODB_DATABASE} = process.env;
 
 module.exports.up = async () => {
-	const mongoClient = new MongoClient(config.mongodb.url, {useUnifiedTopology: true});
+	const mongoClient = new MongoClient(MONGODB_CONNECTION_URI, {useUnifiedTopology: true});
 	await mongoClient.connect();
-	const db = mongoClient.db(config.mongodb.databaseName);
+	const db = mongoClient.db(MONGODB_DATABASE);
 
 	await db.createCollection('messageFilters', {
 		validator: {
@@ -25,9 +25,9 @@ module.exports.up = async () => {
 };
 
 module.exports.down = async () => {
-	const mongoClient = new MongoClient(config.mongodb.url, {useUnifiedTopology: true});
+	const mongoClient = new MongoClient(MONGODB_CONNECTION_URI, {useUnifiedTopology: true});
 	await mongoClient.connect();
-	const db = mongoClient.db(config.mongodb.databaseName);
+	const db = mongoClient.db(MONGODB_DATABASE);
 
 	await db.dropCollection('messageFilters');
 };

migrations/1596302630862-add-guildid-to-redditaccounts.js

@@ -1,10 +1,10 @@
 const {MongoClient} = require('mongodb');
-const config = require('../config');
+const {MONGODB_CONNECTION_URI, MONGODB_DATABASE} = process.env;
 
 module.exports.up = async () => {
-	const mongoClient = new MongoClient(config.mongodb.url, {useUnifiedTopology: true});
+	const mongoClient = new MongoClient(MONGODB_CONNECTION_URI, {useUnifiedTopology: true});
 	await mongoClient.connect();
-	const db = mongoClient.db(config.mongodb.databaseName);
+	const db = mongoClient.db(MONGODB_DATABASE);
 
 	await db.command({
 		collMod: 'redditAccounts',
@@ -29,9 +29,9 @@ module.exports.up = async () => {
 };
 
 module.exports.down = async () => {
-	const mongoClient = new MongoClient(config.mongodb.url, {useUnifiedTopology: true});
+	const mongoClient = new MongoClient(MONGODB_CONNECTION_URI, {useUnifiedTopology: true});
 	await mongoClient.connect();
-	const db = mongoClient.db(config.mongodb.databaseName);
+	const db = mongoClient.db(MONGODB_DATABASE);
 
 	await db.command({
 		collMod: 'redditAccounts',

migrations/1596492986396-add-redditnames-unique-index.js

@@ -1,18 +1,18 @@
 const {MongoClient} = require('mongodb');
-const config = require('../config');
+const {MONGODB_CONNECTION_URI, MONGODB_DATABASE} = process.env;
 
 module.exports.up = async () => {
-	const mongoClient = new MongoClient(config.mongodb.url, {useUnifiedTopology: true});
+	const mongoClient = new MongoClient(MONGODB_CONNECTION_URI, {useUnifiedTopology: true});
 	await mongoClient.connect();
-	const db = mongoClient.db(config.mongodb.databaseName);
+	const db = mongoClient.db(MONGODB_DATABASE);
 
 	await db.collection('redditAccounts').createIndex({userID: 1, guildID: 1, redditName: 1}, {unique: true});
 };
 
 module.exports.down = async () => {
-	const mongoClient = new MongoClient(config.mongodb.url, {useUnifiedTopology: true});
+	const mongoClient = new MongoClient(MONGODB_CONNECTION_URI, {useUnifiedTopology: true});
 	await mongoClient.connect();
-	const db = mongoClient.db(config.mongodb.databaseName);
+	const db = mongoClient.db(MONGODB_DATABASE);
 
 	await db.collection('redditAccounts').dropIndex({userID: 1, guildID: 1, redditName: 1}, {unique: true});
 };

migrations/1596502200514-create-collection-bans.js

@@ -1,10 +1,10 @@
 const {MongoClient} = require('mongodb');
-const config = require('../config');
+const {MONGODB_CONNECTION_URI, MONGODB_DATABASE} = process.env;
 
 module.exports.up = async () => {
-	const mongoClient = new MongoClient(config.mongodb.url, {useUnifiedTopology: true});
+	const mongoClient = new MongoClient(MONGODB_CONNECTION_URI, {useUnifiedTopology: true});
 	await mongoClient.connect();
-	const db = mongoClient.db(config.mongodb.databaseName);
+	const db = mongoClient.db(MONGODB_DATABASE);
 
 	await db.createCollection('bans', {
 		validator: {
@@ -37,9 +37,9 @@ module.exports.up = async () => {
 };
 
 module.exports.down = async () => {
-	const mongoClient = new MongoClient(config.mongodb.url, {useUnifiedTopology: true});
+	const mongoClient = new MongoClient(MONGODB_CONNECTION_URI, {useUnifiedTopology: true});
 	await mongoClient.connect();
-	const db = mongoClient.db(config.mongodb.databaseName);
+	const db = mongoClient.db(MONGODB_DATABASE);
 
 	await db.dropCollection('bans');
 };

migrations/1596507742549-create-collection-kicks.js

@@ -1,10 +1,10 @@
 const {MongoClient} = require('mongodb');
-const config = require('../config');
+const {MONGODB_CONNECTION_URI, MONGODB_DATABASE} = process.env;
 
 module.exports.up = async () => {
-	const mongoClient = new MongoClient(config.mongodb.url, {useUnifiedTopology: true});
+	const mongoClient = new MongoClient(MONGODB_CONNECTION_URI, {useUnifiedTopology: true});
 	await mongoClient.connect();
-	const db = mongoClient.db(config.mongodb.databaseName);
+	const db = mongoClient.db(MONGODB_DATABASE);
 
 	await db.createCollection('kicks', {
 		validator: {
@@ -34,9 +34,9 @@ module.exports.up = async () => {
 };
 
 module.exports.down = async () => {
-	const mongoClient = new MongoClient(config.mongodb.url, {useUnifiedTopology: true});
+	const mongoClient = new MongoClient(MONGODB_CONNECTION_URI, {useUnifiedTopology: true});
 	await mongoClient.connect();
-	const db = mongoClient.db(config.mongodb.databaseName);
+	const db = mongoClient.db(MONGODB_DATABASE);
 
 	await db.dropCollection('kicks');
 };