Skip to content

Commit

Permalink
[doc] Improve docker-compose instruction
Browse files Browse the repository at this point in the history
This code improves the instruction to run grimoirelab
via the docker-compose based on the feedback of
@hispanico.

Signed-off-by: Valerio Cosentino <valcos@bitergia.com>
  • Loading branch information
valeriocos authored and jgbarah committed Oct 20, 2019
1 parent f0246af commit b535e76
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Expand Up @@ -55,7 +55,7 @@ foo@bar:~/grimoirelab $ docker run -p 127.0.0.1:5601:5601 \

More details in the [docker folder](./docker/README.md).

Your dashboard will be ready after a while in `https://localhost:5601`
Your dashboard will be ready after a while in `http://localhost:5601`

# GrimoireLab components

Expand Down
12 changes: 12 additions & 0 deletions docker-compose/README.md
Expand Up @@ -34,10 +34,22 @@ memory in the system, and to estimate file space usage, respectively.

You should ensure [enough virtual memory for Elasticsearch](https://www.elastic.co/guide/en/elasticsearch/reference/current/vm-max-map-count.html)
(one of GrimoireLab components). You can do it running the following command as `root` in Linux or as administrator user in MacOS:

## Linux
```console
sysctl -w vm.max_map_count=262144
```

## Mac
```
$ screen ~/Library/Containers/com.docker.docker/Data/vms/0/tty
(then run:) sysctl -w vm.max_map_count=262144
```

Remember also to assign proper resources to Docker through the UI. 8GB Memory and 2GB Swap should work.

![](./mac-docker-configuration.png)

# Getting started in 3 steps

1. Clone this project:
Expand Down
Binary file added docker-compose/mac-docker-configuration.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit b535e76

Please sign in to comment.