Newer
Older
## Requirements ##
We use docker and docker-compose to deploy CaosDB:
- Docker >= 18.02
- docker-compose >= 1.21
On a Debian system, you can install the requirements with:
```sh
sudo apt-get install docker.io docker-compose
```
Note, that your user account needs to be in the docker group to start a
container:
```sh
sudo usermod -aG docker $USER
```
Want to try it out? Try these steps in the root directory of this repository:
```sh
docker-compose -f compose/docker-compose.yml up
```
Once readey, you can access CaosDB with your web browser under `localhost:10443`.
You need to accept the security exception or add an SSL certificate (see below).
## Stopping CaosDB ##
You can stop the containers with CTRL-C. See the documentation of docker-compose
for other options (e.g. `-d` for detach).
## Building the image
You can build the docker image using the `docker` command in the `docker` folder:
```sh
cd docker
DOCKER_BUILDKIT=1 docker build -t caosdb .
```
The buildkit setting allows the usage of some special features in the `Dockerfile`.
The image will be named `caosdb`.
## SSL Certificates
If you want to use a valid SSL certificate (see https://gitlab.indiscale.com/caosdb/src/caosdb-server/-/blob/main/README_SETUP.md#first-setup)
you can place those in a folder named `other/cert` uncomment the sections in
the docker-compose file and adjust the path to the `other` folder.
### Bind IP
If you want your server to be accessible from other computers, you need to change
the bind ip. Adjust the compose file accordingly.
## Integration Tests
## Troubleshooting