Files
concrete/docs/user/howto/INSTALLING.md
aquint-zama 14d7c505d8 docs: add admonitions, fixes, and nbsphinx syntax color
# Conflicts:
#	docs/user/advanced_examples/QuantizedLinearRegression.ipynb
#	docs/user/advanced_examples/QuantizedLogisticRegression.ipynb
2021-09-17 14:57:36 +02:00

40 lines
1.2 KiB
Markdown

# Installing
## Docker image
```{note}
Currently the project is only available as a docker image. To get the image you need to login to ghcr.io with docker.
```
```shell
docker login ghcr.io
```
This command will ask for a username and a password. For username, just enter your GitHub username. For password, you should create a personal access token from [here](https://github.com/settings/tokens) selecting `read:packages` permission. Just paste the generated access token as your password, and you are good to go.
You can then either pull the latest docker image or a specific version:
```shell
docker pull ghcr.io/zama-ai/concretefhe:latest
# or
docker pull ghcr.io/zama-ai/concretefhe:v0.1.0
```
You can then use this image with the following command:
```shell
# Without local volume:
docker run --rm -it -p 8888:8888 ghcr.io/zama-ai/concretefhe:v0.1.0
# With local volume to save notebooks on host:
docker run --rm -it -p 8888:8888 -v /host/path:/data ghcr.io/zama-ai/concretefhe:v0.1.0
```
This will launch a **Concrete** enabled jupyter server in the docker, that you can access from your browser.
Alternatively you can just open a shell in the docker:
```shell
docker run --rm -it ghcr.io/zama-ai/concretefhe:v0.1.0 /bin/bash
```