Skip to content

Commit

Permalink
Update REMP README file
Browse files Browse the repository at this point in the history
- Details about first run.
- Useless visual changes.

remp/remp#187
  • Loading branch information
markoph committed Mar 1, 2018
1 parent 07533fa commit 9bdd168
Showing 1 changed file with 23 additions and 9 deletions.
32 changes: 23 additions & 9 deletions README.md
Expand Up @@ -10,8 +10,7 @@ See separate documentations of each app:

## Install


**1. Pre-building binaries of Go apps**
#### 1. Pre-building binaries of Go apps

There's a need for pre-building binaries of Go apps before you can run Docker compose. You don't need Go environment
to have set up, but you need Docker to build docker-ready tarballs properly.
Expand All @@ -20,13 +19,26 @@ to have set up, but you need Docker to build docker-ready tarballs properly.
make docker-build
```

**2. Docker-compose**
#### 2. Docker-compose

We've prepared `docker-compose.yml` in a way it's ready for development.
```bash
docker-compose up
```

> The appliance was tested with Docker CE 17.12.0 and Docker Compose 1.16.1.
#### 3. First run

If some of the application doesn't have `.env` file, docker will assume it's not installed and it will automatically proceed with all required steps to install project. It will:
* create `.env` file,
* install all the dependencies _(composer & yarn)_,
* prepare the DB structure and insert demo data.

You can see what is installed in [Docker/php/remp.sh](Docker/php/remp.sh).

#### 4. Override services & enviroment settings

Feel free to override/add services via `docker-compose.override.yml`.

This is an excerpt of override we use. It handles proper connection of XDebug to host machine, exposing services
Expand Down Expand Up @@ -55,6 +67,10 @@ services:

```

You can also override enviroment variables in `.env` file of each project. After [first run](#3-first-run) this file contains default values _(copy of `.env.example`)_.

#### 5. Hosts

Application exposes all services via Nginx container.
Following is list of available hosts. We advise you to add them to your
`/etc/hosts`:
Expand All @@ -80,21 +96,19 @@ Following is list of available hosts. We advise you to add them to your
127.0.0.1 grafana.beam.remp.press # grafana for manipulating with InfluxDB and displaying charts
```

Note: If you use Docker Toolbox, the IP won't be `127.0.0.1`. Use `docker-machine ls` to get IP address of the machine.

Docker will install all the dependencies, prepares the DB structure and also inserts demo data.

The appliance was tested with Docker CE 17.12.0 and Docker Compose 1.16.1.
> Note: If you use Docker Toolbox, the IP won't be `127.0.0.1`. Use `docker-machine ls` to get IP address of the machine.
## Manual installation

Please use `docker-compose.yml` and configuration/scripts within [Docker](./Docker) folder as a reference for manual
installation of each service.

Steps to install dependencies of each project are part of README file for that particular service.

Be aware of `.env.example` files across projects. These need to be copied to `.env` and configured based on your
configuration.

### Docker Compose
## Docker Compose

If you're unfamiliar with `docker-compose`, try running `docker-compose --help` as a starter. Each of the subcommands
of Docker also supports its own `--help` switch. Feel free to explore it.
Expand Down

0 comments on commit 9bdd168

Please sign in to comment.