Dependencies

Environment variables

Source the script . /bin/set_environment.sh or put the following in your ~/.bashrc

RESEARCH_ROOT=/path/to/your/local/clone ; export RESEARCH_ROOT

or navigate to /your/local/clone and just type

RESEARCH_ROOT=`pwd` ; export RESEARCH_ROOT

All scripts and commands will assume, that the variables have been properly set. In GitLab CI, this is done as the default before_script:

default:
  before_script:
    - RESEARCH_ROOT=`pwd`; export RESEARCH_ROOT;

Docker

During CI/CD various docker images are used. All images that are used by the pipeline, are also stored in the container registry of this repository. In case of changes in /docker the pipeline is configured to update these images as well (check out the Docker-update in the stages section of the wiki).

pandoc-bash

This image can run bash regex commands and pandoc for building static html. For example you can (and should) use this image, to run a specific test on your machine

docker run -w `pwd` -v `pwd`:`pwd` -it --rm eltenedor/pandoc-bash
# wait for the docker image to be downloaded and started
source ./bin/set_environment.sh
./bin/test_preproc_topic.sh

Note that the above image is built on pandoc/core:2.13. Switching to a newer version of pandoc will cause the test test_run_pandoc.sh to fail.

If you don't want to attach the terminal of the docker container and only build the webpage, run:

docker run -w `pwd` -v `pwd`:`pwd` -it --rm -e "RESEARCH_ROOT=`pwd`" pandoc-bash:latest ./bin/build_webpage.sh"

This should create a folder build which you can display with an httpd-image, see below.

alpine-ssh

This image can run bash, openssh and rsync and is used at review and deployment stage for copying the product.

alpine-httpd-ssi

eltenedor/alpine-httpd-ssi

This file can be used to run a local apache2 web server with mod_include in order to verify the build. To this end build a static web page and type

 docker run -it --rm --name apache-server -p 8080:80 -v $RESEARCH_BUILD:/usr/local/apache2/htdocs/ eltenedor/alpine-httpd-ssi:latest

where $RESEARCH_DEPLOY is the folder location of the build. Then visit localhost:8080 in your web browser.

A modification that uses the configuration file from www3 and www3-dev is eltenedor/alpine-www3-dev. Dockerfile and httpd.conf are to be found in /docker. For further information consult the README.md file that is provided with each build.