Skip to content

Latest commit

 

History

History
91 lines (56 loc) · 3.43 KB

README.md

File metadata and controls

91 lines (56 loc) · 3.43 KB

Tools

This folder contains code not directly related to the applications, but for example documentation of Server Configuration and the setup for Continuous Deployment.

Contents

Hosting

Apache2

All applications from /services folder are running as local applications on various ports of localhost. To expose them to the interfaces, we need Apache2.

All the interfaces are served as web-apps through Apache2.

First, get the right certificates (SSLCertificateFile and SSLCACertificateFile) and place them in /tools/certificates/.

On Ubuntu server do: (NOTE the absolute path /home/121-platform, which might be different in your instance)

ln -s /home/121-platform/tools/121-platform.conf /etc/apache2/sites-enabled/121-platform.conf
ln -s /home/121-platform/tools/121-platform-https.conf /etc/apache2/sites-enabled/121-platform-https.conf
a2enmod ssl proxy proxy_http http2 rewrite headers expires mime dir
service apache2 restart

To check if it started correctly:

service apache2 status

Maintenance mode

The above configuration of Apache2 includes to return a "503 Service Unavailable" or "maintenance message" response when a .maintenance-file exists.

This is automatically used during deployment of the back-end services (see deploy.sh), but can also be turned on/off manually.

Where <webroot-path> is for example: /var/www/121-platform/;

  • To turn on: (create the file)
    touch <webroot-path>/.maintenance
  • To turn off: (remove the file)
    rm <webroot-path>/.maintenance

Manual Deployment

The bash-script deploy.sh can be run on the test/production-environment to perform all necessary steps.

Continuous Deployment

GitHub webhook

A GitHub webhook is fired after every merged Pull Request to an endpoint on the server. Upon arrival a script is run. See webhook.js.

This is currently set up. To reproduce, you would follow these steps:

  1. Create a systemd-service.
    Use the template webhook.service, fill in:

    • Set User to a user-account with the appropriate permissions.
    • Set NODE_ENV to test for "Continuous deployment" or production for "Releases-only"
    • Set GLOBAL_121_REPO to the absolute path of this git-repository
    • Set GLOBAL_121_WEB_ROOT to the absolute path of the deployment location of the web-apps
    • Set GITHUB_WEBHOOK_SECRET to the value configured on GitHub

  2. Install Node.js:
    See: https://github.com/nodesource/distributions#installation-instructions for instructions for Ubuntu.
    Make sure to install a version higher then v10; Preferably a LTS-release.
    Verify that the user set-up to run the webhook, has access to this correct version of Node/NPM.

  3. Enable the webhook service:

     cp tools/webhook.service /etc/systemd/system/webhook.service
 sudo service webhook start
 sudo service webhook status

  4. Expose the webhook service with Apache.
    See above, Hosting > Apache2.

Local development

Git-hooks

Some (optional) scripts are in git-hooks/ to ease running tests before actually committing or pushing.