diff --git a/docs/install/configure.rst b/docs/install/configure.rst index 0158a6ff..0209d536 100644 --- a/docs/install/configure.rst +++ b/docs/install/configure.rst @@ -23,8 +23,13 @@ Environment Variables ===================== For the vanilla package-based setup flavor, the CrateDB startup script reads -:ref:`crate-reference:conf-env` from the ``/etc/default/crate`` file on Debian systems. -On RPM systems, the ``/etc/sysconfig/crate`` file is used. +:ref:`crate-reference:conf-env` from the ``/etc/default/crate`` file as +environment variables. + +.. Note:: + + RPM packages of CrateDB versions up to `5.2.11`_, `5.3.8`_, `5.4.7`_ + and `5.5.2`_ are using the ``/etc/sysconfig/crate`` file instead. When using the :ref:`install-adhoc` setup, or the :ref:`Microsoft Windows ` setup, the environment variables will be defined by ``bin/crate{.sh,.bat}`` relative to the @@ -50,4 +55,9 @@ Here is an example:: CRATE_USE_IPV4=true + +.. _5.2.11: https://cratedb.com/docs/crate/reference/en/latest/appendices/release-notes/5.2.11.html +.. _5.3.8: https://cratedb.com/docs/crate/reference/en/latest/appendices/release-notes/5.3.8.html +.. _5.4.7: https://cratedb.com/docs/crate/reference/en/latest/appendices/release-notes/5.4.7.html +.. _5.5.2: https://cratedb.com/docs/crate/reference/en/latest/appendices/release-notes/5.5.2.html .. _sources: https://en.wikipedia.org/wiki/Source_(command) diff --git a/docs/install/debian-ubuntu.rst b/docs/install/debian-ubuntu.rst index 6e7d2132..1183de86 100644 --- a/docs/install/debian-ubuntu.rst +++ b/docs/install/debian-ubuntu.rst @@ -59,6 +59,13 @@ Once the service is up and running, you can access CrateDB by visiting:: http://localhost:4200/ +Configure CrateDB +================= + +Please visit the :ref:`install-configure` documentation section to learn +about the location and meaning of CrateDB's configuration files. + + .. include:: _control-linux.rst .. include:: _post-install.rst diff --git a/docs/install/redhat.rst b/docs/install/redhat.rst index 7dc2411a..84d91387 100644 --- a/docs/install/redhat.rst +++ b/docs/install/redhat.rst @@ -53,6 +53,14 @@ With everything set up, you can install CrateDB:: sudo yum install crate +Configure CrateDB +================= + +Please visit the :ref:`install-configure` documentation section to learn +about the location and meaning of CrateDB's configuration files. + + + .. include:: _control-linux.rst .. include:: _post-install.rst