https://geneweb.tuxfamily.org/w/api.php?action=feedcontributions&user=Jeffery&feedformat=atomGeneWeb - User contributions [en]2024-03-19T11:24:08ZUser contributionsMediaWiki 1.35.13https://geneweb.tuxfamily.org/w/index.php?title=Docker&diff=3534Docker2019-06-01T02:53:32Z<p>Jeffery: </p>
<hr />
<div>{{DISPLAYTITLE:Install GeneWeb on Mac, Linux or Windows using Docker}}<br />
{{toc right}}<br />
<br />
== Running Geneweb in a Docker container ==<br />
<br />
Download and install docker for your operating system from [https://docs.docker.com/install/ Docker].<br />
<br />
To download the latest Dockerized image of Geneweb, open your favourite terminal and execute:<br />
<br />
docker pull jeffernz/geneweb:latest<br />
<br />
The above command will download the latest Dockerized image of Geneweb. The image is built on top of Ubuntu:19.04<br />
<br />
To run the Geneweb docker image as a container, run:<br />
<br />
docker run -d \<br />
--name jeffernz-geneweb \<br />
-p 2316:2316 -p 2317:2317 \<br />
-v ~/GenealogyData:/usr/local/var/geneweb \<br />
jeffernz/geneweb:latest<br />
<br />
This will now launch the Geneweb portal at http://localhost:2317 and the Geneweb setup portal at http://localhost:2316<br />
<br />
To run the Geneweb portal by itself, the command is:<br />
<br />
docker run -d \<br />
--name jeffernz-geneweb \<br />
-p 2317:2317 \<br />
-v ~/GenealogyData:/usr/local/var/geneweb \<br />
jeffernz/geneweb:latest \<br />
start-portal<br />
<br />
To run the Geneweb Setup by itself, the command is:<br />
<br />
docker run -d \<br />
--name jeffernz-geneweb \<br />
-p 2316:2316 \<br />
-v ~/GenealogyData:/usr/local/var/geneweb \<br />
jeffernz/geneweb:latest \<br />
start-setup<br />
<br />
=== Additional running options ===<br />
<br />
We can provide additional run time options when you run the docker Geneweb image<br />
<br />
To run Geneweb in a different language (default is set to english):<br />
-e LANGUAGE=de<br />
<br />
To change the host ip-address when accessing Geneweb Setup portal<br />
-e HOST_IP=10.0.1.2<br />
<br />
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.<br />
-e TZ=Australia/Melbourne<br />
<br />
=== Geneweb bases storage ===<br />
<br />
Once you run Geneweb in the dockerized container, the bases created in Geneweb will be stored under:<br />
<br />
~/GenealogyData<br />
<br />
=== Export as GEDCOM ===<br />
<br />
To backup your bases on a running container:<br />
<br />
docker exec -it jeffernz-geneweb backup.sh<br />
<br />
The backup will be stored under<br />
<br />
~/GenealogyData/backup<br />
<br />
=== Import from GEDCOM ===<br />
<br />
To import a GEDCOM file into GeneWeb, place the GEDCOM file under ''~/GenealogyData/import<br />
and then execute the import command on the running instance. e.g.<br />
<br />
docker exec -it jeffernz-geneweb import.sh<br />
<br />
This will import the GEDCOM file into GeneWeb. Note, all GEDCOM files in the import<br />
folder will be imported. Make sure you remove older files to prevent the database<br />
from being overwritten.<br />
<br />
{{manual}}<br />
<br />
[[Category:Manual]]</div>Jefferyhttps://geneweb.tuxfamily.org/w/index.php?title=User:Jeffery&diff=3533User:Jeffery2019-05-17T23:38:01Z<p>Jeffery: </p>
<hr />
<div>Hello there!<br />
<br />
I am long time user of Geneweb and I am here to contribute back to the community in some form. Currently I am working on Dockerizing Geneweb to be running inside a container. This is documented at [[Docker| Running Geneweb in a Docker container]]<br />
<br />
The project page at Docker hub is [https://hub.docker.com/r/jeffernz/geneweb jeffernz/geneweb]. The github repository for this project is at [https://github.com/jeffery/docker-geneweb docker-geneweb ]<br />
<br />
Feel free to reach out to me with any questions about this project.<br />
<br />
Jeffery Fernandez</div>Jefferyhttps://geneweb.tuxfamily.org/w/index.php?title=Docker&diff=3532Docker2019-05-17T23:33:45Z<p>Jeffery: /* Running Geneweb in a Docker container */</p>
<hr />
<div>{{DISPLAYTITLE:Install GeneWeb on Mac, Linux or Windows using Docker}}<br />
{{toc right}}<br />
<br />
== Running Geneweb in a Docker container ==<br />
<br />
Download and install docker for your operating system from [https://docs.docker.com/install/ Docker].<br />
<br />
To download the latest Dockerized image of Geneweb, open your favourite terminal and execute:<br />
<br />
docker pull jeffernz/geneweb:latest<br />
<br />
The above command will download the latest Dockerized image of Geneweb. The image is built on top of Ubuntu:19.04<br />
<br />
To run the Geneweb docker image as a container, run:<br />
<br />
docker run -d \<br />
--name jeffernz-geneweb \<br />
-p 2316:2316 -p 2317:2317 \<br />
-v ~/GenealogyData:/usr/local/var/geneweb \<br />
jeffernz/geneweb:latest<br />
<br />
This will now launch the Geneweb portal at http://localhost:2317 and the Geneweb setup portal at http://localhost:2316<br />
<br />
To run the Geneweb portal by itself, the command is:<br />
<br />
docker run -d \<br />
--name jeffernz-geneweb \<br />
-p 2317:2317 \<br />
-v ~/GenealogyData:/usr/local/var/geneweb \<br />
jeffernz/geneweb:latest \<br />
start-portal<br />
<br />
To run the Geneweb Setup by itself, the command is:<br />
<br />
docker run -d \<br />
--name jeffernz-geneweb \<br />
-p 2316:2316 \<br />
-v ~/GenealogyData:/usr/local/var/geneweb \<br />
jeffernz/geneweb:latest \<br />
start-setup<br />
<br />
=== Additional running options ===<br />
<br />
We can provide additional run time options when you run the docker Geneweb image<br />
<br />
To run Geneweb in a different language (default is set to english):<br />
-e LANGUAGE=de<br />
<br />
To change the host ip-address when accessing Geneweb Setup portal<br />
-e HOST_IP=10.0.1.2<br />
<br />
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.<br />
-e TZ=Australia/Melbourne<br />
<br />
=== Geneweb bases storage ===<br />
<br />
Once you run Geneweb in the dockerized container, the bases created in Geneweb will be stored under:<br />
<br />
~/GenealogyData<br />
<br />
=== Backing up the bases ===<br />
<br />
To backup your bases on a running container:<br />
<br />
docker exec -it jeffernz-geneweb backup.sh<br />
<br />
The backup will be stored under<br />
<br />
~/GenealogyData/backup<br />
<br />
{{manual}}<br />
<br />
[[Category:Manual]]</div>Jefferyhttps://geneweb.tuxfamily.org/w/index.php?title=Docker&diff=3531Docker2019-05-13T15:03:55Z<p>Jeffery: /* Additional running options */</p>
<hr />
<div>{{DISPLAYTITLE:Install GeneWeb on Mac, Linux or Windows using Docker}}<br />
{{toc right}}<br />
<br />
== Running Geneweb in a Docker container ==<br />
<br />
Download and install docker for your operating system from [https://docs.docker.com/install/ Docker].<br />
<br />
To download the latest Dockerized image of Geneweb, open your favourite terminal and execute:<br />
<br />
docker pull jeffernz/geneweb:latest<br />
<br />
The above command will download the latest Dockerized image of Geneweb. The image is built on top of Ubuntu:19.04<br />
<br />
To run the Geneweb docker image as a container, run:<br />
<br />
docker run -d \<br />
--name jeffernz-geneweb \<br />
-p 2316:2316 -p 2317:2317 \<br />
-v ${HOME}/GenealogyData:/usr/local/var/geneweb \<br />
jeffernz/geneweb:latest<br />
<br />
This will now launch the Geneweb portal at http://localhost:2317 and the Geneweb setup portal at http://localhost:2316<br />
<br />
To run the Geneweb portal by itself, the command is:<br />
<br />
docker run -d \<br />
--name jeffernz-geneweb \<br />
-p 2317:2317 \<br />
-v ${HOME}/GenealogyData:/usr/local/var/geneweb \<br />
jeffernz/geneweb:latest \<br />
start-portal<br />
<br />
To run the Geneweb Setup by itself, the command is:<br />
<br />
docker run -d \<br />
--name jeffernz-geneweb \<br />
-p 2316:2316 \<br />
-v ${HOME}/GenealogyData:/usr/local/var/geneweb \<br />
jeffernz/geneweb:latest \<br />
start-setup<br />
<br />
=== Additional running options ===<br />
<br />
We can provide additional run time options when you run the docker Geneweb image<br />
<br />
To run Geneweb in a different language (default is set to english):<br />
-e LANGUAGE=de<br />
<br />
To change the host ip-address when accessing Geneweb Setup portal<br />
-e HOST_IP=10.0.1.2<br />
<br />
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.<br />
-e TZ=Australia/Melbourne<br />
<br />
=== Geneweb bases storage ===<br />
<br />
Once you run Geneweb in the dockerized container, the bases created in Geneweb will be stored under:<br />
<br />
${HOME}/GenealogyData<br />
<br />
=== Backing up the bases ===<br />
<br />
To backup your bases on a running container:<br />
<br />
docker exec -it \<br />
jeffernz-geneweb \<br />
backup.sh<br />
<br />
The backup will be stored under<br />
<br />
${HOME}/GenealogyData/backup<br />
<br />
{{manual}}<br />
<br />
[[Category:Manual]]</div>Jefferyhttps://geneweb.tuxfamily.org/w/index.php?title=Template:manual&diff=3528Template:manual2019-05-04T12:59:32Z<p>Jeffery: </p>
<hr />
<div><br><div style="margin:0 auto 1em; clear:both; width:90%; background-color:#f7f9ff; border:1px solid #8888aa; padding:3px;"><br />
<big>'''GeneWeb Manual'''</big><br />
[[Image:Rembrandt_Old_Man_Reading_a_Book.jpg|210px|right]]<br />
* [[Download]] and install GeneWeb program under [[Linux|GNU/Linux]], [[OSX|Mac OS X]], [[Windows|Microsoft Windows]]; on Mac OS X, Linux or Windows [[Docker|using Docker]]; or in [[CGI|CGI mode behind a web server]].<br />
* Understand [[gwd|GeneWeb server]], [[namesake|homonym]], [[consang|consanguinity]].<br />
<br />
'''Use and manage genealogical databases'''<br />
* Import Gedcom {{c|.ged}} or [[GWformat|GeneWeb {{c|.gw}}]] files with [[gwsetup]] or in [[man|command-line]].<br />
* [[Update|Update datas]] (add/remove individuals and families), [[Fusion|merge duplicates]], type [[date]]s.<br />
* Use [[wikitext|wikitext syntax]], [[macros]], [[shortcuts|keyboard shortcuts]].<br />
* [[Clean]], [[recover]], [[rename]], [[save]], [[archive]] a database.<br />
* [[Merge]] and [[Divide|split]] multiples databases.<br />
<br />
'''Technical annex'''<br />
* Personalize [[CSS]], [[header/fr|header and trailer]], [[templates]], [[lexicon]] and [[declension]].<br />
* [[configuration|Configuration file {{c|.gwf}}]] (for [[templm]]), [[wiznotes|wizard notes]], [[password|passwords for friends/wizards]] and [[access|access restrictions]] to databases.<br />
* Add [[image]]s in notes, further remarks for [[expert]]s.<br />
</div></div>Jefferyhttps://geneweb.tuxfamily.org/w/index.php?title=Docker&diff=3527Docker2019-05-04T12:49:02Z<p>Jeffery: </p>
<hr />
<div>{{DISPLAYTITLE:Install GeneWeb on Mac, Linux or Windows using Docker}}<br />
{{toc right}}<br />
<br />
== Running Geneweb in a Docker container ==<br />
<br />
Download and install docker for your operating system from [https://docs.docker.com/install/ Docker].<br />
<br />
To download the latest Dockerized image of Geneweb, open your favourite terminal and execute:<br />
<br />
docker pull jeffernz/geneweb:latest<br />
<br />
The above command will download the latest Dockerized image of Geneweb. The image is built on top of Ubuntu:19.04<br />
<br />
To run the Geneweb docker image as a container, run:<br />
<br />
docker run -d \<br />
--name jeffernz-geneweb \<br />
-p 2316:2316 -p 2317:2317 \<br />
-v ${HOME}/GenealogyData:/usr/local/var/geneweb \<br />
jeffernz/geneweb:latest<br />
<br />
This will now launch the Geneweb portal at http://localhost:2317 and the Geneweb setup portal at http://localhost:2316<br />
<br />
To run the Geneweb portal by itself, the command is:<br />
<br />
docker run -d \<br />
--name jeffernz-geneweb \<br />
-p 2317:2317 \<br />
-v ${HOME}/GenealogyData:/usr/local/var/geneweb \<br />
jeffernz/geneweb:latest \<br />
start-portal<br />
<br />
To run the Geneweb Setup by itself, the command is:<br />
<br />
docker run -d \<br />
--name jeffernz-geneweb \<br />
-p 2316:2316 \<br />
-v ${HOME}/GenealogyData:/usr/local/var/geneweb \<br />
jeffernz/geneweb:latest \<br />
start-setup<br />
<br />
=== Additional running options ===<br />
<br />
We can provide additional run time options when you run the docker Geneweb image<br />
<br />
To run Geneweb in a different language (default is set to english):<br />
-e LANGUAGE=de<br />
<br />
To change the host ip-address when accessing Geneweb Setup portal<br />
-e HOST_IP=10.0.1.2<br />
<br />
=== Geneweb bases storage ===<br />
<br />
Once you run Geneweb in the dockerized container, the bases created in Geneweb will be stored under:<br />
<br />
${HOME}/GenealogyData<br />
<br />
=== Backing up the bases ===<br />
<br />
To backup your bases on a running container:<br />
<br />
docker exec -it \<br />
jeffernz-geneweb \<br />
backup.sh<br />
<br />
The backup will be stored under<br />
<br />
${HOME}/GenealogyData/backup<br />
<br />
{{manual}}<br />
<br />
[[Category:Manual]]</div>Jefferyhttps://geneweb.tuxfamily.org/w/index.php?title=Docker&diff=3526Docker2019-05-04T11:35:56Z<p>Jeffery: /* Additional running options */</p>
<hr />
<div>{{DISPLAYTITLE:Install GeneWeb on Mac, Linux or Windows using Docker}}<br />
{{toc right}}<br />
<br />
== Running Geneweb in a Docker container ==<br />
<br />
Download and install docker for your operating system from [https://docs.docker.com/install/ Docker].<br />
<br />
To download the latest Dockerized image of Geneweb, open your favourite terminal and execute:<br />
<br />
docker pull jeffernz/geneweb:latest<br />
<br />
The above command will download the latest Dockerized image of Geneweb. The image is built on top of Ubuntu:19.04<br />
<br />
To run the Geneweb docker image as a container, run:<br />
<br />
docker run -d \<br />
--name jeffernz-geneweb \<br />
-p 2316:2316 -p 2317:2317 \<br />
-v ${HOME}/GenealogyData:/usr/local/var/geneweb \<br />
jeffernz/geneweb:latest<br />
<br />
This will now launch the Geneweb portal at http://localhost:2317 and the Geneweb setup portal at http://localhost:2316<br />
<br />
To run the Geneweb portal by itself, the command is:<br />
<br />
docker run -d \<br />
--name jeffernz-geneweb \<br />
-p 2317:2317 \<br />
-v ${HOME}/GenealogyData:/usr/local/var/geneweb \<br />
jeffernz/geneweb:latest \<br />
start-portal<br />
<br />
To run the Geneweb Setup by itself, the command is:<br />
<br />
docker run -d \<br />
--name jeffernz-geneweb \<br />
-p 2316:2316 \<br />
-v ${HOME}/GenealogyData:/usr/local/var/geneweb \<br />
jeffernz/geneweb:latest \<br />
start-setup<br />
<br />
=== Additional running options ===<br />
<br />
We can provide additional run time options when you run the docker Geneweb image<br />
<br />
To run Geneweb in a different language (default is set to english):<br />
-e LANGUAGE=de<br />
<br />
To change the host ip-address when accessing Geneweb Setup portal<br />
-e HOST_IP=10.0.1.2<br />
<br />
=== Geneweb bases storage ===<br />
<br />
Once you run Geneweb in the dockerized container, the bases created in Geneweb will be stored under:<br />
<br />
${HOME}/GenealogyData<br />
<br />
=== Backing up the bases ===<br />
<br />
To backup your bases on a running container:<br />
<br />
docker exec -it \<br />
jeffernz-geneweb \<br />
backup.sh<br />
<br />
The backup will be stored under<br />
<br />
${HOME}/GenealogyData/backup</div>Jefferyhttps://geneweb.tuxfamily.org/w/index.php?title=Docker&diff=3525Docker2019-05-04T11:34:46Z<p>Jeffery: /* Additional running options */</p>
<hr />
<div>{{DISPLAYTITLE:Install GeneWeb on Mac, Linux or Windows using Docker}}<br />
{{toc right}}<br />
<br />
== Running Geneweb in a Docker container ==<br />
<br />
Download and install docker for your operating system from [https://docs.docker.com/install/ Docker].<br />
<br />
To download the latest Dockerized image of Geneweb, open your favourite terminal and execute:<br />
<br />
docker pull jeffernz/geneweb:latest<br />
<br />
The above command will download the latest Dockerized image of Geneweb. The image is built on top of Ubuntu:19.04<br />
<br />
To run the Geneweb docker image as a container, run:<br />
<br />
docker run -d \<br />
--name jeffernz-geneweb \<br />
-p 2316:2316 -p 2317:2317 \<br />
-v ${HOME}/GenealogyData:/usr/local/var/geneweb \<br />
jeffernz/geneweb:latest<br />
<br />
This will now launch the Geneweb portal at http://localhost:2317 and the Geneweb setup portal at http://localhost:2316<br />
<br />
To run the Geneweb portal by itself, the command is:<br />
<br />
docker run -d \<br />
--name jeffernz-geneweb \<br />
-p 2317:2317 \<br />
-v ${HOME}/GenealogyData:/usr/local/var/geneweb \<br />
jeffernz/geneweb:latest \<br />
start-portal<br />
<br />
To run the Geneweb Setup by itself, the command is:<br />
<br />
docker run -d \<br />
--name jeffernz-geneweb \<br />
-p 2316:2316 \<br />
-v ${HOME}/GenealogyData:/usr/local/var/geneweb \<br />
jeffernz/geneweb:latest \<br />
start-setup<br />
<br />
=== Additional running options ===<br />
<br />
We can provide additional run time options when you run the docker Geneweb image<br />
<br />
To run Geneweb in a different language:<br />
-e LANGUAGE=de<br />
<br />
To change the host ip-address when accessing Geneweb Setup portal<br />
-e HOST_IP=10.0.1.2<br />
<br />
=== Geneweb bases storage ===<br />
<br />
Once you run Geneweb in the dockerized container, the bases created in Geneweb will be stored under:<br />
<br />
${HOME}/GenealogyData<br />
<br />
=== Backing up the bases ===<br />
<br />
To backup your bases on a running container:<br />
<br />
docker exec -it \<br />
jeffernz-geneweb \<br />
backup.sh<br />
<br />
The backup will be stored under<br />
<br />
${HOME}/GenealogyData/backup</div>Jefferyhttps://geneweb.tuxfamily.org/w/index.php?title=manual&diff=3524manual2019-05-04T09:02:23Z<p>Jeffery: </p>
<hr />
<div>{{DISPLAYTITLE:GeneWeb manual}}<br />
{{languages|manual}}<br />
__NOTOC__<br />
[[Image:Manuel_support.jpg|250px|right]]<br />
== Starting ==<br />
* [[Download]] <br />
* Install GeneWeb program under [[Linux|GNU/Linux]], [[OSX|Mac OS X]], [[Windows|Microsoft Windows]]; on Mac OS X, Linux or Windows [[Docker|using Docker]]; in [[CGI|CGI mode behind a web server]], with [[https|HTTPS access]].<br />
* Configure:<br />
** a server (launch parameters for [[gwd]])<br />
** operation of a base (parameters in a [[configuration|base_name.gwf]] file)<br />
** appearance of a base ([[templates|templates]])<br />
* [[man|Start]] GeneWeb.<br />
<br />
== Use ==<br />
* Data entry and update:<br />
** [[Update#Updating persons|individuals]] and [[Update#Updating families|families]], <br />
** [[Fusion|merge duplicates]], <br />
** enter [[date]]s.<br />
** [[declension|declensions]]<br />
* [[wikitext|Wikitext]] syntax, <br />
* [[macros|Macros]], <br />
* [[shortcuts|Keyboard shortcuts]].<br />
<br />
== Manage ==<br />
* Import GEDCOM {{c|.ged}} or [[GWformat|GeneWeb {{c|.gw}}]] databases with [[gwsetup]] or in [[man|command-line]].<br />
*[[Merge]] and [[Divide|split]] multiples databases.<br />
* [[Clean]], [[recover]], [[rename| rename or move]], [[save]], [[archive]] a database.<br />
<br />
== Technical annex ==<br />
* Understand the [[Gwd|gwd]] server.<br />
* Understand [[namesake|homonym]].<br />
* Configure appearance:<br />
** cascaded style sheets ([[CSS]])<br />
** [[header|header and trailer]], [[lexicon]]<br />
** [[templates]] <br />
* Configure operations:<br />
**[[configuration|configuration file {{c|.gwf}}]] <br />
** specific parameters for (for [[templm]])<br />
**[[password|passwords for friends/wizards]] and [[access|access restrictions]] to databases <br />
<br />
* Add [[image]]s in notes<br />
* Understand Geneweb file format (.gw)<br />
* Compute [[consang|consanguinity]]<br />
* Further remarks for [[expert]]s.<br />
<br />
[[Category:Manual| ]]</div>Jefferyhttps://geneweb.tuxfamily.org/w/index.php?title=Docker&diff=3523Docker2019-05-04T09:01:38Z<p>Jeffery: </p>
<hr />
<div>{{DISPLAYTITLE:Install GeneWeb on Mac, Linux or Windows using Docker}}<br />
{{toc right}}<br />
<br />
== Running Geneweb in a Docker container ==<br />
<br />
Download and install docker for your operating system from [https://docs.docker.com/install/ Docker].<br />
<br />
To download the latest Dockerized image of Geneweb, open your favourite terminal and execute:<br />
<br />
docker pull jeffernz/geneweb:latest<br />
<br />
The above command will download the latest Dockerized image of Geneweb. The image is built on top of Ubuntu:19.04<br />
<br />
To run the Geneweb docker image as a container, run:<br />
<br />
docker run -d \<br />
--name jeffernz-geneweb \<br />
-p 2316:2316 -p 2317:2317 \<br />
-v ${HOME}/GenealogyData:/usr/local/var/geneweb \<br />
jeffernz/geneweb:latest<br />
<br />
This will now launch the Geneweb portal at http://localhost:2317 and the Geneweb setup portal at http://localhost:2316<br />
<br />
To run the Geneweb portal by itself, the command is:<br />
<br />
docker run -d \<br />
--name jeffernz-geneweb \<br />
-p 2317:2317 \<br />
-v ${HOME}/GenealogyData:/usr/local/var/geneweb \<br />
jeffernz/geneweb:latest \<br />
start-portal<br />
<br />
To run the Geneweb Setup by itself, the command is:<br />
<br />
docker run -d \<br />
--name jeffernz-geneweb \<br />
-p 2316:2316 \<br />
-v ${HOME}/GenealogyData:/usr/local/var/geneweb \<br />
jeffernz/geneweb:latest \<br />
start-setup<br />
<br />
=== Additional running options ===<br />
<br />
We can provide additional options when you run the docker Geneweb image<br />
<br />
To run Geneweb in a different language:<br />
-e LANGUAGE=de<br />
<br />
To change the host ip-address when accessing Geneweb Setup portal<br />
-e HOST_IP=10.0.1.2<br />
<br />
=== Geneweb bases storage ===<br />
<br />
Once you run Geneweb in the dockerized container, the bases created in Geneweb will be stored under:<br />
<br />
${HOME}/GenealogyData<br />
<br />
=== Backing up the bases ===<br />
<br />
To backup your bases on a running container:<br />
<br />
docker exec -it \<br />
jeffernz-geneweb \<br />
backup.sh<br />
<br />
The backup will be stored under<br />
<br />
${HOME}/GenealogyData/backup</div>Jefferyhttps://geneweb.tuxfamily.org/w/index.php?title=manual&diff=3522manual2019-05-04T09:00:58Z<p>Jeffery: </p>
<hr />
<div>{{DISPLAYTITLE:GeneWeb manual}}<br />
{{languages|manual}}<br />
__NOTOC__<br />
[[Image:Manuel_support.jpg|250px|right]]<br />
== Starting ==<br />
* [[Download]] <br />
* Install GeneWeb program under [[Linux|GNU/Linux]], [[OSX|Mac OS X]], [[Windows|Microsoft Windows]]; on Mac, Linux or Windows [[Docker|using Docker]]; in [[CGI|CGI mode behind a web server]], with [[https|HTTPS access]].<br />
* Configure:<br />
** a server (launch parameters for [[gwd]])<br />
** operation of a base (parameters in a [[configuration|base_name.gwf]] file)<br />
** appearance of a base ([[templates|templates]])<br />
* [[man|Start]] GeneWeb.<br />
<br />
== Use ==<br />
* Data entry and update:<br />
** [[Update#Updating persons|individuals]] and [[Update#Updating families|families]], <br />
** [[Fusion|merge duplicates]], <br />
** enter [[date]]s.<br />
** [[declension|declensions]]<br />
* [[wikitext|Wikitext]] syntax, <br />
* [[macros|Macros]], <br />
* [[shortcuts|Keyboard shortcuts]].<br />
<br />
== Manage ==<br />
* Import GEDCOM {{c|.ged}} or [[GWformat|GeneWeb {{c|.gw}}]] databases with [[gwsetup]] or in [[man|command-line]].<br />
*[[Merge]] and [[Divide|split]] multiples databases.<br />
* [[Clean]], [[recover]], [[rename| rename or move]], [[save]], [[archive]] a database.<br />
<br />
== Technical annex ==<br />
* Understand the [[Gwd|gwd]] server.<br />
* Understand [[namesake|homonym]].<br />
* Configure appearance:<br />
** cascaded style sheets ([[CSS]])<br />
** [[header|header and trailer]], [[lexicon]]<br />
** [[templates]] <br />
* Configure operations:<br />
**[[configuration|configuration file {{c|.gwf}}]] <br />
** specific parameters for (for [[templm]])<br />
**[[password|passwords for friends/wizards]] and [[access|access restrictions]] to databases <br />
<br />
* Add [[image]]s in notes<br />
* Understand Geneweb file format (.gw)<br />
* Compute [[consang|consanguinity]]<br />
* Further remarks for [[expert]]s.<br />
<br />
[[Category:Manual| ]]</div>Jefferyhttps://geneweb.tuxfamily.org/w/index.php?title=Docker&diff=3521Docker2019-05-04T08:58:00Z<p>Jeffery: </p>
<hr />
<div>{{DISPLAYTITLE:Install GeneWeb on Mac, Linux and Windows using Docker}}<br />
{{toc right}}<br />
<br />
== Running Geneweb in a Docker container ==<br />
<br />
Download and install docker for your operating system from [https://docs.docker.com/install/ Docker].<br />
<br />
To download the latest Dockerized image of Geneweb, open your favourite terminal and execute:<br />
<br />
docker pull jeffernz/geneweb:latest<br />
<br />
The above command will download the latest Dockerized image of Geneweb. The image is built on top of Ubuntu:19.04<br />
<br />
To run the Geneweb docker image as a container, run:<br />
<br />
docker run -d \<br />
--name jeffernz-geneweb \<br />
-p 2316:2316 -p 2317:2317 \<br />
-v ${HOME}/GenealogyData:/usr/local/var/geneweb \<br />
jeffernz/geneweb:latest<br />
<br />
This will now launch the Geneweb portal at http://localhost:2317 and the Geneweb setup portal at http://localhost:2316<br />
<br />
To run the Geneweb portal by itself, the command is:<br />
<br />
docker run -d \<br />
--name jeffernz-geneweb \<br />
-p 2317:2317 \<br />
-v ${HOME}/GenealogyData:/usr/local/var/geneweb \<br />
jeffernz/geneweb:latest \<br />
start-portal<br />
<br />
To run the Geneweb Setup by itself, the command is:<br />
<br />
docker run -d \<br />
--name jeffernz-geneweb \<br />
-p 2316:2316 \<br />
-v ${HOME}/GenealogyData:/usr/local/var/geneweb \<br />
jeffernz/geneweb:latest \<br />
start-setup<br />
<br />
=== Additional running options ===<br />
<br />
We can provide additional options when you run the docker Geneweb image<br />
<br />
To run Geneweb in a different language:<br />
-e LANGUAGE=de<br />
<br />
To change the host ip-address when accessing Geneweb Setup portal<br />
-e HOST_IP=10.0.1.2<br />
<br />
=== Geneweb bases storage ===<br />
<br />
Once you run Geneweb in the dockerized container, the bases created in Geneweb will be stored under:<br />
<br />
${HOME}/GenealogyData<br />
<br />
=== Backing up the bases ===<br />
<br />
To backup your bases on a running container:<br />
<br />
docker exec -it \<br />
jeffernz-geneweb \<br />
backup.sh<br />
<br />
The backup will be stored under<br />
<br />
${HOME}/GenealogyData/backup</div>Jefferyhttps://geneweb.tuxfamily.org/w/index.php?title=OCaml&diff=3520OCaml2019-05-04T08:42:35Z<p>Jeffery: Moved Docker instructions to https://geneweb.tuxfamily.org/wiki/Docker</p>
<hr />
<div>{{DISPLAYTITLE:Installing OCaml and Camlp5 to compile GeneWeb}}<br />
{{languages|OCaml}}<br />
{{toc right}}<br />
Compiling GeneWeb requires the '''installation of [http://ocaml.org/ OCaml] and [http://camlp5.gforge.inria.fr/ Camlp5]'''. Nowadays, the simplest method is to install them through [http://opam.ocaml.org/ OPAM] (OCaml preferred package manager) that is able to manage multiple versions of OCaml on the same machine. Note that Camlp5 must be installed for each version of the compiler.<br />
<br />
Without OPAM, the old way of doing this was to install/compile OCaml and Camlp5 all by yourself.<br />
<br />
When Ocaml and camlp5 are installed, you can [[#Clone repository and compile GeneWeb|clone repository to compile GeneWeb]].<br />
<br />
Don’t forget that if your base has been built under an old version, it won't be compatible with bases built with new version: one should [[recover]] through the [[GWformat|'''.gw''' format]] to migrate from one to the other.<br />
<br />
== For GeneWeb 7 ==<br />
=== Under Linux ===<br />
This has been tested on a [https://www.debian.org/devel/debian-installer/ Debian] in March 2018 (debian-9.3.0-i386-netinst.iso).<br />
<br />
To install Opam/OCaml (4.07)/Camlp5 (7.06)<br />
<pre><br />
apt-get install opam<br />
opam init<br />
opam update<br />
opam switch 4.07.0<br />
eval `opam config env`<br />
opam install -y camlp5 cppo dune<br />
</pre><br />
<br />
If ocamlfind install fails, try installing the packages {{c|pkg-config}} or {{c|m4}} from your distribution.<br />
<br />
=== Under macOS ===<br />
This has been tested on OS X El Capitan 10.11.6 in February 2018.<br />
<br />
The best way to install Opam/OCaml is to install it with [http://brew.sh/ Homebrew], a package management software.<br />
You have to install first homebrew in a '''Terminal''' window by typing or pasting this command:<br />
<pre><br />
/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"<br />
</pre><br />
<br />
If this gives the error “Illegal variable name.”, switch to Bash.<br />
<br />
Once homebrew is installed you can easily install Opam in Terminal application with these commands:<br />
<pre><br />
brew install opam <br />
opam init<br />
opam update<br />
opam switch 4.05<br />
</pre><br />
and then OCaml:<br />
<br />
<pre><br />
opam install -y camlp5 ocamlfind<br />
eval `opam config env`<br />
</pre><br />
<br />
Before compiling GeneWeb you need to update Bash with Homebrew in a Terminal window:<br />
<pre><br />
brew install bash <br />
</pre><br />
Do not take into account the caveats about Bash path. You can now download and compile GeneWeb.<br />
<br />
=== Under Windows using Cygwin ===<br />
This has been tested on Windows 7 x64 and x86 in February 2018.<br />
<br />
If you have [https://en.wikipedia.org/wiki/Windows_PowerShell Windows Powershell] (embedded in Windows since XP SP2), this [https://gist.github.com/a2line/f134c88c80eafcf0411b38e32a0a7128 batch script] will download/compile/install Cygwin/Opam/OCaml/Camlp5/Ocamfind/GeneWeb for you. You can download the script copying this line on a Windows prompt (command line) '''with administrator rights''':<br />
<pre>powershell.exe -Command (new-object System.Net.WebClient).DownloadFile('https://gist.github.com/a2line/f134c88c80eafcf0411b38e32a0a7128/raw/','opamwin.bat')</pre><br />
<br />
Then just launch the downloaded script typing {{c|opamwin}} in the same console to install everything.<br />
<br />
Without Powershell, you have to download the batch file [https://gist.github.com/a2line/f134c88c80eafcf0411b38e32a0a7128/raw/ opamwin.bat] and the right Cygwin setup [https://www.cygwin.com/setup-x86_64.exe x64] or [https://www.cygwin.com/setup-x86.exe x86] manually. Launch the script under a prompt with administrator rights and having Cygwin setup in the same directory.<br />
<br />
== GeneWeb 6.xx with OPAM ==<br />
=== Under Linux ===<br />
[[download|Sources of GeneWeb 6.04, 6.05 and 6.08]] can be build easily with Opam switching to OCaml 3.12.1 (see [https://github.com/geneweb/geneweb/issues/435 #435]). On Debian:<br />
<pre><br />
opam switch 3.12.1<br />
eval `opam config env`<br />
opam install -y camlp5 ocamlfind<br />
</pre><br />
<br />
When using Opam on old sources, we need to replace the path to Camlp5 {{c|1=CAMLP5D=+camlp5}} in {{c|tools/Makefile.inc}} with a sed command '''after''' configuring Makefile:<br />
./configure<br />
sed -i 's|CAMLP5D=+camlp5|CAMLP5D=~/.opam/3.12.1/lib/camlp5|' tools/Makefile.inc<br />
make<br />
make distrib<br />
<br />
You can check the path to Camlp5 with {{c|camlp5 -where}} or {{c|ocamlfind query camlp5}}, for this exemple camlp5 lib is in {{c|/root/.opam/3.12.1/lib/camlp5/}}.<br />
<br />
=== Under OSX ===<br />
<br />
Apply the same process as with Linux, with the exception of the sed command:<br />
<br />
./configure<br />
sed -i .bak 's|CAMLP5D=+camlp5|CAMLP5D=~/.opam/3.12.1/lib/camlp5|' tools/Makefile.inc<br />
make<br />
make distrib<br />
<br />
=== Under Windows ===<br />
Previous chapter for Linux works for Windows under Cygwin modifying a few steps, OCaml version name is:<br />
<pre><br />
opam switch 3.12.1+mingw32<br />
</pre><br />
<br />
Using relative path or {{c|/cygdrive/…}} don’t work, we must target camlp5 lib using its full Windows path that depends of where is your home directory in Cygwin installation:<br />
<pre><br />
sed -i 's|CAMLP5D=.*|CAMLP5D=c:\\cygwin\\home\\user\\.opam\\3.12.1+mingw32\\lib\\camlp5|' tools/Makefile.inc<br />
</pre><br />
<br />
Building version 6.07 like this also works under Windows.<br />
<br />
== Clone repository and compile GeneWeb ==<br />
GeneWeb uses the version control software [https://en.wikipedia.org/wiki/Git_(software) Git]. Its repository is hosted on [https://github.com Github] at https://github.com/geneweb/geneweb. To compile GeneWeb, you need [[#top|OCaml]].<br />
<br />
git clone https://github.com/geneweb/geneweb<br />
cd geneweb<br />
./configure && make && make distrib<br />
<br />
If GeneWeb compilation fails, look at [[News#8 March 2016: Continuous integration|continuous integration tools]] to see if latest build is passing on your plateform. <br />
<br />
=== Build options ===<br />
{{c|./configure}} options:<br />
-h|--help<br />
show this help<br />
--api<br />
build the API<br />
-d|--debug<br />
add debugging symbols to the build command<br />
-i|--interactive<br />
run configure interactively<br />
-s|--static<br />
statically link libraries<br />
-we|--warn-error<br />
treat warnings as errors<br />
<br />
For example, if you want debug symbols/warnings use {{c|./configure -d -we}} then you can launch gwd adding {{c|1=OCAMLRUNPARAM=b}} to trigger the printing of a stack backtrace when an uncaught exception aborts the program.<br />
<br />
=== Build GeneWeb gui ===<br />
Since version 6.xx, an user friendly GTK gui helps managing gwd and gwsetup, it can be build with lablgtk installed.<br />
opam install lablgtk<br />
./configure<br />
make everything<br />
<br />
<br />
== GeneWeb/OCaml/Camlp5 compability chart ==<br />
{| class="wikitable centre" <br />
|-<br />
! GeneWeb || Ocaml || Camlp4/5<br />
|-<br />
| 1.07-2.07 || 2.01-2.02 || p4*<br />
|-<br />
| 3.01-3.03 || 2.01-2.04 || p4*<br />
|-<br />
| 3.04-3.07 || 2.01-3.00 || p4*<br />
|-<br />
| 3.08-4.01 || 3.00 || p4*<br />
|- <br />
| 4.02 || 3.01 || p4*<br />
|-<br />
| 4.03 || 3.02 || p4*<br />
|-<br />
| 4.04-4.07 || 3.04 ||<br />
|-<br />
| 4.08-4.09 || 3.06 || p4*<br />
|-<br />
| 4.10 || 3.08 ||<br />
|-<br />
| 5.00-5.01 || ||<br />
|-<br />
| 5.02 || 3.11 || p5 6.02.1**<br />
|-<br />
| 6.00-6.08 || 3.12.1 || p5 6.04-6.16<br />
|-<br />
| 7 master || 4.02.3-4.0.7 || p5 6.13-7.07<br />
|}<br />
<nowiki>*</nowiki> “same version number” for camlp4 as Ocaml version number<br />
<br />
<nowiki>**</nowiki> Dominique Deram, [http://dominique95880.free.fr/divers/compilgw/compilwin_gw.htm compilation under Windows XP] (jan. 2011)<br />
<br />
<br />
{{manual}}<br />
<br />
[[Category:Manual]]</div>Jefferyhttps://geneweb.tuxfamily.org/w/index.php?title=Docker&diff=3519Docker2019-05-04T08:41:28Z<p>Jeffery: Created page with "== Running Geneweb in a Docker container == Download and install docker for your operating system from [https://docs.docker.com/install/ Docker]. To download the latest Dock..."</p>
<hr />
<div>== Running Geneweb in a Docker container ==<br />
<br />
Download and install docker for your operating system from [https://docs.docker.com/install/ Docker].<br />
<br />
To download the latest Dockerized image of Geneweb, open your favourite terminal and execute:<br />
<br />
docker pull jeffernz/geneweb:latest<br />
<br />
The above command will download the latest Dockerized image of Geneweb. The image is built on top of Ubuntu:19.04<br />
<br />
To run the Geneweb docker image as a container, run:<br />
<br />
docker run -d \<br />
--name jeffernz-geneweb \<br />
-p 2316:2316 -p 2317:2317 \<br />
-v ${HOME}/GenealogyData:/usr/local/var/geneweb \<br />
jeffernz/geneweb:latest<br />
<br />
This will now launch the Geneweb portal at http://localhost:2317 and the Geneweb setup portal at http://localhost:2316<br />
<br />
To run the Geneweb portal by itself, the command is:<br />
<br />
docker run -d \<br />
--name jeffernz-geneweb \<br />
-p 2317:2317 \<br />
-v ${HOME}/GenealogyData:/usr/local/var/geneweb \<br />
jeffernz/geneweb:latest \<br />
start-portal<br />
<br />
To run the Geneweb Setup by itself, the command is:<br />
<br />
docker run -d \<br />
--name jeffernz-geneweb \<br />
-p 2316:2316 \<br />
-v ${HOME}/GenealogyData:/usr/local/var/geneweb \<br />
jeffernz/geneweb:latest \<br />
start-setup<br />
<br />
=== Additional running options ===<br />
<br />
We can provide additional options when you run the docker Geneweb image<br />
<br />
To run Geneweb in a different language:<br />
-e LANGUAGE=de<br />
<br />
To change the host ip-address when accessing Geneweb Setup portal<br />
-e HOST_IP=10.0.1.2<br />
<br />
=== Geneweb bases storage ===<br />
<br />
Once you run Geneweb in the dockerized container, the bases created in Geneweb will be stored under:<br />
<br />
${HOME}/GenealogyData<br />
<br />
=== Backing up the bases ===<br />
<br />
To backup your bases on a running container:<br />
<br />
docker exec -it \<br />
jeffernz-geneweb \<br />
backup.sh<br />
<br />
The backup will be stored under<br />
<br />
${HOME}/GenealogyData/backup</div>Jefferyhttps://geneweb.tuxfamily.org/w/index.php?title=User:Jeffery&diff=3518User:Jeffery2019-05-04T02:44:15Z<p>Jeffery: Created page with "Hello there! I am long time user of Geneweb and I am here to contribute back to the community in some form. Currently I am working on Dockerizing Geneweb to be running inside..."</p>
<hr />
<div>Hello there!<br />
<br />
I am long time user of Geneweb and I am here to contribute back to the community in some form. Currently I am working on Dockerizing Geneweb to be running inside a container. This is documented at [https://geneweb.tuxfamily.org/wiki/OCaml#Running_Geneweb_in_a_Docker_container Running Geneweb in a Docker container]<br />
<br />
The project page at Docker hub is [https://hub.docker.com/r/jeffernz/geneweb jeffernz/geneweb]. The github repository for this project is at [https://github.com/jeffery/docker-geneweb docker-geneweb ]<br />
<br />
Feel free to reach out to me with any questions about this project.<br />
<br />
Jeffery Fernandez</div>Jefferyhttps://geneweb.tuxfamily.org/w/index.php?title=OCaml&diff=3517OCaml2019-05-04T02:35:10Z<p>Jeffery: /* Running Geneweb in a Docker container */</p>
<hr />
<div>{{DISPLAYTITLE:Installing OCaml and Camlp5 to compile GeneWeb}}<br />
{{languages|OCaml}}<br />
{{toc right}}<br />
Compiling GeneWeb requires the '''installation of [http://ocaml.org/ OCaml] and [http://camlp5.gforge.inria.fr/ Camlp5]'''. Nowadays, the simplest method is to install them through [http://opam.ocaml.org/ OPAM] (OCaml preferred package manager) that is able to manage multiple versions of OCaml on the same machine. Note that Camlp5 must be installed for each version of the compiler.<br />
<br />
Without OPAM, the old way of doing this was to install/compile OCaml and Camlp5 all by yourself.<br />
<br />
When Ocaml and camlp5 are installed, you can [[#Clone repository and compile GeneWeb|clone repository to compile GeneWeb]].<br />
<br />
Don’t forget that if your base has been built under an old version, it won't be compatible with bases built with new version: one should [[recover]] through the [[GWformat|'''.gw''' format]] to migrate from one to the other.<br />
<br />
== For GeneWeb 7 ==<br />
=== Under Linux ===<br />
This has been tested on a [https://www.debian.org/devel/debian-installer/ Debian] in March 2018 (debian-9.3.0-i386-netinst.iso).<br />
<br />
To install Opam/OCaml (4.07)/Camlp5 (7.06)<br />
<pre><br />
apt-get install opam<br />
opam init<br />
opam update<br />
opam switch 4.07.0<br />
eval `opam config env`<br />
opam install -y camlp5 cppo dune<br />
</pre><br />
<br />
If ocamlfind install fails, try installing the packages {{c|pkg-config}} or {{c|m4}} from your distribution.<br />
<br />
=== Under macOS ===<br />
This has been tested on OS X El Capitan 10.11.6 in February 2018.<br />
<br />
The best way to install Opam/OCaml is to install it with [http://brew.sh/ Homebrew], a package management software.<br />
You have to install first homebrew in a '''Terminal''' window by typing or pasting this command:<br />
<pre><br />
/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"<br />
</pre><br />
<br />
If this gives the error “Illegal variable name.”, switch to Bash.<br />
<br />
Once homebrew is installed you can easily install Opam in Terminal application with these commands:<br />
<pre><br />
brew install opam <br />
opam init<br />
opam update<br />
opam switch 4.05<br />
</pre><br />
and then OCaml:<br />
<br />
<pre><br />
opam install -y camlp5 ocamlfind<br />
eval `opam config env`<br />
</pre><br />
<br />
Before compiling GeneWeb you need to update Bash with Homebrew in a Terminal window:<br />
<pre><br />
brew install bash <br />
</pre><br />
Do not take into account the caveats about Bash path. You can now download and compile GeneWeb.<br />
<br />
=== Under Windows using Cygwin ===<br />
This has been tested on Windows 7 x64 and x86 in February 2018.<br />
<br />
If you have [https://en.wikipedia.org/wiki/Windows_PowerShell Windows Powershell] (embedded in Windows since XP SP2), this [https://gist.github.com/a2line/f134c88c80eafcf0411b38e32a0a7128 batch script] will download/compile/install Cygwin/Opam/OCaml/Camlp5/Ocamfind/GeneWeb for you. You can download the script copying this line on a Windows prompt (command line) '''with administrator rights''':<br />
<pre>powershell.exe -Command (new-object System.Net.WebClient).DownloadFile('https://gist.github.com/a2line/f134c88c80eafcf0411b38e32a0a7128/raw/','opamwin.bat')</pre><br />
<br />
Then just launch the downloaded script typing {{c|opamwin}} in the same console to install everything.<br />
<br />
Without Powershell, you have to download the batch file [https://gist.github.com/a2line/f134c88c80eafcf0411b38e32a0a7128/raw/ opamwin.bat] and the right Cygwin setup [https://www.cygwin.com/setup-x86_64.exe x64] or [https://www.cygwin.com/setup-x86.exe x86] manually. Launch the script under a prompt with administrator rights and having Cygwin setup in the same directory.<br />
<br />
== GeneWeb 6.xx with OPAM ==<br />
=== Under Linux ===<br />
[[download|Sources of GeneWeb 6.04, 6.05 and 6.08]] can be build easily with Opam switching to OCaml 3.12.1 (see [https://github.com/geneweb/geneweb/issues/435 #435]). On Debian:<br />
<pre><br />
opam switch 3.12.1<br />
eval `opam config env`<br />
opam install -y camlp5 ocamlfind<br />
</pre><br />
<br />
When using Opam on old sources, we need to replace the path to Camlp5 {{c|1=CAMLP5D=+camlp5}} in {{c|tools/Makefile.inc}} with a sed command '''after''' configuring Makefile:<br />
./configure<br />
sed -i 's|CAMLP5D=+camlp5|CAMLP5D=~/.opam/3.12.1/lib/camlp5|' tools/Makefile.inc<br />
make<br />
make distrib<br />
<br />
You can check the path to Camlp5 with {{c|camlp5 -where}} or {{c|ocamlfind query camlp5}}, for this exemple camlp5 lib is in {{c|/root/.opam/3.12.1/lib/camlp5/}}.<br />
<br />
=== Under OSX ===<br />
<br />
Apply the same process as with Linux, with the exception of the sed command:<br />
<br />
./configure<br />
sed -i .bak 's|CAMLP5D=+camlp5|CAMLP5D=~/.opam/3.12.1/lib/camlp5|' tools/Makefile.inc<br />
make<br />
make distrib<br />
<br />
=== Under Windows ===<br />
Previous chapter for Linux works for Windows under Cygwin modifying a few steps, OCaml version name is:<br />
<pre><br />
opam switch 3.12.1+mingw32<br />
</pre><br />
<br />
Using relative path or {{c|/cygdrive/…}} don’t work, we must target camlp5 lib using its full Windows path that depends of where is your home directory in Cygwin installation:<br />
<pre><br />
sed -i 's|CAMLP5D=.*|CAMLP5D=c:\\cygwin\\home\\user\\.opam\\3.12.1+mingw32\\lib\\camlp5|' tools/Makefile.inc<br />
</pre><br />
<br />
Building version 6.07 like this also works under Windows.<br />
<br />
== Clone repository and compile GeneWeb ==<br />
GeneWeb uses the version control software [https://en.wikipedia.org/wiki/Git_(software) Git]. Its repository is hosted on [https://github.com Github] at https://github.com/geneweb/geneweb. To compile GeneWeb, you need [[#top|OCaml]].<br />
<br />
git clone https://github.com/geneweb/geneweb<br />
cd geneweb<br />
./configure && make && make distrib<br />
<br />
If GeneWeb compilation fails, look at [[News#8 March 2016: Continuous integration|continuous integration tools]] to see if latest build is passing on your plateform. <br />
<br />
=== Build options ===<br />
{{c|./configure}} options:<br />
-h|--help<br />
show this help<br />
--api<br />
build the API<br />
-d|--debug<br />
add debugging symbols to the build command<br />
-i|--interactive<br />
run configure interactively<br />
-s|--static<br />
statically link libraries<br />
-we|--warn-error<br />
treat warnings as errors<br />
<br />
For example, if you want debug symbols/warnings use {{c|./configure -d -we}} then you can launch gwd adding {{c|1=OCAMLRUNPARAM=b}} to trigger the printing of a stack backtrace when an uncaught exception aborts the program.<br />
<br />
=== Build GeneWeb gui ===<br />
Since version 6.xx, an user friendly GTK gui helps managing gwd and gwsetup, it can be build with lablgtk installed.<br />
opam install lablgtk<br />
./configure<br />
make everything<br />
<br />
== Running Geneweb in a Docker container ==<br />
<br />
Download and install docker for your operating system from [https://docs.docker.com/install/ Docker].<br />
<br />
To download the latest Dockerized image of Geneweb, open your favourite terminal and execute:<br />
<br />
docker pull jeffernz/geneweb:latest<br />
<br />
The above command will download the latest Dockerized image of Geneweb<br />
<br />
To run the Geneweb docker image as a container, run:<br />
<br />
docker run -d \<br />
--name jeffernz-geneweb \<br />
-p 2316:2316 -p 2317:2317 \<br />
-v ${HOME}/GenealogyData:/usr/local/var/geneweb \<br />
jeffernz/geneweb:latest<br />
<br />
This will now launch the Geneweb portal at http://localhost:2317 and the Geneweb setup portal at http://localhost:2316<br />
<br />
To run the Geneweb portal by itself, the command is:<br />
<br />
docker run -d \<br />
--name jeffernz-geneweb \<br />
-p 2317:2317 \<br />
-v ${HOME}/GenealogyData:/usr/local/var/geneweb \<br />
jeffernz/geneweb:latest \<br />
start-portal<br />
<br />
To run the Geneweb Setup by itself, the command is:<br />
<br />
docker run -d \<br />
--name jeffernz-geneweb \<br />
-p 2316:2316 \<br />
-v ${HOME}/GenealogyData:/usr/local/var/geneweb \<br />
jeffernz/geneweb:latest \<br />
start-setup<br />
<br />
=== Additional running options ===<br />
<br />
We can provide additional options when you run the docker Geneweb image<br />
<br />
To run Geneweb in a different language:<br />
-e LANGUAGE=de<br />
<br />
To change the host ip-address when accessing Geneweb Setup portal<br />
-e HOST_IP=10.0.1.2<br />
<br />
=== Geneweb bases storage ===<br />
<br />
Once you run Geneweb in the dockerized container, the bases created in Geneweb will be stored under:<br />
<br />
${HOME}/GenealogyData<br />
<br />
=== Backing up the bases ===<br />
<br />
To backup your bases on a running container:<br />
<br />
docker exec -it \<br />
jeffernz-geneweb \<br />
backup.sh<br />
<br />
The backup will be stored under<br />
<br />
${HOME}/GenealogyData/backup<br />
<br />
== GeneWeb/OCaml/Camlp5 compability chart ==<br />
{| class="wikitable centre" <br />
|-<br />
! GeneWeb || Ocaml || Camlp4/5<br />
|-<br />
| 1.07-2.07 || 2.01-2.02 || p4*<br />
|-<br />
| 3.01-3.03 || 2.01-2.04 || p4*<br />
|-<br />
| 3.04-3.07 || 2.01-3.00 || p4*<br />
|-<br />
| 3.08-4.01 || 3.00 || p4*<br />
|- <br />
| 4.02 || 3.01 || p4*<br />
|-<br />
| 4.03 || 3.02 || p4*<br />
|-<br />
| 4.04-4.07 || 3.04 ||<br />
|-<br />
| 4.08-4.09 || 3.06 || p4*<br />
|-<br />
| 4.10 || 3.08 ||<br />
|-<br />
| 5.00-5.01 || ||<br />
|-<br />
| 5.02 || 3.11 || p5 6.02.1**<br />
|-<br />
| 6.00-6.08 || 3.12.1 || p5 6.04-6.16<br />
|-<br />
| 7 master || 4.02.3-4.0.7 || p5 6.13-7.07<br />
|}<br />
<nowiki>*</nowiki> “same version number” for camlp4 as Ocaml version number<br />
<br />
<nowiki>**</nowiki> Dominique Deram, [http://dominique95880.free.fr/divers/compilgw/compilwin_gw.htm compilation under Windows XP] (jan. 2011)<br />
<br />
<br />
{{manual}}<br />
<br />
[[Category:Manual]]</div>Jefferyhttps://geneweb.tuxfamily.org/w/index.php?title=OCaml&diff=3516OCaml2019-05-04T01:59:30Z<p>Jeffery: Adding Dockerized Geneweb instructions</p>
<hr />
<div>{{DISPLAYTITLE:Installing OCaml and Camlp5 to compile GeneWeb}}<br />
{{languages|OCaml}}<br />
{{toc right}}<br />
Compiling GeneWeb requires the '''installation of [http://ocaml.org/ OCaml] and [http://camlp5.gforge.inria.fr/ Camlp5]'''. Nowadays, the simplest method is to install them through [http://opam.ocaml.org/ OPAM] (OCaml preferred package manager) that is able to manage multiple versions of OCaml on the same machine. Note that Camlp5 must be installed for each version of the compiler.<br />
<br />
Without OPAM, the old way of doing this was to install/compile OCaml and Camlp5 all by yourself.<br />
<br />
When Ocaml and camlp5 are installed, you can [[#Clone repository and compile GeneWeb|clone repository to compile GeneWeb]].<br />
<br />
Don’t forget that if your base has been built under an old version, it won't be compatible with bases built with new version: one should [[recover]] through the [[GWformat|'''.gw''' format]] to migrate from one to the other.<br />
<br />
== For GeneWeb 7 ==<br />
=== Under Linux ===<br />
This has been tested on a [https://www.debian.org/devel/debian-installer/ Debian] in March 2018 (debian-9.3.0-i386-netinst.iso).<br />
<br />
To install Opam/OCaml (4.07)/Camlp5 (7.06)<br />
<pre><br />
apt-get install opam<br />
opam init<br />
opam update<br />
opam switch 4.07.0<br />
eval `opam config env`<br />
opam install -y camlp5 cppo dune<br />
</pre><br />
<br />
If ocamlfind install fails, try installing the packages {{c|pkg-config}} or {{c|m4}} from your distribution.<br />
<br />
=== Under macOS ===<br />
This has been tested on OS X El Capitan 10.11.6 in February 2018.<br />
<br />
The best way to install Opam/OCaml is to install it with [http://brew.sh/ Homebrew], a package management software.<br />
You have to install first homebrew in a '''Terminal''' window by typing or pasting this command:<br />
<pre><br />
/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"<br />
</pre><br />
<br />
If this gives the error “Illegal variable name.”, switch to Bash.<br />
<br />
Once homebrew is installed you can easily install Opam in Terminal application with these commands:<br />
<pre><br />
brew install opam <br />
opam init<br />
opam update<br />
opam switch 4.05<br />
</pre><br />
and then OCaml:<br />
<br />
<pre><br />
opam install -y camlp5 ocamlfind<br />
eval `opam config env`<br />
</pre><br />
<br />
Before compiling GeneWeb you need to update Bash with Homebrew in a Terminal window:<br />
<pre><br />
brew install bash <br />
</pre><br />
Do not take into account the caveats about Bash path. You can now download and compile GeneWeb.<br />
<br />
=== Under Windows using Cygwin ===<br />
This has been tested on Windows 7 x64 and x86 in February 2018.<br />
<br />
If you have [https://en.wikipedia.org/wiki/Windows_PowerShell Windows Powershell] (embedded in Windows since XP SP2), this [https://gist.github.com/a2line/f134c88c80eafcf0411b38e32a0a7128 batch script] will download/compile/install Cygwin/Opam/OCaml/Camlp5/Ocamfind/GeneWeb for you. You can download the script copying this line on a Windows prompt (command line) '''with administrator rights''':<br />
<pre>powershell.exe -Command (new-object System.Net.WebClient).DownloadFile('https://gist.github.com/a2line/f134c88c80eafcf0411b38e32a0a7128/raw/','opamwin.bat')</pre><br />
<br />
Then just launch the downloaded script typing {{c|opamwin}} in the same console to install everything.<br />
<br />
Without Powershell, you have to download the batch file [https://gist.github.com/a2line/f134c88c80eafcf0411b38e32a0a7128/raw/ opamwin.bat] and the right Cygwin setup [https://www.cygwin.com/setup-x86_64.exe x64] or [https://www.cygwin.com/setup-x86.exe x86] manually. Launch the script under a prompt with administrator rights and having Cygwin setup in the same directory.<br />
<br />
== GeneWeb 6.xx with OPAM ==<br />
=== Under Linux ===<br />
[[download|Sources of GeneWeb 6.04, 6.05 and 6.08]] can be build easily with Opam switching to OCaml 3.12.1 (see [https://github.com/geneweb/geneweb/issues/435 #435]). On Debian:<br />
<pre><br />
opam switch 3.12.1<br />
eval `opam config env`<br />
opam install -y camlp5 ocamlfind<br />
</pre><br />
<br />
When using Opam on old sources, we need to replace the path to Camlp5 {{c|1=CAMLP5D=+camlp5}} in {{c|tools/Makefile.inc}} with a sed command '''after''' configuring Makefile:<br />
./configure<br />
sed -i 's|CAMLP5D=+camlp5|CAMLP5D=~/.opam/3.12.1/lib/camlp5|' tools/Makefile.inc<br />
make<br />
make distrib<br />
<br />
You can check the path to Camlp5 with {{c|camlp5 -where}} or {{c|ocamlfind query camlp5}}, for this exemple camlp5 lib is in {{c|/root/.opam/3.12.1/lib/camlp5/}}.<br />
<br />
=== Under OSX ===<br />
<br />
Apply the same process as with Linux, with the exception of the sed command:<br />
<br />
./configure<br />
sed -i .bak 's|CAMLP5D=+camlp5|CAMLP5D=~/.opam/3.12.1/lib/camlp5|' tools/Makefile.inc<br />
make<br />
make distrib<br />
<br />
=== Under Windows ===<br />
Previous chapter for Linux works for Windows under Cygwin modifying a few steps, OCaml version name is:<br />
<pre><br />
opam switch 3.12.1+mingw32<br />
</pre><br />
<br />
Using relative path or {{c|/cygdrive/…}} don’t work, we must target camlp5 lib using its full Windows path that depends of where is your home directory in Cygwin installation:<br />
<pre><br />
sed -i 's|CAMLP5D=.*|CAMLP5D=c:\\cygwin\\home\\user\\.opam\\3.12.1+mingw32\\lib\\camlp5|' tools/Makefile.inc<br />
</pre><br />
<br />
Building version 6.07 like this also works under Windows.<br />
<br />
== Clone repository and compile GeneWeb ==<br />
GeneWeb uses the version control software [https://en.wikipedia.org/wiki/Git_(software) Git]. Its repository is hosted on [https://github.com Github] at https://github.com/geneweb/geneweb. To compile GeneWeb, you need [[#top|OCaml]].<br />
<br />
git clone https://github.com/geneweb/geneweb<br />
cd geneweb<br />
./configure && make && make distrib<br />
<br />
If GeneWeb compilation fails, look at [[News#8 March 2016: Continuous integration|continuous integration tools]] to see if latest build is passing on your plateform. <br />
<br />
=== Build options ===<br />
{{c|./configure}} options:<br />
-h|--help<br />
show this help<br />
--api<br />
build the API<br />
-d|--debug<br />
add debugging symbols to the build command<br />
-i|--interactive<br />
run configure interactively<br />
-s|--static<br />
statically link libraries<br />
-we|--warn-error<br />
treat warnings as errors<br />
<br />
For example, if you want debug symbols/warnings use {{c|./configure -d -we}} then you can launch gwd adding {{c|1=OCAMLRUNPARAM=b}} to trigger the printing of a stack backtrace when an uncaught exception aborts the program.<br />
<br />
=== Build GeneWeb gui ===<br />
Since version 6.xx, an user friendly GTK gui helps managing gwd and gwsetup, it can be build with lablgtk installed.<br />
opam install lablgtk<br />
./configure<br />
make everything<br />
<br />
== Running Geneweb in a Docker container ==<br />
<br />
Download and install docker for your operating system from [https://docs.docker.com/install/ Docker].<br />
<br />
To download the latest Dockerized image of Geneweb, open your favourite terminal and execute:<br />
<br />
docker pull jeffernz/geneweb:latest<br />
<br />
The above command will download the latest Dockerized image of Geneweb<br />
<br />
To run the Geneweb docker image as a container, run:<br />
<br />
docker run -d \<br />
--name jeffernz-geneweb \<br />
-p 2316:2316 -p 2317:2317 \<br />
-v ${HOME}/GenealogyData:/usr/local/var/geneweb \<br />
jeffernz/geneweb:latest<br />
<br />
This will now launch the Geneweb portal at http://localhost:2317 and the Geneweb setup portal at http://localhost:2316<br />
<br />
To run the Geneweb portal by itself, the command is:<br />
<br />
docker run -d \<br />
--name jeffernz-geneweb \<br />
-p 2316:2316 -p 2317:2317 \<br />
-v ${HOME}/GenealogyData:/usr/local/var/geneweb \<br />
jeffernz/geneweb:latest \<br />
start-portal<br />
<br />
To run the Geneweb Setup by itself, the command is:<br />
<br />
docker run -d \<br />
--name jeffernz-geneweb \<br />
-p 2316:2316 -p 2317:2317 \<br />
-v ${HOME}/GenealogyData:/usr/local/var/geneweb \<br />
jeffernz/geneweb:latest \<br />
start-setup<br />
<br />
=== Additional running options ===<br />
<br />
We can provide additional options when you run the docker Geneweb image<br />
<br />
To run Geneweb in a different language:<br />
-e LANGUAGE=de<br />
<br />
To change the host ip-address when accessing Geneweb Setup portal<br />
-e HOST_IP=10.0.1.2<br />
<br />
=== Geneweb bases storage ===<br />
<br />
Once you run Geneweb in the dockerized container, the bases created in Geneweb will be stored under:<br />
<br />
${HOME}/GenealogyData<br />
<br />
=== Backing up the bases ===<br />
<br />
To backup your bases on a running container:<br />
<br />
docker exec -it \<br />
jeffernz-geneweb \<br />
backup.sh<br />
<br />
The backup will be stored under<br />
<br />
${HOME}/GenealogyData/backup<br />
<br />
== GeneWeb/OCaml/Camlp5 compability chart ==<br />
{| class="wikitable centre" <br />
|-<br />
! GeneWeb || Ocaml || Camlp4/5<br />
|-<br />
| 1.07-2.07 || 2.01-2.02 || p4*<br />
|-<br />
| 3.01-3.03 || 2.01-2.04 || p4*<br />
|-<br />
| 3.04-3.07 || 2.01-3.00 || p4*<br />
|-<br />
| 3.08-4.01 || 3.00 || p4*<br />
|- <br />
| 4.02 || 3.01 || p4*<br />
|-<br />
| 4.03 || 3.02 || p4*<br />
|-<br />
| 4.04-4.07 || 3.04 ||<br />
|-<br />
| 4.08-4.09 || 3.06 || p4*<br />
|-<br />
| 4.10 || 3.08 ||<br />
|-<br />
| 5.00-5.01 || ||<br />
|-<br />
| 5.02 || 3.11 || p5 6.02.1**<br />
|-<br />
| 6.00-6.08 || 3.12.1 || p5 6.04-6.16<br />
|-<br />
| 7 master || 4.02.3-4.0.7 || p5 6.13-7.07<br />
|}<br />
<nowiki>*</nowiki> “same version number” for camlp4 as Ocaml version number<br />
<br />
<nowiki>**</nowiki> Dominique Deram, [http://dominique95880.free.fr/divers/compilgw/compilwin_gw.htm compilation under Windows XP] (jan. 2011)<br />
<br />
<br />
{{manual}}<br />
<br />
[[Category:Manual]]</div>Jeffery