Merge pull request #89 from funidata/devops

Configuration updates to enable production use

app/.sequelizerc.js

@@ -1,16 +1,14 @@
-const {
-  DATABASE_NAME,
-  DATABASE_USERNAME,
-  DATABASE_PASSWORD,
-  DATABASE_HOST,
-} = process.env;
+const { DATABASE_NAME, DATABASE_USERNAME, DATABASE_PASSWORD, DATABASE_HOST } = process.env;
+
+const commonConfig = {
+  username: DATABASE_USERNAME,
+  password: DATABASE_PASSWORD,
+  database: DATABASE_NAME,
+  host: DATABASE_HOST,
+  dialect: "postgres",
+};
 
 module.exports = {
-  development: {
-    username: DATABASE_USERNAME,
-    password: DATABASE_PASSWORD,
-    database: DATABASE_NAME,
-    host: DATABASE_HOST,
-    dialect: 'postgres',
-  },
-};
+  development: commonConfig,
+  production: commonConfig,
+};

app/Dockerfile

@@ -1,11 +1,13 @@
 # Using alpine because GitHub artifact upload is very slow for big images...
 FROM node:18.16-alpine
 
+USER node
+
 # Install dependencies.
 WORKDIR /usr/src/app
 COPY package.json package-lock.json ./
 RUN npm ci
 
 COPY . .
 
-CMD npm start
+CMD npm --offline start

app/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hybridilusmu",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "engines": {
     "npm": ">=9.5.1",
     "node": ">=18.16.0"
@@ -38,4 +38,4 @@
     "nyc": "^15.1.0",
     "prettier": "^2.8.8"
   }
-}
+}

compose.yaml

@@ -10,6 +10,7 @@ services:
       - ./app/test:/usr/src/app/test
     depends_on:
       - db
+    command: npm start
 
   db:
     container_name: lusmu-db

docs/.prettierrc.yaml

@@ -0,0 +1 @@
+proseWrap: never

docs/src/.vuepress/config.ts

@@ -15,6 +15,7 @@ export default defineUserConfig({
     sidebar: [
       "/introduction.md",
       "/developing.md",
+      "/hosting.md",
       "/tests.md",
       "/releases.md",
     ],

docs/src/developing.md

@@ -1,4 +1,4 @@
-# Developing Hybridilusmu
+# Developing
 
 This document guides you through the development process of Hybridilusmu.
 

docs/src/hosting.md

@@ -0,0 +1,19 @@
+# Hosting
+
+## Services
+
+Hybridilusmu uses PostgreSQL database for persistence. Currently we are developing on version 14.7 but any fairly recent version should work.
+
+## Server Configuration
+
+The environment variables below are required
+
+| Name | Description |
+| --- | --- |
+| `SLACK_APP_TOKEN` | App-Level Token with the `connections:write` scope. Used to authenticate the WebSocket connection (found under _Basic Information > App-Level Tokens_). |
+| `SLACK_BOT_TOKEN` | Bot User OAuth Token (found under _OAuth & Permissions_). |
+| `SLACK_SIGNING_SECRET` | Signing Secret (found under _Basic Information > App Credentials_). |
+| `DATABASE_USERNAME` | PostgreSQL username. |
+| `DATABASE_PASSWORD` | PostgreSQL password. |
+| `DATABASE_NAME` | PostgreSQL database name. |
+| `DATABASE_HOST` | PostgreSQL hostname. |

package.json

@@ -1,6 +1,6 @@
 {
   "name": "hybridilusmu-dev-env",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "engines": {
     "npm": ">=9.5.1",
     "node": ">=18.16.0"
@@ -22,4 +22,4 @@
     "lint": "cd app && npm run lint"
   },
   "license": "MIT"
-}
+}