geneweb

arm64 (debian:stable-slim) Docker for GeneWeb. The generated image is pushed to docker hub

Quickstart

git clone https://gitlab.rimkus.it/web/geneweb.git geneweb
cd geneweb
./geneweb.sh setup
./geneweb.sh start

• gwsetup will be available on localhost:2316
• gwd will be available on localhost:2317

Note, if you would like to build the container from the raw Dockerfile use ./geneweb build instead of ./geneweb setup

for gwsetup you must edit the config/gwsetup_only file and replace the IP with the local IP or Hostname where the docker container runs within. Note that you have to rerun the ./geneweb setup and restart the container to have the settings applied.

starting (without git checkout)

# prepare shared folders
CONFDIR=/etc/geneweb
LOGDIR=/var/log/geneweb
DATADIR=/var/local/geneweb
GWD_PORT=2316
GWSETUP_PORT=2317
mkdir -p $CONFDIR
echo "172.17.0.1" >$CONFDIR/gwsetup_only
mkdir -p $DATADIR
mkdir -p $LOGDIR
# pull the image
docker pull ravermeister/geneweb
#run the image
docker run -d -t \
-e GWSETUP_LANG=de \
-e GWD_LANG=DE \
-p $GWD_PORT:2317 \
-p $GWSETUP_PORT:2316 \
-v $CONFDIR:/usr/local/share/geneweb/etc \
-v $DATADIR:/usr/local/share/geneweb/share/data \
-v $LOGDIR:/usr/local/share/geneweb/log \
--restart always \
--name geneweb \
ravermeister/geneweb

for gwsetup you must edit the $CONFDIR/gwsetup_only file and replace the IP with the local IP or Hostname where the docker container runs within.
The env vars GWSETUP_LANG and GWD_LANG are optional and set to de per default.

• gwsetup will be available on localhost:2316
• gwd will be available on localhost:2317

Running Geneweb in Docker Compose

Geneweb servers can be run as a multi-container application, with the following features :

• Start and stop services (gwd and geneweb_setup) separately.
• View the status of running services
• Stream the log output of running services through the docker logging facility
• Expose the services through a reverse-proxy (eg Traefik)

A sample Docker Compose configuration file including the required Traefik parameters is provided: docker/docker-compose.example.traefik.yml.
A sample Docker Compose without the Traefik parameters (for use with an already existing Webserver/Proxy) is provided: docker/docker-compose.example.yml

• Copy the desired file in your working directory, rename it to docker-compose.yml,
• adapt the content of this file to suit your needs, and provide a few parameters in a .env file
  • for the docker/docker-compose.example.traefik.yml (GWD_LANG, GWSETUP_LANG, CONFDIR, DATADIR).
  • for the docker/docker-compose.example.traefik.yml (GWD_LANG, GWSETUP_LANG, CONFDIR, DATADIR, GWD_PORT, GWSETUP_PORT). See below for configuration details.
• run docker-compose up -d (or sudo docker-compose up -d depending on your environment).

Configuration

there are 3 folders which are currently exposed:

• log -> all log files are written into this folder
• config -> all neccessary config files. Note you can overwrite the default redis.conf
• data -> all geneweb databases. You can create an authority file for gwd where each line is e.g user:password. The file must be called gwd_passwd because the geneweb-launch.sh starts gwd with the correct runtime argument when the file is found.

Plugins

Genweb has some Plugins available, for e.g. Image upload you need the v7_im plugin. the plugin directory /usr/local/share/geneweb/share/dist/gw/plugins is pre-configured in the start script. Currently following plugins are included:

• cgl
• export
• fixbase
• forum
• gwxjg
• jingoo
• lib_show
• no_index
• v7_im
• xhtml

To enable plugins you have to add (or find the line) plugins= inside the $DATADIR/[family].gwf file and add each plugin as a comma separated list.