From 8830b24d118269f3e09eb109a71028e06684db76 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Joonas=20H=C3=A4kkinen?= Date: Thu, 20 Jul 2023 09:19:31 +0300 Subject: [PATCH 1/4] Add sequelize production config --- app/.sequelizerc.js | 26 ++++++++++++-------------- 1 file changed, 12 insertions(+), 14 deletions(-) diff --git a/app/.sequelizerc.js b/app/.sequelizerc.js index 7dcb09b..ce7a2b5 100644 --- a/app/.sequelizerc.js +++ b/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', - }, -}; \ No newline at end of file + development: commonConfig, + production: commonConfig, +}; From 5748c98d789b6b35d08281d7d3c1228af8fba70d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Joonas=20H=C3=A4kkinen?= Date: Thu, 20 Jul 2023 09:22:33 +0300 Subject: [PATCH 2/4] Fix Dockerfile for production use --- app/Dockerfile | 4 +++- compose.yaml | 1 + 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/app/Dockerfile b/app/Dockerfile index 0d116b4..48ec5c2 100644 --- a/app/Dockerfile +++ b/app/Dockerfile @@ -1,6 +1,8 @@ # 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 ./ @@ -8,4 +10,4 @@ RUN npm ci COPY . . -CMD npm start +CMD npm --offline start diff --git a/compose.yaml b/compose.yaml index e9f529a..88518d7 100644 --- a/compose.yaml +++ b/compose.yaml @@ -10,6 +10,7 @@ services: - ./app/test:/usr/src/app/test depends_on: - db + command: npm start db: container_name: lusmu-db From 6f889b3741dfd7bf7bf87a46e109c2c08aa43c46 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Joonas=20H=C3=A4kkinen?= Date: Thu, 20 Jul 2023 09:38:10 +0300 Subject: [PATCH 3/4] Document database configuration --- docs/.prettierrc.yaml | 1 + docs/src/.vuepress/config.ts | 1 + docs/src/developing.md | 2 +- docs/src/hosting.md | 19 +++++++++++++++++++ 4 files changed, 22 insertions(+), 1 deletion(-) create mode 100644 docs/.prettierrc.yaml create mode 100644 docs/src/hosting.md diff --git a/docs/.prettierrc.yaml b/docs/.prettierrc.yaml new file mode 100644 index 0000000..7b55902 --- /dev/null +++ b/docs/.prettierrc.yaml @@ -0,0 +1 @@ +proseWrap: never diff --git a/docs/src/.vuepress/config.ts b/docs/src/.vuepress/config.ts index dd4cde5..c3a5a63 100644 --- a/docs/src/.vuepress/config.ts +++ b/docs/src/.vuepress/config.ts @@ -15,6 +15,7 @@ export default defineUserConfig({ sidebar: [ "/introduction.md", "/developing.md", + "/hosting.md", "/tests.md", "/releases.md", ], diff --git a/docs/src/developing.md b/docs/src/developing.md index 8d6e344..b18bdcb 100644 --- a/docs/src/developing.md +++ b/docs/src/developing.md @@ -1,4 +1,4 @@ -# Developing Hybridilusmu +# Developing This document guides you through the development process of Hybridilusmu. diff --git a/docs/src/hosting.md b/docs/src/hosting.md new file mode 100644 index 0000000..c6b05d6 --- /dev/null +++ b/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. | From 5fb49fde87367a29cbca2136af0a17dce08ad02b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Joonas=20H=C3=A4kkinen?= Date: Thu, 20 Jul 2023 09:42:36 +0300 Subject: [PATCH 4/4] 0.0.3 --- app/package-lock.json | 4 ++-- app/package.json | 4 ++-- package.json | 4 ++-- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/app/package-lock.json b/app/package-lock.json index 4c76adf..db44d3a 100644 --- a/app/package-lock.json +++ b/app/package-lock.json @@ -1,12 +1,12 @@ { "name": "hybridilusmu", - "version": "0.0.2", + "version": "0.0.3", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "hybridilusmu", - "version": "0.0.2", + "version": "0.0.3", "dependencies": { "@slack/bolt": "^3.13.1", "dotenv": "^10.0.0", diff --git a/app/package.json b/app/package.json index 6e4d066..e30abf4 100644 --- a/app/package.json +++ b/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" } -} \ No newline at end of file +} diff --git a/package.json b/package.json index 15c471e..f0a7178 100644 --- a/package.json +++ b/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" -} \ No newline at end of file +}