Skip to content
Snippets Groups Projects
Commit 4debadf2 authored by Henrik tom Wörden's avatar Henrik tom Wörden
Browse files

DOC: mainly documentation

parent 43bcf602
No related branches found
No related tags found
No related merge requests found
Pipeline #27683 passed
# Installation using the git repository #
## Requirements ##
The following packages are needed by LinkAhead.
- 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
sudo usermod -aG docker $USER
```
## Start
# Getting Started #
See [docs](docs.indiscale.com) or `INSTALL-GIT.md` for information on how to install LinkAhead.
## 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
```
## Start CaosDB ##
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).
Want to try it out? Try these steps:
## Building the image
You can build the docker image using the `docker` command in the `docker` folder:
......@@ -16,10 +41,16 @@ The buildkit setting allows the usage of some special features in the `Dockerfil
The image will be named `caosdb`.
## Certificates
## 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.
## Configuration
### 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
......
......@@ -12,13 +12,14 @@ services:
networks:
- caosnet
caosdb-server:
image: "caosdb/caosdb:0.0.8"
image: "caosdb/caosdb:0.9.0"
depends_on:
- sqldb
networks:
- caosnet
ports:
- 10443:10443
# first part is the bind ip; adjust apropriately, 0.0.0.0 as wild card
- 127.0.0.1:10443:10443
# Pass information to the running docker ontainer.
# These variables should be set when calling docker-compose.
environment:
......@@ -42,6 +43,10 @@ services:
- type: volume
source: "caosdb-caosroot"
target: /opt/caosdb/mnt/caosroot
# - type: bind
# read_only: true
# source: "/path/to/other"
# target: /opt/caosdb/mnt/other
# A well-defined network for caosdb
volumes:
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment