You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+45-12Lines changed: 45 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,33 +17,66 @@ Anonymized data from the Diffix-protected datasets is inherently restricted. The
17
17
18
18
### Prerequisites
19
19
20
-
####Aircloak API Key
20
+
-[] Aircloak API Key
21
21
22
-
You will need an authorization key for the Aircloak API. This should be assigned to the `AIRCLOAK_API_KEY`
22
+
You will need an authorization token for the Aircloak API. This should be assigned to the `AIRCLOAK_API_KEY`
23
23
variable in your environment.
24
24
25
-
### Running
25
+
-[] Docker
26
26
27
-
The simplest way to get started is using Docker. The http api is exposed on port 5000.
27
+
Not a strict requirement, but the easiest way to get started is with [Docker](https://www.docker.com/get-started).
28
28
29
-
You will need to assign the Aircloak Api endpoint to the `AIRCLOAK_API_URL` environment variable, for example the following exposes the api on port `5000` using the Aircloak Api at `https://attack.aircloak.com/api/`:
29
+
### Docker Image from github registry
30
+
31
+
A latest release is published as a docker image in the github registry.
32
+
33
+
In order to pull from the github registry you need to authenticate with a github access token:
34
+
1. Go [here](https://github.com/settings/tokens) and create a new token with the `read:packages` permission.
35
+
2. Save it in a file, for example `github_registry_token.txt`
36
+
3. Authenticate with docker login using the generated token for your github username:
See [here](https://help.github.com/en/packages/using-github-packages-with-your-projects-ecosystem/configuring-docker-for-use-with-github-packages) for further information.
41
+
42
+
43
+
With the above out of the way, you can download and run the latest image with a single docker command.
44
+
45
+
You will need to assign the Aircloak Api endpoint to the `AIRCLOAK_API_URL` environment variable in the docker
46
+
container. For example, the following exposes the explorer api on port `5000` and targets the Aircloak Api at
47
+
`https://attack.aircloak.com/api/`:
30
48
31
49
```
32
-
docker build -t explorer .
33
-
docker run -it --rm -e AIRCLOAK_API_URL="https://attack.aircloak.com/api/" -p 5000:80 explorer
If you are running in a unix-like environment, you can use or adapt the `build.sh` and `run.sh` scripts. The following is equivalent to the above command.
56
+
57
+
### Docker build
58
+
59
+
You can also build and run the docker image locally.
60
+
61
+
As above, we need to assign the Aircloak Api endpoint to an environment variable in the container.
37
62
38
63
```
39
-
./build.sh
40
-
./run.sh https://attack.aircloak.com/api/ 5000
64
+
# 1. Clone this repo
65
+
git clone https://github.com/diffix/explorer.git
66
+
67
+
# 2. Build the docker image
68
+
docker build -t explorer explorer
69
+
70
+
# 3. Run the application in a new container
71
+
docker run -it --rm -e AIRCLOAK_API_URL="https://attack.aircloak.com/api/" -p 5000:80 explorer
41
72
```
42
73
43
-
> Note you will also need an access token for the Aircloak Api. This token is passed with the request to the `/explore` endpoint.
44
74
45
75
## Usage
46
76
77
+
> Note you will need an access token for the Aircloak Api. This token is passed as part of the request payload
78
+
> to the `/explore` endpoint.
79
+
47
80
### Launching an exploration
48
81
49
82
The explorer exposes an `/explore` endpoint that expects a `POST` request containing the dataset, table and column to analyse. Assuming you are running the explorer on `localhost:5000`:
@@ -115,7 +148,7 @@ For further examples, check out the basic [client implementations](src/clients).
115
148
116
149
The simplest way to get a development environment up and running is with VS Code's remote containers feature.
117
150
118
-
> Detailed information on setting this up can be found
151
+
> Detailed information on setting up remote containers for VS Code can be found
0 commit comments