Dockerise

.dockerignore

@@ -0,0 +1,2 @@
+.gitignore
+.env

.github/workflows/test.yml

@@ -0,0 +1,22 @@
+# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
+
+name: Test
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Install test dependencies
+      run: docker-compose run --rm app npm install --also=dev
+
+    - name: Run tests
+      run: docker-compose run --rm app npm run test

.gitignore

@@ -11,3 +11,4 @@ npm-debug.log
 public/styles/app.css
 public/styles/embed.css
 public/styles/landing.css
+.env

Dockerfile

@@ -0,0 +1,29 @@
+FROM ubuntu:latest
+
+ENV NODE_PATH=.
+ENV NODE_ENV production
+
+RUN apt-get update; \
+    apt-get -y install curl gnupg; \
+    curl -sL https://deb.nodesource.com/setup_14.x  | bash -
+RUN apt-get -y install nodejs
+
+COPY . /app
+WORKDIR /app
+
+RUN set -ex; \
+    npm install -g; \
+    cd metrics; \
+    npm install -g
+
+ARG USER_ID=1001
+ARG GROUP_ID=1001
+
+RUN set -ex; \
+  addgroup --gid $GROUP_ID --system containeruser; \
+  adduser --system --uid $USER_ID --gid $GROUP_ID containeruser; \
+  chown -R containeruser:containeruser /app
+
+USER containeruser
+
+CMD node index.js

Procfile

@@ -0,0 +1,2 @@
+web: node index.js
+metrics: ./start_metrics.sh

README.md

@@ -9,30 +9,69 @@ Organize hackaton ideas into a dashboard
 Install
 ===========
 
-I wrote a [blog post](http://zajdband.com/installing-hackdash) explaining the installation process. Also check the [wiki](https://github.com/danzajdband/hackdash/wiki) for more info and docs
+Hackdash can now be run in a docker container - see an example [dokku app configuration using ansible](https://github.com/OpenUpSA/ansible-config/tree/master/apps/hackdash).
+
+Alternatively, see a [blog post](http://zajdband.com/installing-hackdash) explaining the installation process to run it natively. Also check the [wiki](https://github.com/danzajdband/hackdash/wiki) for more info and docs
+
+Development enviroment
+----------------------
+
+The quickest way to set up a local development environment is using docker-compose to manage the environment by running
+
+    docker-compose up
+
+If you prefer to run it natively, refer to the blog post above, the config documentation below, and then run
+
+    yarn start
+
+Once the images have been pulled/built and started, you should be able to visit it at http://localhost:3000 and see the prompt to create a new dashboard. Once you click in the dashboard name input, it will try and fail to prompt you to login.
+
+To be able to login, create a `.env` file in the project root with the following config:
+
+    GITHUB_CLIENT_ID=
+    GITHUB_SECRET_KEY=
+    GITHUB_CALLBACK_URL=http://localhost:3000/auth/github/callback
+
+For the values of CLIENT_ID and SECRET_KEY, [create a Github OAuth app](https://docs.github.com/en/developers/apps/building-oauth-apps/creating-an-oauth-app) with the above callback URL, and enter the ID and key values in the .ev file.
+
+To apply the new environment variables to the running docker containers, stop them all and run `docker-compose up` again, or while they're running, run `docker-compose up -d` in another terminal.
+
+You should now be able to login using your own github account via OAuth, and get redirected back to your local hackdash instance with a logged-in session. You can now create a dashboard and a project.
+
 
 Config
 ======
 
-In your `config.json`:
-
-* `db`:
-	+ `url`: Overrides other db config. Full MongoDB URL.
-	+ `host`
-	+ `port`
-* `host`: Your instance host (i.e. yourdomain.com)
-* `port`: Your port (i.e. 3000)
-* `session`: Your session key (it must be a secret string)
-* `title`: Instance title used in the html title tag and other headings.
-* `live`: Boolean (true, false) that enable/disable the live feed feature in yourdomain.com/live.
-* `mailer`: SMTP mail info to enable email notifications using nodemailer. Check out the [options](https://github.com/andris9/Nodemailer#setting-up-smtp)
-* `team`: An array of `user`.`_id` to be shown as Team on Landing Page.
-* `maxQueryLimit`: a Number for the max amount of results at the landing page searchs.
-* `googleAnalytics`: the UA-XXXXXXXX-X code from Google Analytics. if not specified wont set the script.
-* `facebookAppId`: the Facebook App Id for share buttons. It will take first from keys.json, if not will use this one. Don't set it to not show FB share buttons.
-* `prerender`:
-	+ `enabled`: Boolean (true, false). Where the website would use the SEO Prerender 
-	+ `db`: The Mongo URI of Cached Pages.
+Configure by setting environment variables, setting values in a `.env` file, or by modifying `config.js`.
+
+| Environment variable or .env key | config.js key | Required | Default | Description |
+|----------------------------------|---------------|----------|---------|-------------|
+| `DATABASE_URL`                   | `db.url`      | Yes      |         | Overrides other db config. Full MongoDB URL. |
+| `DB_HOST`                        | `db.host`     | If DATABASE_URL not provided |         |             |
+| `DB_PORT`                        | `db.port`     | If DATABASE_URL not provided |         |             |
+| `HOST`                           | `host`        | Yes      |         | Your instance host (i.e. yourdomain.com) |
+| `PORT`                           | `port`        | No       | $PORT or 3000 | Your port (i.e. 3000) |
+| `SESSION`                        | `session`     | Yes      |         | Your session key (it must be a secret string) |
+| `TITLE`                          | `title`: Instance title used in the html title tag and other headings. |
+| `LIVE`                           | `live`        | No       | true    | Boolean (true, false) that enable/disable the live feed feature in yourdomain.com/live.
+| `MAILER`                         | `mailer`      | No       | `null`  | SMTP mail info to enable email notifications using nodemailer. Check out the [options](https://github.com/andris9/Nodemailer#setting-up-smtp) |
+|                                  | `team`        | No       | ?       | An array of `user`.`_id` to be shown as Team on Landing Page. |
+| `MAX_QUERY_LIMIT`                | `maxQueryLimit` | No     | 30      | a Number for the max amount of results at the landing page searchs. |
+| `GOOGLE_ANALYTICS`               | `googleAnalytics` | No   | `UA-XXXXXXXX-X` | the UA-XXXXXXXX-X code from Google Analytics. if not specified wont set the script. |
+| `FACEBOOK_APP_ID`                | `facebookAppId` | No     | `YYYYYYYYYYYY` | the Facebook App Id for share buttons. It will take first from keys.json, if not will use this one. Don't set it to not show FB share buttons. |
+| `PRERENDER_ENABLE`               | `prerender.enabled` | No | `false` | Boolean (true, false). Where the website would use the SEO Prerender.|
+| `PRERENDER_DB`                   | `presender.db`          | No       | `"mongodb://localhost/prerender"` | The Mongo URI of Cached Pages. |
+
+Authentication providers are configured using environment variables, .env file keys, or modifying `keys.js`.
+
+| Environment variable or .env key | config.js key | Required | Default | Description |
+|----------------------------------|---------------|----------|---------|-------------|
+| `GITHUB_CLIENT_ID`               | `github.clientID` | No       |         | [create a Github OAuth app](https://docs.github.com/en/developers/apps/building-oauth-apps/creating-an-oauth-app) |
+| `GITHUB_SECRET_KEY`              | `github.clientSecret` | No |       |             |
+| `GITHUB_CALLBACK_URL`            | `github.callbackURL` | No | `"fake"` | e.g. `http://localhost:3000/auth/github/callback` |
+
+See code for more authentication options.
+
 
 Running instances
 =================

config/config.js

@@ -0,0 +1,32 @@
+require('dotenv').config();
+
+module.exports = {
+  "db": {
+    "name": process.env.DB_NAME,
+    "host": process.env.DB_HOST,
+    "url": process.env.DATABASE_URL,
+  },
+  "host": process.env.HOST,
+  "port": parseInt(process.env.PORT) || 3000,
+  "session": process.env.SESSION,
+  "discourseUrl": process.env.DISCOURSE_URL || null,
+  "disqus_shortname": process.env.DISQUS_SHORTNAME || null,
+  "title": process.env.TITLE || "hackdash",
+  "live": process.env.LIVE || true,
+  "mailer": process.env.MAILER || null,
+  "prerender": {
+    "enabled": process.env.PRERENDER_ENABLE || false,
+    "db": process.env.PRERENDER_DB || "mongodb://localhost/prerender"
+  },
+  "team": [
+    "516d1997b2951b02280000e1",
+    "516d1997b2951b02280000e2",
+    "516d1997b2951b02280000e3",
+    "516d1997b2951b02280000e4",
+    "516d1997b2951b02280000e5",
+    "516d1997b2951b02280000e6"
+  ],
+  "maxQueryLimit": process.env.MAX_QUERY_LIMIT || 30,
+  "googleAnalytics": process.env.GOOGLE_ANALYTICS || "UA-XXXXXXXX-X",
+  "facebookAppId": process.env.FACEBOOK_APP_ID || "YYYYYYYYYYYY"
+};

config/config.test.js

@@ -0,0 +1,31 @@
+require('dotenv').config()
+module.exports = {
+    "db": {
+      "name": process.env.DB_NAME,
+      "host": process.env.DB_HOST,
+      "url": process.env.DATABASE_URL,
+    },
+  "host": process.env.HOST,
+    "port": parseInt(process.env.PORT) || 3000,
+    "session": process.env.SESSION,
+    "discourseUrl": process.env.DISCOURSE_URL || null,
+    "disqus_shortname": process.env.DISQUS_SHORTNAME || null,
+    "title": process.env.TITLE || "hackdash",
+    "live": process.env.LIVE || true,
+    "mailer": process.env.MAILER || null,
+    "prerender": {
+      "enabled": process.env.PREPENDER_ENABLE || false,
+      "db": process.env.PREPENDER_DB || "mongodb://localhost/prerender"
+    },
+    "team": [
+      "516d1997b2951b02280000e1",
+      "516d1997b2951b02280000e2",
+      "516d1997b2951b02280000e3",
+      "516d1997b2951b02280000e4",
+      "516d1997b2951b02280000e5",
+      "516d1997b2951b02280000e6"
+    ],
+    "maxQueryLimit": process.env.MAX_QUERY_LIMIT || 30,
+    "googleAnalytics": process.env.GOOGLE_ANALYTICS || "UA-XXXXXXXX-X",
+    "facebookAppId": process.env.FCAEBOOK_APP_ID || "YYYYYYYYYYYY"
+}

config/index.js

@@ -3,8 +3,8 @@
  * Expose the configuration. Uses the test config if NODE_ENV env setting
  * is set as 'test'. Otherwise it uses the default config file
  */
-
-import config from './config.json';
-import testConfig from './config.test.json';
+require('dotenv').config()
+import config from './config.js';
+import testConfig from './config.test.js';
 
 export default process.env.NODE_ENV === 'test' ? testConfig : config;

docker-compose.yml

@@ -0,0 +1,42 @@
+version: '3'
+
+services:
+  db:
+    image: mongo:4.1.8-xenial
+    volumes:
+      - dbdata:/data/db
+
+  app:
+    build:
+      context: .
+      args:
+        USER_ID: ${USER_ID:-1001}
+        GROUP_ID: ${GROUP_ID:-1001}
+    environment:
+      - HOST=${HOST:-localhost}
+      - DATABASE_URL=mongodb://db:27017
+      - SESSION=not-so-secret-in-dev
+    ports:
+      - "3000:3000"
+    volumes:
+      - .:/home/app
+    depends_on:
+      - db
+
+  metrics:
+    build:
+      context: .
+      args:
+        USER_ID: ${USER_ID:-1001}
+        GROUP_ID: ${GROUP_ID:-1001}
+    environment:
+      - DATABASE_URL=mongodb://db:27017
+    volumes:
+      - .:/home/app
+    depends_on:
+      - db
+    command: "./start_metrics.sh"
+
+volumes:
+  dbdata:
+  node_modules:

keys.js

@@ -0,0 +1,9 @@
+require('dotenv').config();
+module.exports = {
+
+  "github": {
+    "clientID": process.env.GITHUB_CLIENT_ID || "fake",
+    "clientSecret": process.env.GITHUB_SECRET_KEY,
+    "callbackURL": process.env.GITHUB_CALLBACK_URL,
+  }
+};

lib/auth/index.js

@@ -14,7 +14,7 @@
 import {Router} from 'express';
 import passport from 'passport';
 import passportHttp from 'passport-http';
-import keys from 'keys.json';
+import keys from 'keys.js';
 import {User} from 'lib/models';
 import gravatar from 'gravatar';
 

lib/routes/helpers.js

@@ -7,7 +7,7 @@
  * Module dependencies
  */
 
-import providers from 'keys.json';
+import providers from 'keys.js';
 
 /*
  * Render templates

lib/routes/site/controllers.js

@@ -13,7 +13,7 @@ import statuses from 'lib/models/statuses';
 import {check} from 'lib/utils/metas';
 import {setViewVar, loadProviders, render} from 'lib/routes/helpers';
 import {port, host, live, discourseUrl, disqus_shortname, googleAnalytics, facebookAppId} from 'config';
-import keys from 'keys.json';
+import keys from 'keys.js';
 
 /**
  * Module scope constants

lib/server/index.js

@@ -74,11 +74,19 @@ if (config.prerender && config.prerender.enabled) {
  */
 
 const MongoStore = connectMongo(session);
-app.set('subdomain offset', config.host.match(/\./g).length + 1)
+const hostDots = config.host.match(/\./g);
+const subdomainOffset = (hostDots ? hostDots.length : 0) + 1;
+app.set('subdomain offset',  subdomainOffset);
+
+const cookie = { maxAge: sessionMaxAge, path: '/' };
+// https://stackoverflow.com/a/1188145
+if (subdomainOffset > 1)
+    cookie["domain"] = '.' + config.host;
+
 app.use(session({
   secret: config.session,
   store: new MongoStore({db: config.db.name, url: config.db.url}),
-  cookie: { maxAge: sessionMaxAge, path: '/', domain: '.' + config.host },
+  cookie: cookie,
   resave: false,
   saveUninitialized: false
 }));

metrics/config.json

@@ -0,0 +1,5 @@
+{
+  "cronTime": "00 00 11 * * 1-5",
+  "filename": "metrics.json",
+  "code": ""
+}