Skip to content

Commit 93ba3b5

Browse files
[DOCS] Tidied up layout of setup docs
1 parent 3062e59 commit 93ba3b5

File tree

3 files changed

+11
-2
lines changed

3 files changed

+11
-2
lines changed

docs/reference/setup/as-a-service-win.asciidoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[[setup-service-win]]
22
== Running as a Service on Windows
33

4-
Windows users can configure Elasticsearch to run as a service to run in the background or start automatically
4+
Windows users can configure Elasticsearch to run as a service to run in the background or start automatically
55
at startup without any user interaction.
66
This can be achieved through `service.bat` script under `bin/` folder which allows one to install,
77
remove, manage or configure the service and potentially start and stop the service, all from the command-line.
@@ -47,6 +47,7 @@ The service 'elasticsearch-service-x64' has been installed.
4747
NOTE: While a JRE can be used for the Elasticsearch service, due to its use of a client VM (as oppose to a server JVM which
4848
offers better performance for long-running applications) its usage is discouraged and a warning will be issued.
4949

50+
[float]
5051
=== Customizing service settings
5152

5253
There are two ways to customize the service settings:

docs/reference/setup/as-a-service.asciidoc

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33

44
In order to run elasticsearch as a service on your operating system, the provided packages try to make it as easy as possible for you to start and stop elasticsearch during reboot and upgrades.
55

6+
[float]
67
=== Linux
78

89
Currently our build automatically creates a debian package and an RPM package, which is available on the download page. The package itself does not have any dependencies, but you have to make sure that you installed a JDK.
@@ -26,6 +27,7 @@ Each package features a configuration file, which allows you to set the followin
2627
`ES_JAVA_OPTS`:: Any additional java options you may want to apply. This may be useful, if you need to set the `node.name` property, but do not want to change the `elasticsearch.yml` configuration file, because it is distributed via a provisioning system like puppet or chef. Example: `ES_JAVA_OPTS="-Des.node.name=search-01"`
2728
`RESTART_ON_UPGRADE`:: Configure restart on package upgrade, defaults to `false`. This means you will have to restart your elasticsearch instance after installing a package manually. The reason for this is to ensure, that upgrades in a cluster do not result in a continouos shard reallocation resulting in high network traffic and reducing the response times of your cluster.
2829

30+
[float]
2931
==== Debian/Ubuntu
3032

3133
The debian package ships with everything you need as it uses standard debian tools like update `update-rc.d` to define the runlevels it runs on. The init script is placed at `/etc/init.d/elasticsearch` is you would expect it. The configuration file is placed at `/etc/default/elasticsearch`.
@@ -38,6 +40,7 @@ sudo update-rc.d elasticsearch defaults 95 10
3840
sudo /etc/init.d/elasticsearch start
3941
--------------------------------------------------
4042

43+
[float]
4144
===== Installing the oracle JDK
4245

4346
The usual recommendation is to run the Oracle JDK with elasticsearch. However Ubuntu and Debian only ship the OpenJDK due to license issues. You can easily install the oracle installer package though. In case you are missing the `add-apt-repository` command under Debian GNU/Linux, make sure have at least Debian Wheezy and the package `python-software-properties` installed
@@ -53,8 +56,10 @@ java -version
5356
The last command should verify a successful installation of the Oracle JDK.
5457

5558

56-
==== RPM based distributions
59+
[float]
60+
==== RPM based distributions
5761

62+
[float]
5863
===== Using chkconfig
5964

6065
Some RPM based distributions are using `chkconfig` to enable and disable services. The init script is located at `/etc/init.d/elasticsearch`, where as the configuration file is placed at `/etc/sysconfig/elasticsearch`. Like the debian package the RPM package is not started by default after installation, you have to do this manually by entering the following commands
@@ -66,6 +71,7 @@ sudo service elasticsearch start
6671
--------------------------------------------------
6772

6873

74+
[float]
6975
===== Using systemd
7076

7177
Distributions like SuSe do not use the `chkconfig` tool to register services, but rather `systemd` and its command `/bin/systemctl` to start and stop services (at least in newer versions, otherwise use the `chkconfig` commands above). The configuration file is also placed at `/etc/sysconfig/elasticsearch`. After installing the RPM, you have to change the systemd configuration and then start up elasticsearch

docs/reference/setup/repositories.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ We also have repositories available for APT and YUM based distributions.
66
We have split the major versions in separate urls to avoid accidental upgrades across major version.
77
For all 0.90.x releases use 0.90 as version number, for 1.0.x use 1.0, etc.
88

9+
[float]
910
=== APT
1011

1112
Download and install the Public Signing Key
@@ -25,6 +26,7 @@ deb http://packages.elasticsearch.org/elasticsearch/0.90/debian stable main
2526
Run apt-get update and the repository is ready for use.
2627

2728

29+
[float]
2830
=== YUM
2931

3032
Download and install the Public Signing Key

0 commit comments

Comments
 (0)