Skip to content

Installing the module

Neriderc edited this page Jun 24, 2022 · 11 revisions

To install GVExport, go to the Releases page and download the latest release. Unzip the file, the GVExport folder into the modules_v4 directory of webtrees.

In Webtrees, go to My Pages -> Control Panel, in the Modules section go to Geneology -> Charts, then check the Enable checkbox and click Save at the bottom of the page.

You can then access GVExport from the Charts menu in webtrees. Don't forget to install GraphViz to enable JPG, PNG, PDF, etc output.

For more specific instructions, read on.

If you haven't installed webtrees yet, see the official install instructions.

Standard install through command line

Go to the Releases page and copy the download link of the latest release.

Go to your webtrees directory in the terminal, e.g. /var/www/webtrees

Go into the modules_v4 directory, creating it if it doesn't exist.

Then download the file, e.g.:

wget https://github.com/Neriderc/GVExport/archive/refs/tags/v2.1.3.tar.gz

Then extract the file:

tar -xf v2.1.3.tar.gz

Tidy up by deleting the compressed file:

rm v2.1.3.tar.gz

And rename the output folder, e.g.:

mv GVExport-2.1.3 GVExport

The module may have been enabled by default, but if not, in webtrees, go to My Pages -> Control Panel, in the Modules section go to Geneology -> Charts, then check the Enable checkbox and click Save at the bottom of the page.

You can then access GVExport from the Charts menu in webtrees.

Don't forget to install GraphViz to enable JPG, PNG, PDF, etc output.

Install from master branch through command line

You might want to test out upcoming features, or you might need bug fixes that haven't made it to a release yet. Either way, we recommend you don't use the master branch in production environments as they may not have been fully tested. However, we do recommend you test new releases before installing in production, as they may not have been fully tested :)

To install from the master branch:

Go to your webtrees directory in the terminal, e.g. /var/www/webtrees

Go into the modules_v4 directory, creating it if it doesn't exist.

Then clone the repository:

git clone https://github.com/Neriderc/GVExport.git

In Webtrees, go to My Pages -> Control Panel, in the Modules section go to Geneology -> Charts, then check the Enable checkbox and click Save at the bottom of the page.

You can then access GVExport from the Charts menu in webtrees.

Don't forget to install GraphViz to enable JPG, PNG, PDF, etc output.

Install in docker-compose

If you've used docker-compose to install webtrees (such as through this unofficial image, https://github.com/H2CK/webtrees, as webtrees doesn't provide an official one), the easiest way is to map a bind mount in your docker-compose file within the volumes section, e.g.:

volumes:
      - ./modules_v4:/var/www/webtrees/modules_v4

Then add the modules_v4 on your host and follow the above instructions. You'll need to refresh your container, i.e.: docker-compose down && docker-compose up -d

Don't forget to install GraphViz to enable JPG, PNG, PDF, etc output.