Skip to content

Installing the module

Neriderc edited this page Feb 18, 2023 · 11 revisions

To install GVExport, go to the Releases page and download the latest release. Unzip the file, copy the GVExport folder into the modules_v4 directory of webtrees, and rename to remove the version number from the end (webtrees ignores modules with a dot in the folder name).

Modules are generally automatically enabled, but if not, in Webtrees go to My Pages -> Control Panel, in the Modules section go to Genealogy -> 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. If possible, install Graphviz to enable server-side rendering which is more reliable and can handle larger diagrams.

For more specific instructions, read on.

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

If GVExport isn't working, see Troubleshooting.

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.17.tar.gz

Then extract the file:

tar -xf v2.1.17.tar.gz

Tidy up by deleting the compressed file:

rm v2.1.17.tar.gz

And rename the output folder (important because webtrees ignores modules with a '.' in the name), e.g.:

`mv GVExport-2.1.17 GVExport

The module should 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 server-side rendering and add more possible file outputs.

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 unless you need a fix that hasn't yet made it into a release.

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

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 server-side rendering and add more possible file outputs.

Install in docker-compose

If you've used docker-compose to install webtrees (such as through this unofficial image, or this one, 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 server-side rendering and add more possible file outputs.