From b680bb206bf3e702f3f00e7c18c2e2e823fa9cf1 Mon Sep 17 00:00:00 2001 From: Alex Osborne Date: Sat, 10 Jul 2021 12:13:26 +0900 Subject: [PATCH] docs: Add subdirectory explanation from wiki install page --- docs/getting-started.rst | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/docs/getting-started.rst b/docs/getting-started.rst index cf81cbf1..ace4f762 100644 --- a/docs/getting-started.rst +++ b/docs/getting-started.rst @@ -19,6 +19,17 @@ Installation Download the latest Heritrix distribution package linked from the `Heritrix releases page `__ and unzip it somewhere. +The installation will contain the following subdirectories: + +bin + contains shell scripts/batch files for launching Heritrix. +lib + contains the third-party .jar files the Heritrix application requires to run. +conf + contains various configuration files (such as the configuration for Java logging, and pristine versions of the bundled profiles) +jobs + the default location where operator-created jobs are stored + Environment Variables ^^^^^^^^^^^^^^^^^^^^^ @@ -28,7 +39,7 @@ Environment Variables export JAVA_HOME=/usr/lib/jvm/java-11-openjdk -#. Set the ``HERITRIX_HOME`` environment variable. The value should be set to the main Heritrix directory. +#. Set the ``HERITRIX_HOME`` environment variable. The value should be set to the path where Heritrix is installed. .. code-block:: bash @@ -40,8 +51,8 @@ Environment Variables chmod u+x $HERITRIX_HOME/bin/heritrix -#. To change the amount of memory allocated to Heritrix (the Java heap size), set the ``JAVA_OPTS`` environmental -variable. The following example allocates 1GB of memory to Heritrix. +#. To change the amount of memory allocated to Heritrix (the Java heap size), set the ``JAVA_OPTS`` environment + variable. The following example allocates 1GB of memory to Heritrix. .. code-block:: bash