lee/heritrix3
1
0
Fork 0
mirror of https://github.com/internetarchive/heritrix3.git synced 2026-09-23 14:15:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Add subdirectory explanation from wiki install page

Browse Source
This commit is contained in:
Alex Osborne
2021-07-10 12:13:26 +09:00
parent a84e0bb792
commit b680bb206b
1 changed files with 14 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/getting-started.rst
+14 -3
View File
@@ -19,6 +19,17 @@ Installation
Download the latest Heritrix distribution package linked from the `Heritrix releases page
<https://github.com/internetarchive/heritrix3/releases>`__ 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