Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
C
CaosDB Docker
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Iterations
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Locked files
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package Registry
Container Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Code review analytics
Issue analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
This is an archived project. Repository and other project resources are read-only.
Show more breadcrumbs
caosdb
Software
CaosDB Docker
Commits
96ee5b49
Commit
96ee5b49
authored
2 years ago
by
Florian Spreckelsen
Browse files
Options
Downloads
Patches
Plain Diff
DOC: Add Todos to README_SETUP
parent
ccff0585
No related branches found
Branches containing commit
No related tags found
1 merge request
!1
F review
Pipeline
#27705
failed
2 years ago
Stage: info
Stage: setup
Stage: unittest
Stage: build
Changes
1
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
README_SETUP.md
+28
-3
28 additions, 3 deletions
README_SETUP.md
with
28 additions
and
3 deletions
README_SETUP.md
+
28
−
3
View file @
96ee5b49
...
...
@@ -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
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
```
sh
docker-compose
-f
compose/docker-compose.yml up
```
Once the logs read
```
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 org.caosdb.server.CaosDBServer application
```
the server is ready and you can access CaosDB with your web browser under
`localhost:8081`
.
## Stopping CaosDB ##
...
...
@@ -44,11 +48,16 @@ across restarts.
## 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
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`
.
...
...
@@ -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
`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
with
`openssl rsa -in oldKey.pem -out newKey.key`
.
It is assumed that
`caosdb.key.pem`
does not have a passphrase. You can remove
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
### 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
If you want your server to be accessible from other computers, you need to change
the bind ip. Adjust the compose file accordingly.
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment