Skip to content

Latest commit

 

History

History
181 lines (133 loc) · 4.86 KB

production.md

File metadata and controls

181 lines (133 loc) · 4.86 KB
Raw

What follows are the steps required to set up this app on a production instance.

These instructions assume an Ubuntu server instance. In AWS, a "medium" instance is recommended. The build step may cause the VM to run out of memory on a "small" instance.

Preparing the VM

Install Ubuntu packages required by NPM packages used by VizHub.

Install dependencies of the sharp package

sudo apt update
sudo apt install python build-essential

Install dependencies of Puppeteer:

sudo apt install gconf-service libasound2 libatk1.0-0 libatk-bridge2.0-0 libc6 libcairo2 libcups2 libdbus-1-3 libexpat1 libfontconfig1 libgcc1 libgconf-2-4 libgdk-pixbuf2.0-0 libglib2.0-0 libgtk-3-0 libnspr4 libpango-1.0-0 libpangocairo-1.0-0 libstdc++6 libx11-6 libx11-xcb1 libxcb1 libxcomposite1 libxcursor1 libxdamage1 libxext6 libxfixes3 libxi6 libxrandr2 libxrender1 libxss1 libxtst6 ca-certificates fonts-liberation libappindicator1 libnss3 lsb-release xdg-utils

Install Node.js using NVM

wget -qO- https://raw.githubusercontent.com/creationix/nvm/v0.33.11/install.sh | bash
source .bashrc
nvm install node

Set up SSH keys (see also https://gitlab.com/profile/keys).

ssh-keygen -t rsa -C "[email protected]" -b 4096
cat ~/.ssh/id_rsa.pub

Set up NGINX so that it will serve the app from port 3000 to port 80.

sudo apt-get install nginx -y
sudo vim /etc/nginx/sites-available/default

Paste the following:

upstream app_vizhub {
  server 127.0.0.1:3000;
  keepalive 8;
}

server {
  listen 80 default_server;
  listen [::]:80 default_server;
  server_name vizhub.com;
  access_log /var/log/nginx/vizhub.log;

  location / {
    proxy_set_header X-Real-IP $remote_addr;
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    proxy_set_header Host $http_host;
    proxy_set_header X-NginX-Proxy true;

    proxy_pass http://app_vizhub/;
    proxy_redirect off;
  }
}

Put this configuration into action, check for errors.

sudo /etc/init.d/nginx restart
tail /var/log/nginx/error.log

Set up HTTPS by following instructions at https://certbot.eff.org/lets-encrypt/ubuntuartful-nginx

Install MongoDB (see also Install MongoDB Community Edition on Ubuntu):

sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv 9DA31620334BD75D9DCB49F368818C72E52529D4
echo "deb [ arch=amd64,arm64 ] https://repo.mongodb.org/apt/ubuntu xenial/mongodb-org/4.0 multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-org-4.0.list
sudo apt-get update
sudo apt-get install mongodb-org -y
sudo service mongod start

Configure GitHub OAuth Tokens and MongoDB URL following in packages/web/.env. Here's a sample of what the .env file should look like:

GITHUB_ID=1937fa078932032536f9
GITHUB_SECRET=97892345784932b789a78f9d89c789c7890c2143
MONGO_URI=mongodb://localhost:27017/vizhub

Using Elastic Block Store

We use Amazon Elastic Block Store for permanent storage of the MongoDB database content.

To set up, in AWS Web UI, create volume, attach to VM (use default of dev/sdf).

See also http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-using-volumes.html

Setting up for the first time:

lsblk
sudo file -s /dev/xvdf # should output "/dev/xvdf: data"
sudo mkfs -t ext4 /dev/xvdf # [Initial setup only] Only run this if previous command said "data"
sudo mkdir /data
sudo mount /dev/xvdf /data
sudo cp /etc/fstab /etc/fstab.orig
sudo vim /etc/fstab
# paste this: /dev/xvdf       /data   ext4    defaults,nofail        0       2
sudo mount -a

sudo mkdir /data/mongodb # [Initial setup only]
sudo chmod go+w /data/mongodb # [Initial setup only]

sudo service mongod stop
sudo vim /etc/mongod.conf
# default dbPath is:
#   dbPath: /var/lib/mongodb
# change it to:
#   dbPath: /data/mongodb
sudo service mongod start
tail -f /var/log/mongodb/mongod.log

# If you get permissions-related errors:
sudo chown mongodb /data/mongodb -R

Set Up VizHub

git clone [email protected]:datavis-tech/vizhub.git

Set up the vizhub-ui submodule

cd vizhub
git submodule update --init

Install dependencies & bootstrap Lerna packages

npm install -g lerna
lerna bootstrap && npm run test

If errors occur regarding missing packages, try this:

lerna clean
lerna bootstrap && npm run test

Install PM2

npm install -g pm2

Build and start the Web server

cd packages/web/
npm run build
pm2 start --name app npm -- start

Start image generation service

cd ../imageGenerationService/
npm run build
pm2 start --name image-generation-service npm -- start