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

DOC: added docs on how to add further configuration

parent 96ee5b49
No related branches found
No related tags found
1 merge request!1F review
Pipeline #27706 failed
......@@ -18,16 +18,21 @@ container:
sudo usermod -aG docker $USER
```
It is recommended that you clone this repository such that you have the
example configuration files at hand.
## Start CaosDB ##
Once you have docker installed, you only need two configuration files: One
for the reverse proxy envoy `envoy.yml` and one that defines the docker containers that
you want to use and how they can interact `docker-compose.yml`. You can copy the
you want to use and how they can interact `docker-compose.yml`. If you did not
clone this repository before, you can copy the
`compose` folder of this repository to your computer and then run
```sh
docker-compose -f compose/docker-compose.yml up
```
This will download the images that are used which may take a couple of minutes.
Once the logs read
```
......@@ -62,6 +67,14 @@ The buildkit setting allows the usage of some special features in the `Dockerfil
The image will be named `caosdb`.
### Versions of CaosDB components
If you want to build an image with specific versions of the various CaosDB
components, you can do so by using `--build-arg` options.
For example `--build-arg MYSQLBACKEND=v4.0.0` will change the version of the
sql backend.
The following arguments are available: `MYSQLBACKEND SERVER WEBUI PYLIB ADVANCEDUSERTOOLS`.
## SSL Certificates
If you want to use SSL certificates (and in production use, you definitely should)
you need to uncomment the respective sections in `envoy.yml` and `docker-compose.yml`.
......@@ -77,17 +90,21 @@ to how to configure this correctly.
## Configuration
### The CaosDB server
You can include alternative configuration settings for the CaosDB server.
Please see the [server documentation](https://docs.indiscale.com/caosdb-server/administration/configuration.html).
TODO: Short reference as to where to specify server config; remainder in docs.indiscale.com
It is recommended to add settings in files in the `server.conf.d` folder. E.g.
`caosdb-server/conf/ext/server.conf.d/50-example.conf`
### "extroot"
Uncomment the corresponding section in the `docker-compose.yml`
TODO: Explain the meaning of the commented "path/to/other" section
### Including large data folders
Often users do not want to copy all files into CaosDB but instead want to make
whole filesystems available to the CaosDB server. This can be achieved by mounting
the corresponding filesystem into the container. You can do this by uncommenting
the volume section that bind mounts some path (that you must set) to `.../extroot`.
### Versions of CaosDB components
TODO: Do we even want to explain this? If yes, explain how to set the variables
to use, e.g., the dev branch.
### Bind IP
If you want your server to be accessible from other computers, you need to change
......
#CONTEXT_ROOT=/caosdb
......@@ -42,8 +42,12 @@ services:
target: /opt/caosdb/mnt/caosroot
# - type: bind
# read_only: true
# source: "/path/to/other"
# target: /opt/caosdb/mnt/other
# source: $PWD/caosdb-server/
# target: /opt/caosdb/mnt/caosdb-server
# - type: bind
# read_only: true
# source: /path/to/external/root/
# target: /opt/caosdb/mnt/extroot
envoy:
image: envoyproxy/envoy:v1.21-latest
......
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