Skip to content
Permalink
Browse files

Update README.md

  • Loading branch information...
DonWillems committed Mar 12, 2019
1 parent 073c3cb commit 2b8f76ee10956afe25e40722ac99e2db0e873e7d
Showing with 32 additions and 12 deletions.
  1. +32 −12 README.md
@@ -8,29 +8,39 @@ If you want to try OpenRemote v2, [read the OpenRemote v2 documentation](https:/

## Quickstart

Checkout this project and ensure you have [Docker Community Edition](https://www.docker.com/) installed, then either use images from Docker Hub (easiest) or build the images locally first.
Before following this quickstart make sure you have [prepared your environment](https://github.com/openremote/openremote/wiki/Developer-Guide%3A-Preparing-the-environment). There are 2 options start with OpenRemote:
1. Use the images from Docker Hub (easiest)
2. Checkout this project and build the images locally first.

***NOTE: If you are not using Docker Community Edition but the older Docker Toolbox (Virtual Box), you must specify the `IDENTITY_NETWORK_HOST` environment variable as the IP address of the Docker VM when executing `docker-compose` commands:***
### 1. Starting OpenRemote with images from Docker Hub

```
Windows Command Prompt (quotes are essential):
set "IDENTITY_NETWORK_HOST=192.168.99.100" && docker-compose ...
We publish Docker images to [Docker Hub](https://hub.docker.com/u/openremote/), please be aware that the published images may be out of date compared to this codebase. If you want to run the latest code, build the images from this source.

Bash:
IDENTITY_NETWORK_HOST=192.168.99.100 docker-compose ...
Get the images using the following commands in the designated folder:
```
docker pull openremote/postgresql
docker pull openremote/keycloak
docker pull openremote/proxy
docker pull openremote/manager
```

### Starting OpenRemote with images from Docker Hub

We publish Docker images to [Docker Hub](https://hub.docker.com/u/openremote/), please be aware that the published images may be out of date compared to this codebase. If you want to run the latest code, build the images from this source.

To run OpenRemote using Docker Hub images simply execute the following command from the checked out root project directory:

```
docker-compose up --no-build
```

### Starting OpenRemote with source-build images
***NOTE:*** If you are not using Docker Community Edition but the older **Docker Toolbox (Virtual Box),** you must specify the `IDENTITY_NETWORK_HOST` environment variable as the IP address of the Docker VM when executing `docker-compose` commands:

```
Windows Command Prompt (quotes are essential):
set "IDENTITY_NETWORK_HOST=192.168.99.100" && docker-compose up --build
Bash:
IDENTITY_NETWORK_HOST=192.168.99.100 docker-compose up --build
```

### 2. Starting OpenRemote with source-build images

Alternatively you can build the Docker images locally from source. First build the code:

@@ -44,6 +54,16 @@ Next, build the Docker images and start the stack with:
docker-compose up --build
```

***NOTE:*** If you are not using Docker Community Edition but the older **Docker Toolbox (Virtual Box),** you must specify the `IDENTITY_NETWORK_HOST` environment variable as the IP address of the Docker VM when executing `docker-compose` commands:

```
Windows Command Prompt (quotes are essential):
set "IDENTITY_NETWORK_HOST=192.168.99.100" && docker-compose up --build
Bash:
IDENTITY_NETWORK_HOST=192.168.99.100 docker-compose up --build
```

A first build will download many dependencies (and cache them locally for future builds), this can take up to 30 minutes.

### Using the OpenRemote demo

0 comments on commit 2b8f76e

Please sign in to comment.
You can’t perform that action at this time.