Skip to content

Commit 368b5b1

Browse files
committed
convert the README to markdown
1 parent 865b46e commit 368b5b1

File tree

2 files changed

+48
-84
lines changed

2 files changed

+48
-84
lines changed

README.md

+48
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# Elasticsearch Setup
2+
3+
This is a setup application for installing [Elasticsearch](https://www.elastic.co/products/elasticsearch)
4+
on a Windows machine.
5+
6+
The setup will:
7+
8+
* install all files into `Program Files` (the user can change the
9+
actual location)
10+
11+
* create the `elasticsearch` Windows account (with
12+
`Logon as service privilege`)
13+
14+
* install a Windows Service to automatically start `elasticsearch`
15+
(run as the `elasticsearch` account) at boot (but has to be manually
16+
started after install...).
17+
18+
* grant the `elasticsearch` account:
19+
* read permissions to the `config` directory.
20+
* full permissions to the `data` and `logs` directories.
21+
22+
* create a bunch of Start Menu entries (link to home page, guide, etc).
23+
24+
25+
If you need to modify any service related setting (e.g. the maximum
26+
memory used by the JVM) edit the file:
27+
28+
lib\elasticsearchw-update.cmd
29+
30+
And then run it in a Administrator Command Prompt.
31+
32+
## Silent installation
33+
34+
You can do a silent install with the `/VERYSILENT /SUPPRESSMSGBOXES` command
35+
line arguments. For more information see the `install elasticsearch` section
36+
inside the [Vagrantfile-provision.ps1](Vagrantfile-provision.ps1) file.
37+
38+
# Development
39+
40+
The setup is created inside a Vagrant environment. To create the
41+
environment install:
42+
43+
* [Vagrant](https://www.vagrantup.com/)
44+
* [VirtualBox](https://www.virtualbox.org/)
45+
* [Windows Base Box](https://github.com/rgl/windows-2016-vagrant)
46+
47+
Then run `vagrant up`. The setup executable should appear on the
48+
same directory as this README file.

README.txt

-84
This file was deleted.

0 commit comments

Comments
 (0)