Skip to content

Commit

Permalink
refactoring dev setup doc
Browse files Browse the repository at this point in the history
  • Loading branch information
pnu-s committed Oct 18, 2018
1 parent 891155a commit 8a128fd
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 28 deletions.
37 changes: 9 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,17 @@
# εxodus
**εxodus** is a privacy auditing platform for Android applications. It detects behaviors which can be
dangerous for user privacy like ads, tracking, analytics, …
**εxodus** is a privacy auditing platform for Android applications. It detects behaviors which can be
dangerous for user privacy like ads, tracking, analytics, …

The official instance of εxodus is available [here](https://reports.exodus-privacy.eu.org/).

# Development environment

## Docker

Run dependencies:

```
docker-compose up -d
```

Run εxodus container:

```
docker-compose -f docker-compose.run.yml up -d
```

Create database, user and import trackers:
```
docker exec -it <εxodus_container> /entrypoint.sh "create-db"
docker exec -it <εxodus_container> /entrypoint.sh "create-user"
docker exec -it <εxodus_container> /entrypoint.sh "import-trackers"
```
You have 3 different ways of setting up your development environment (Docker, Vagrant or manual).
Check the [FAQ](doc/faq.md) if you encounter problem.

Run worker and frontend:
```
docker exec -it <εxodus_container> /entrypoint.sh "start-worker"
docker exec -it <εxodus_container> /entrypoint.sh "start-frontend"
```
## Docker

Follow the [Docker setup](doc/docker.md) guide.

## Vagrant

Expand All @@ -44,7 +23,9 @@ vagrant up

Now, you can [make a tea](https://wiki.laquadrature.net/TeaHouse).

Or you can follow the [step by step installation](doc/install.md) guide. Check the [FAQ](doc/faq.md) if you encounter problem.
## Manual installation

Follow the [step by step installation](doc/install.md) guide.

# Analyse an application

Expand Down
24 changes: 24 additions & 0 deletions doc/docker.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Docker setup

Run dependencies:
```
docker-compose up -d
```

Run εxodus container:
```
docker-compose -f docker-compose.run.yml up -d
```

Create database, user and import trackers:
```
docker exec -it <εxodus_container> /entrypoint.sh "create-db"
docker exec -it <εxodus_container> /entrypoint.sh "create-user"
docker exec -it <εxodus_container> /entrypoint.sh "import-trackers"
```

Run worker and frontend:
```
docker exec -it <εxodus_container> /entrypoint.sh "start-worker"
docker exec -it <εxodus_container> /entrypoint.sh "start-frontend"
```

0 comments on commit 8a128fd

Please sign in to comment.