Difference between revisions of "Docker"
(add description for arm64 Docker Container) |
m (remove duplicate information) |
||
(4 intermediate revisions by the same user not shown) | |||
Line 3: | Line 3: | ||
Download and install for your operating system from [https://docs.docker.com/install/ Docker]. | Download and install for your operating system from [https://docs.docker.com/install/ Docker]. | ||
− | To download the latest Dockerized image of Geneweb, open your favourite terminal and follow the instructions below | + | To download the latest Dockerized image of Geneweb, open your favourite terminal and follow the instructions below |
− | |||
− | |||
= windows/mac/linux = | = windows/mac/linux = | ||
Line 12: | Line 10: | ||
Therefore the Dockerfile's are developed independently | Therefore the Dockerfile's are developed independently | ||
− | == Download Image == | + | === Download Image === |
docker pull jeffernz/geneweb:latest | docker pull jeffernz/geneweb:latest | ||
Line 18: | Line 16: | ||
The above command will download the latest Dockerized image of Geneweb. The image is built on top of Ubuntu:19.04 | The above command will download the latest Dockerized image of Geneweb. The image is built on top of Ubuntu:19.04 | ||
− | == Run the Container == | + | === Run the Container === |
To run the Geneweb docker image as a container, run: | To run the Geneweb docker image as a container, run: | ||
Line 48: | Line 46: | ||
start-setup | start-setup | ||
− | == Additional running options == | + | === Additional running options === |
We can provide additional run time options when you run the docker Geneweb image | We can provide additional run time options when you run the docker Geneweb image | ||
Line 61: | Line 59: | ||
-e TZ=Australia/Melbourne | -e TZ=Australia/Melbourne | ||
− | == Geneweb bases storage == | + | === Geneweb bases storage === |
Once you run Geneweb in the dockerized container, the bases created in Geneweb will be stored under: | Once you run Geneweb in the dockerized container, the bases created in Geneweb will be stored under: | ||
Line 67: | Line 65: | ||
~/GenealogyData | ~/GenealogyData | ||
− | == Export as GEDCOM == | + | === Export as GEDCOM === |
To backup your bases on a running container: | To backup your bases on a running container: | ||
Line 77: | Line 75: | ||
~/GenealogyData/backup | ~/GenealogyData/backup | ||
− | == Import from GEDCOM == | + | === Import from GEDCOM === |
To import a GEDCOM file into GeneWeb, place the GEDCOM file under ''~/GenealogyData/import'' | To import a GEDCOM file into GeneWeb, place the GEDCOM file under ''~/GenealogyData/import'' | ||
Line 88: | Line 86: | ||
from being overwritten. | from being overwritten. | ||
− | = | + | = arm64 = |
− | for a detailed description see the [https://gitlab.rimkus.it/ | + | for a detailed description see the [https://gitlab.rimkus.it/web/geneweb readme] file of the project. |
− | == Prepare folders == | + | === Prepare folders === |
# prepare shared folders | # prepare shared folders | ||
Line 103: | Line 101: | ||
mkdir -p $LOGDIR | mkdir -p $LOGDIR | ||
− | == Pull the Container == | + | === Pull the Container === |
# pull the image | # pull the image | ||
− | docker pull ravermeister/ | + | docker pull ravermeister/geneweb |
− | == Start the Container == | + | === Start the Container === |
#run the image | #run the image | ||
Line 118: | Line 116: | ||
-v $DATADIR:/usr/local/share/geneweb/share/data \ | -v $DATADIR:/usr/local/share/geneweb/share/data \ | ||
-v $LOGDIR:/usr/local/share/geneweb/log \ | -v $LOGDIR:/usr/local/share/geneweb/log \ | ||
− | - | + | --restart always \ |
--name geneweb \ | --name geneweb \ | ||
− | + | ravermeister/geneweb | |
− | == Additional running options == | + | === Additional running options === |
− | for gwsetup you must edit the | + | 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. | replace the IP with the local IP or Hostname where the docker container runs within. | ||
Line 132: | Line 130: | ||
there are 3 folders which are currently exposed: | 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 | The file '''must''' be called ''gwd_passwd'' because the geneweb-launch.sh |
Latest revision as of 23:45, 8 March 2021
Download and install for your operating system from Docker. To download the latest Dockerized image of Geneweb, open your favourite terminal and follow the instructions below
windows/mac/linux
The Container's for each System architecture differ because they have to be adjusted individually. Therefore the Dockerfile's are developed independently
Download Image
docker pull jeffernz/geneweb:latest
The above command will download the latest Dockerized image of Geneweb. The image is built on top of Ubuntu:19.04
Run the Container
To run the Geneweb docker image as a container, run:
docker run -d \ --name jeffernz-geneweb \ -p 2316:2316 -p 2317:2317 \ -v ~/GenealogyData:/usr/local/var/geneweb \ jeffernz/geneweb:latest
This will now launch the Geneweb portal at http://localhost:2317 and the Geneweb setup portal at http://localhost:2316
To run the Geneweb portal by itself, the command is:
docker run -d \ --name jeffernz-geneweb \ -p 2317:2317 \ -v ~/GenealogyData:/usr/local/var/geneweb \ jeffernz/geneweb:latest \ start-portal
To run the Geneweb Setup by itself, the command is:
docker run -d \ --name jeffernz-geneweb \ -p 2316:2316 \ -v ~/GenealogyData:/usr/local/var/geneweb \ jeffernz/geneweb:latest \ start-setup
Additional running options
We can provide additional run time options when you run the docker Geneweb image
To run Geneweb in a different language (default is set to english):
-e LANGUAGE=de
To change the host ip-address when accessing Geneweb Setup portal
-e HOST_IP=10.0.1.2
To run GeneWeb in a different timezone. This is useful if you want to look at history of the edits and determine the correct time it was made for your timezone.
-e TZ=Australia/Melbourne
Geneweb bases storage
Once you run Geneweb in the dockerized container, the bases created in Geneweb will be stored under:
~/GenealogyData
Export as GEDCOM
To backup your bases on a running container:
docker exec -it jeffernz-geneweb backup.sh
The backup will be stored under
~/GenealogyData/backup
Import from GEDCOM
To import a GEDCOM file into GeneWeb, place the GEDCOM file under ~/GenealogyData/import and then execute the import command on the running instance. e.g.
docker exec -it jeffernz-geneweb import.sh
This will import the GEDCOM file into GeneWeb. Note, all GEDCOM files in the import folder will be imported. Make sure you remove older files to prevent the database from being overwritten.
arm64
for a detailed description see the readme file of the project.
Prepare folders
# prepare shared folders CONFDIR=/etc/geneweb LOGDIR=/var/log/geneweb DATADIR=/var/local/geneweb mkdir -p $CONFDIR echo "172.17.0.1" >$CONFDIR/gwsetup_only mkdir -p $DATADIR mkdir -p $LOGDIR
Pull the Container
# pull the image docker pull ravermeister/geneweb
Start the Container
#run the image docker run -d -t \ -p $GWD_PORT:2317 \ -p $GWSETUP_PORT:2316 \ -p $GWAPI_PORT:2322 \ -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
Additional running options
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.
gwsetup will be available on localhost:2316 gwd will be available on localhost:2317
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.
GeneWeb Manual
- Download and install GeneWeb program under GNU/Linux, Mac OS X, Microsoft Windows, FreeBSD; on Mac OS X, Linux or Windows using Docker; or in CGI mode behind a web server.
- Understand GeneWeb server, homonym, consanguinity.
Use and manage genealogical databases
- Import Gedcom
.ged
or GeneWeb.gw
files with gwsetup or in command-line. - Update datas (add/remove individuals and families), merge duplicates, type dates.
- Use wikitext syntax, macros, keyboard shortcuts.
- Clean, recover, rename, save, archive a database.
- Merge and split multiples databases.
Technical annex
- Personalize CSS, header and trailer, templates, lexicon and declension.
- Configuration file
.gwf
(for templm), wizard notes, passwords for friends/wizards and access restrictions to databases. - Add images in notes, further remarks for experts.