Skip to content
Snippets Groups Projects
Commit 96ee5b49 authored by Florian Spreckelsen's avatar Florian Spreckelsen
Browse files

DOC: Add Todos to README_SETUP

parent ccff0585
No related branches found
No related tags found
1 merge request!1F review
Pipeline #27705 failed
...@@ -23,15 +23,19 @@ Once you have docker installed, you only need two configuration files: One ...@@ -23,15 +23,19 @@ 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 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`. You can copy the
`compose` folder of this repository to your computer and then run `compose` folder of this repository to your computer and then run
```sh ```sh
docker-compose -f compose/docker-compose.yml up docker-compose -f compose/docker-compose.yml up
``` ```
Once the logs read Once the logs read
``` ```
caosdb-server_1 | Starting the Jetty [HTTPS/1.1] server on port 10443 caosdb-server_1 | Starting the Jetty [HTTPS/1.1] server on port 10443
caosdb-server_1 | Starting the Jetty [HTTP/1.1] server on port 10080 caosdb-server_1 | Starting the Jetty [HTTP/1.1] server on port 10080
caosdb-server_1 | Starting org.caosdb.server.CaosDBServer application caosdb-server_1 | Starting org.caosdb.server.CaosDBServer application
``` ```
the server is ready and you can access CaosDB with your web browser under `localhost:8081`. the server is ready and you can access CaosDB with your web browser under `localhost:8081`.
## Stopping CaosDB ## ## Stopping CaosDB ##
...@@ -44,11 +48,16 @@ across restarts. ...@@ -44,11 +48,16 @@ across restarts.
## Building the image ## Building the image
You can build the docker image using the `docker` command in the `docker` folder:
If you don't want to use the prebuilt image, e.g., because you changed something
in the Dockerfile, you can build the docker image yourself using the `docker`
command in the `docker` folder:
```sh ```sh
cd docker cd docker
DOCKER_BUILDKIT=1 docker build -t caosdb . DOCKER_BUILDKIT=1 docker build -t caosdb .
``` ```
The buildkit setting allows the usage of some special features in the `Dockerfile`. The buildkit setting allows the usage of some special features in the `Dockerfile`.
The image will be named `caosdb`. The image will be named `caosdb`.
...@@ -59,11 +68,27 @@ you need to uncomment the respective sections in `envoy.yml` and `docker-compose ...@@ -59,11 +68,27 @@ you need to uncomment the respective sections in `envoy.yml` and `docker-compose
The given configuration assumes, that the certificate files are placed in a folder The given configuration assumes, that the certificate files are placed in a folder
`compose/certs` and named `caosdb.key.pem` and `caosdb.cert.pem`. `compose/certs` and named `caosdb.key.pem` and `caosdb.cert.pem`.
It is assumed, that `caosdb.key.pem` does not have a passphrase. You can remove one It is assumed that `caosdb.key.pem` does not have a passphrase. You can remove
with `openssl rsa -in oldKey.pem -out newKey.key`. one with `openssl rsa -in oldKey.pem -out newKey.key`. If you want to use a
certificate with a passphrase instead, please refer to envoy's documentation as
to how to configure this correctly.
## Configuration ## Configuration
### The CaosDB server
TODO: Short reference as to where to specify server config; remainder in docs.indiscale.com
### "extroot"
TODO: Explain the meaning of the commented "path/to/other" section
### 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 ### Bind IP
If you want your server to be accessible from other computers, you need to change If you want your server to be accessible from other computers, you need to change
the bind ip. Adjust the compose file accordingly. the bind ip. Adjust the compose file accordingly.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment