specs-website

This is the specifications.openehr.org website source code repository. It can be run as the following variants:

• production https://specifications.openehr.org
• test https://specifications-test.openehr.org or https://specifications-dev.openehr.org
• development (local) https://specifications.openehr.local as built image
• development (local) https://specifications-dev.openehr.local using mounted source code

Build and run instructions

It is recommended to use docker-compose to have this website running for a development environment.

First, in linux bash, macOS terminal or powershell build the image by running (from this project directory):

docker-compose build

It will build a service named web.

Then run the following in order to bring up webservice and a reverse proxy caddy that will serve the website under specifications.openehr.local:

docker-compose up -d

To get access to a bash prompt and run CLI scripts inside the container, the following should be executed from linux bash, macOS terminal or powershell:

docker-compose exec web bash

The web service will run Apache and PHP; the DocumentRoot is set to be /data/website/public.

The source code is located under the /data/website/src, whereas the main application configuration is stored under /data/website/config.

Various scripts are located under /data/website/scripts directory:

• The init.sh script should be used to clone all specifications repositories under /data/repos subdirectory.
• The spec_populate_releases_all.sh should be used to generate an export of all tags and releases under /data/releases which is used by the website to serve static content (html pages, diagrams, expressions, etc).

To (re)build cache of all manifest files, a simple GET action is required on http://specifications.openehr.local/manifest url.

Configuration

In order to configure some aspects of the website, the /data/website/.env file should be changed (or created based on .env.dist):

APP_ENV=production
APP_DEBUG=false
APP_HOOK_SECRET=abc
RELEASES_ROOT=
SPEC_POPULATE_RELEASES=true

By default, the website runs in production mode and debug mode is off, which means some files are cached; it is recommended to change this in development mode by setting the APP_ENV=development and APP_DEBUG=true.

The SPEC_POPULATE_RELEASES=true can be used to checkout the git repos and populate releases accordingly.

Development

For local development purpose, another variant of the website can be used, which has the website source code and the git repose mounted as volumes:

docker-compose build web-dev
docker-compose --profile dev up web-dev -d

CLI will be available through:

docker-compose --profile dev exec web-dev bash

This website will be available as https://specifications-dev.openehr.local