Add prerequisites installation guides
This commit is contained in:
6
docs/en/getting_started/prerequisites/README.md
Normal file
6
docs/en/getting_started/prerequisites/README.md
Normal file
@@ -0,0 +1,6 @@
|
||||
# Prerequisites Installation
|
||||
|
||||
## [Linux](linux.html)
|
||||
|
||||
## [macOS](macos.html)
|
||||
|
||||
95
docs/en/getting_started/prerequisites/linux.md
Normal file
95
docs/en/getting_started/prerequisites/linux.md
Normal file
@@ -0,0 +1,95 @@
|
||||
# Configuration for development and test environments (GNU/Linux)
|
||||
|
||||
## Git
|
||||
|
||||
Git is officially maintained in Debian/Ubuntu:
|
||||
|
||||
```
|
||||
sudo apt-get install git
|
||||
```
|
||||
|
||||
## Ruby
|
||||
|
||||
Ruby versions packaged in official repositories are not suitable to work with consul (at least Debian 7 and 8), so we'll have to install it manually.
|
||||
|
||||
The preferred method is via rvm:
|
||||
|
||||
(only the multi user option installs all dependencies automatically, as we use 'sudo'.)
|
||||
|
||||
### As local user
|
||||
|
||||
```
|
||||
curl -L https://get.rvm.io | bash -s stable
|
||||
```
|
||||
|
||||
### For all system users
|
||||
|
||||
```
|
||||
curl -L https://get.rvm.io | sudo bash -s stable
|
||||
```
|
||||
|
||||
and then add your user to rvm group
|
||||
|
||||
```
|
||||
sudo usermod -a -G rvm <user>
|
||||
```
|
||||
|
||||
and finally, add rvm script source to user's bash (~/.bashrc) (this step it's only necessary if you still can't execute rvm command)
|
||||
|
||||
```
|
||||
[[ -s /usr/local/rvm/scripts/rvm ]] && source /usr/local/rvm/scripts/rvm
|
||||
```
|
||||
|
||||
with all this, you are suppose to be able to install a ruby version from rvm, as for example version 2.3.0:
|
||||
|
||||
```
|
||||
sudo rvm install 2.3.0
|
||||
```
|
||||
|
||||
## Bundler
|
||||
|
||||
with
|
||||
|
||||
```
|
||||
gem install bundler
|
||||
```
|
||||
|
||||
or there is more methods [here](https://rvm.io/integration/bundler) that should be better as:
|
||||
|
||||
```
|
||||
gem install rubygems-bundler
|
||||
```
|
||||
|
||||
## PostgreSQL (>=9.4)
|
||||
|
||||
PostgreSQL version 9.4 is not official in debian 7 (wheezy), in 8 it seems to be officially maintained.
|
||||
|
||||
So you have to add a repository, the official postgresql works fine.
|
||||
|
||||
Add the repository to apt, for example creating file */etc/apt/sources.list.d/pgdg.list* with:
|
||||
|
||||
```
|
||||
deb http://apt.postgresql.org/pub/repos/apt/ wheezy-pgdg main
|
||||
```
|
||||
|
||||
afterwards you'll have to download the key, and install it, by:
|
||||
|
||||
```
|
||||
wget https://www.postgresql.org/media/keys/ACCC4CF8.asc
|
||||
apt-key add ACCC4CF8.asc
|
||||
```
|
||||
|
||||
and install postgresql
|
||||
|
||||
```
|
||||
apt-get update
|
||||
apt-get install postgresql-9.4
|
||||
```
|
||||
|
||||
## Ghostscript
|
||||
|
||||
```
|
||||
apt-get install ghostscript
|
||||
```
|
||||
|
||||
> Now you're ready to go get Consul [installed](../installation.html)!!
|
||||
107
docs/en/getting_started/prerequisites/macos.md
Normal file
107
docs/en/getting_started/prerequisites/macos.md
Normal file
@@ -0,0 +1,107 @@
|
||||
# Configuration for development and test environments (macOS)
|
||||
|
||||
## Homebrew
|
||||
|
||||
Homebrew is a very popular package manager for OS X. It's advised to use it since it makes the installation of some of the dependencies much easier.
|
||||
|
||||
You can find the installation instructions at: [brew.sh](http://brew.sh)
|
||||
|
||||
## XCode and XCode Command Line Tools
|
||||
|
||||
To install *git* you'll first need to install *Xcode* (download it from the Mac App Store) and its *Xcode Command Line Tools* (you can install them from the Xcode's app menu)
|
||||
|
||||
## Git
|
||||
|
||||
You can download git from: [git-scm.com/download/mac](https://git-scm.com/download/mac)
|
||||
|
||||
## Ruby and rbenv
|
||||
|
||||
OS X already comes with a preinstalled Ruby version, but it's quite old and we need a newer one (2.3.2). One of the multiple ways of installing Ruby in OS X is through *rbenv*. The installation instructions are in its GitHub repository and are pretty straight-forward:
|
||||
|
||||
[github.com/rbenv/rbenv](https://github.com/rbenv/rbenv)
|
||||
|
||||
## Bundler
|
||||
|
||||
```
|
||||
gem install bundler
|
||||
```
|
||||
|
||||
## PostgreSQL (>=9.4)
|
||||
|
||||
```
|
||||
brew install postgres
|
||||
```
|
||||
|
||||
Once installed, we need to *initialize* it:
|
||||
|
||||
```
|
||||
initdb /usr/local/var/postgres
|
||||
```
|
||||
|
||||
Now we're going to configure some things related to the *default user*. First we start postgres server with:
|
||||
|
||||
```
|
||||
postgres -D /usr/local/var/postgres
|
||||
```
|
||||
|
||||
At this point we're supposed to have postgres correctly installed and a default user will automatically be created (whose name will match our username). This user hasn't got a password yet.
|
||||
|
||||
If we run `psql` we'll login into the postgres console with the default user. Probably it will fail since its required that a default database exists for that user. We can create it by typing:
|
||||
|
||||
```
|
||||
createdb 'your_username'
|
||||
```
|
||||
|
||||
If we run `psql` again we should now get access to postgres console. With `\du` you can see the current users list.
|
||||
|
||||
In case you want to set a password for your user you can make it throught postgres console by:
|
||||
|
||||
```
|
||||
ALTER USER your_username WITH PASSWORD 'your_password';
|
||||
```
|
||||
|
||||
Now we'll create the *consul* user, the one the application is using. Run in postgres console:
|
||||
|
||||
```
|
||||
CREATE ROLE consul WITH PASSWORD '000';
|
||||
ALTER ROLE consul WITH SUPERUSER;
|
||||
ALTER ROLE consul WITH login;
|
||||
```
|
||||
|
||||
If at any point during PostgreSQL installation you feel you have messed things up, you can uninstall it and start again by running:
|
||||
|
||||
```
|
||||
brew uninstall postgres
|
||||
```
|
||||
|
||||
You'll have to delete also this directory (otherwise the new installation will generate conflicts, source: [gist.github.com/lxneng/741932](https://gist.github.com/lxneng/741932)):
|
||||
|
||||
```
|
||||
rm -rf /usr/local/var/postgres
|
||||
```
|
||||
|
||||
## Postgis
|
||||
|
||||
```
|
||||
brew install postgis
|
||||
```
|
||||
|
||||
## Ghostscript
|
||||
|
||||
```
|
||||
brew install ghostscript
|
||||
```
|
||||
|
||||
## PhantomJS
|
||||
|
||||
```
|
||||
brew install phantomjs
|
||||
```
|
||||
|
||||
## Imagemagick
|
||||
|
||||
```
|
||||
brew install imagemagick
|
||||
```
|
||||
|
||||
> Now you're ready to go get Consul [installed](../installation.html)!!
|
||||
Reference in New Issue
Block a user