Skip to content

Commit

Permalink
documentation update
Browse files Browse the repository at this point in the history
  • Loading branch information
cjimti committed May 12, 2019
1 parent 8983d36 commit ffe400c
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 5 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

[Query] TXN2 data by [Account], [Model] and index pattern. Save a [Query] and execute a saved [Query].

![query data flow](./assets/flow.png)
![query data flow](https://github.com/txn2/query/blob/master/assets/flow.png?raw=true)

## Configuration

Expand All @@ -31,7 +31,7 @@ following configuration is specific to **query**:

## Local Development

The project includes a Docker Compose file with [Elasticsearch], [Logstash], [Kibana], [Cerebro], [txn2/rxtx], [txn2/rtbeat] and [txn2/tm]:
The project includes a [docker-compose.yml] file with [Elasticsearch], [Logstash], [Kibana], [Cerebro], [txn2/rxtx], [txn2/rtbeat], [txn2/provision] and [txn2/tm]:
```bash
docker-compose up
```
Expand Down Expand Up @@ -87,7 +87,7 @@ Get a user [Token] from [txn2/provision] with the [User]'s id and password:
TOKEN=$(curl -s -X POST \
http://localhost:8070/authUser?raw=true \
-d '{
"id": "test_user",
"id": "test",
"password": "eWidL7UtiWJABHgn8WA"
}') && echo $TOKEN
```
Expand Down Expand Up @@ -227,6 +227,7 @@ curl -X GET \
[Kibana]: https://www.elastic.co/products/kibana
[Cerebro]: https://github.com/lmenezes/cerebro
[Logstash]: https://www.elastic.co/products/logstash
[docker-compose.yml]: docker-compose.yml

## Release Packaging

Expand Down
Binary file modified assets/flow.graffle
Binary file not shown.
Binary file modified assets/flow.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,8 @@ services:
- PORT=8070
- TOKEN_EXP=1440
- TOKEN_KEY=somegoodkey
- AGENT="DockerCompose"
- SERVICE_ENV="local"
- AGENT=DockerCompose
- SERVICE_ENV=local
ports:
- "8070:8070"
networks:
Expand Down

0 comments on commit ffe400c

Please sign in to comment.