Updated package installation information. Closes elastic/elasticsearch#376.

Original commit: elastic/x-pack-elasticsearch@59be16531c
This commit is contained in:
debadair 2015-08-11 12:21:51 -07:00
parent ef11bc3f05
commit dffd30d591
2 changed files with 55 additions and 47 deletions

View File

@ -21,54 +21,51 @@ For information about installing the latest Oracle JDK, see http://www.oracle.co
[[deb-rpm-install]] [[deb-rpm-install]]
=== Installing Shield on a DEB/RPM Package Installation === Installing Shield on a DEB/RPM Package Installation
If you install Elasticsearch as a package or you specify a custom configuration directory, the command line If you use the DEB/RPM packages to install Elasticsearch, by default Elasticsearch is installed in
tools require you to specify the configuration directory. On Linux systems, add the following line to your `/usr/share/elasticsearch` and the configuration files are stored in `/etc/elasticsearch`. (For the
`.profile` file: complete list of default paths, see {ref}/setup-dir-layout.html#_deb_and_rpm[Directory Layout] in
the Elasticsearch Reference.)
To install the Shield and License plugins on a DEB/RPM package installation, you need to run
`bin/plugin -i` from the `/usr/share/elasticsearch` directory with superuser permissions, and
specify the location of the configuration files by setting `-Des.path.conf`. For example:
[source,shell] [source,shell]
---------------------------------------------------------- ----------------------------------------------------------
export ES_JAVA_OPTS="-Des.path.conf=/etc/elasticsearch" cd /usr/share/elasticsearch
sudo bin/plugin -i elasticsearch/license/latest -Des.path.conf=/etc/elasticsearch
sudo bin/plugin -i elasticsearch/shield/latest -Des.path.conf=/etc/elasticsearch
---------------------------------------------------------- ----------------------------------------------------------
NOTE: When using `sudo` to run commands as a different user, the `ES_JAVA_OPTS` setting from your profile will not be NOTE: If you are using a version of Shield prior to 1.3, you also need to specify the location
available in the other user's environment. You can manually pass the environment variables to the command or you can of the configuration files when running `esusers` and `syskeygen`.
make the environment variable available by adding the following line to the `/etc/sudoers` file:
[source,shell]
----------------------------------------------------------
Defaults env_keep += "ES_JAVA_OPTS"
----------------------------------------------------------
On Windows systems, the `setx` command can be used to specify a custom configuration directory:
[source,shell]
----------------------------------------------------------
setx ES_JAVA_OPTS "-Des.path.conf=C:\config"
----------------------------------------------------------
If your server doesn't have direct Internet access, see <<offline-install,Installing Shield on Offline Machines>> for information about downloading the Shield binaries.
[float] [float]
[[offline-install]] [[offline-install]]
=== Installing Shield on Offline Machines === Installing Shield on Offline Machines
Elasticsearchs `bin/plugin` script requires direct Internet access for downloading and installing the security plugin. Elasticsearchs `bin/plugin` script requires direct Internet access to download and install the
If your server doesnt have Internet access, you can download the required binaries from the following link: License and Shield plugins. If your server doesnt have Internet access, you can manually
download and install the plugins.
[source,sh] To install Shield on a machine that doesn't have Internet access:
----------------------------------------------------
https://download.elastic.co/elasticsearch/shield/shield-1.3.0.zip
----------------------------------------------------
Transfer the compressed file to your server, then install the plugin with the `bin/plugin` script: . Manually download the appropriate License and Shield binaries:
** https://download.elastic.co/elasticsearch/license/license-latest.zip[
`https://download.elastic.co/elasticsearch/license/license-latest.zip`]
** https://download.elastic.co/elasticsearch/watcher/shield-latest.zip[
`https://download.elastic.co/elasticsearch/watcher/shield-latest.zip`]
. Transfer the zip files to the offline machine.
. Run `bin/plugin` with the `-u` option to install the plugins using the zip files. For example:
+
[source,shell] [source,shell]
---------------------------------------------------- ----------------------------------------------------------
bin/plugin install shield -u file://PATH_TO_ZIP_FILE <1> bin/plugin -i license -u file:///path/to/file/license-latest.zip <1>
---------------------------------------------------- bin/plugin -i watcher -u file:///path/to/file/shield-1.3.2.zip
<1> Absolute path to Shield plugin zip distribution file (e.g. `file:///path/to/file/shield-1.3.0.zip`, ----------------------------------------------------------
note the three slashes at the beginning) <1> Note that you must specify an absolute path to the zip file after the `file://` protocol.
[float] [float]
[[tribe-node]] [[tribe-node]]

View File

@ -62,33 +62,44 @@ information.
[[package-installation]] [[package-installation]]
=== Installing Watcher on a DEB/RPM Package Installation === Installing Watcher on a DEB/RPM Package Installation
If you use the DEB/RPM packages to install Elasticsearch, the installation process for Watcher If you use the DEB/RPM packages to install Elasticsearch, by default Elasticsearch is installed in
is slightly different. You need to install the License and Watcher plugins from the `/usr/share/elasticsearch` and the configuration files are stored in `/etc/elasticsearch`. (For the
`/usr/share/elasticsearch` directory using superuser permissions: complete list of default paths, see {ref}/setup-dir-layout.html#_deb_and_rpm[Directory Layout] in
the Elasticsearch Reference.)
To install the Watcher and License plugins on a DEB/RPM package installation, you need to run
`bin/plugin -i` from the `/usr/share/elasticsearch` directory with superuser permissions, and
specify the location of the configuration files by setting `-Des.path.conf`. For example:
[source,shell] [source,shell]
---------------------------------------------------------- ----------------------------------------------------------
cd /usr/share/elasticsearch cd /usr/share/elasticsearch
sudo bin/plugin install license sudo bin/plugin -i elasticsearch/license/latest -Des.path.conf=/etc/elasticsearch
sudo bin/plugin install watcher sudo bin/plugin -i elasticsearch/watcher/latest -Des.path.conf=/etc/elasticsearch
---------------------------------------------------------- ----------------------------------------------------------
[float] [float]
[[offline-installation]] [[offline-installation]]
=== Installing Watcher on Offline Machines === Installing Watcher on Offline Machines
Elasticsearchs `bin/plugin` script requires direct Internet access to download and install the
License and Watcher plugins. If your server doesnt have Internet access, you can manually
download and install the plugins.
To install Watcher on a machine that doesn't have Internet access: To install Watcher on a machine that doesn't have Internet access:
. Manually download the Watcher binaries from: . Manually download the License and Watcher binaries:
https://download.elastic.co/elasticsearch/watcher/watcher-1.0.0.zip[ ** https://download.elastic.co/elasticsearch/license/license-latest.zip[
https://download.elastic.co/elasticsearch/watcher/watcher-1.0.0.zip]. https://download.elastic.co/elasticsearch/license/license-latest.zip]
** https://download.elastic.co/elasticsearch/watcher/watcher-latest.zip[
https://download.elastic.co/elasticsearch/watcher/watcher-latest.zip]
. Transfer the Watcher zip file to the offline machine. . Transfer the zip files to the offline machine.
. Run `bin/plugin` with the `-u` option:
. Run `bin/plugin` with the `-u` option to install the plugins using the zip files. For example:
+
[source,shell] [source,shell]
---------------------------------------------------------- ----------------------------------------------------------
bin/plugin install watcher -u file://<path_to_zip_file> bin/plugin -i license -u file:///path/to/file/license-latest.zip <1>
bin/plugin -i watcher -u file:///path/to/file/watcher-1.0.1.zip
---------------------------------------------------------- ----------------------------------------------------------
<1> Note that you must specify an absolute path to the zip file after the `file://` protocol.