Commit caae1540 authored by benedikt.kroening's avatar benedikt.kroening
Browse files

updated readme

parent 2f3cbe13
......@@ -19,9 +19,22 @@ In case of creating your own environment you have to manually call `config/envir
### Docker configuration
The docker configuration is located at `docker/<env>/config` and will override values from the above default config.
The docker configuration is located at `docker/config` and will override values from the above default config.
You may also override config by providing environmental variables.
There are some additional configuration variable used for docker-compose which are located at the repositories root (`.env`). These variables include:
- `OX_VERSION` - This is used when building the images. Every built image will be tagged with this String (e.g. 7.10.3)
- `OX_BASE_DISTRIBUTION` - The linux distribution to be used inside the docker images. Every used image is based on this (ox-base, this iamge gets tagged as well)
- `OX_BASE_RELEASE` - The distributions release (e.g. Stretch or buster)
- `OX_RUNTIME_DATA_PATH` - The location where docker-compose will store its data. This location is by default unter `docker/.runtime` but its recommended to put this outside of the git repo.
The docker-compose environment is able to persist its data across restarts and recreations. Everytime a container gets recreated it fetches the required configuration from the consul. This includes databases IDs, oxguardpass and some flags used for determining the current clusters init state.
*IMPORTANT:* Recreating frontend or middleware nodes works without caution. For the database you have to ensure a gracefull shutdown (or enable the periodic database dump).
To shut it down properly execute: `docker-compose down -v`
You can use consul to observe the init process when starting the environment. In addition to that you can use it to rudimentary monitor the services health.
It is located at `http://localhost:8500`
## Versions
Versions can be configured at `setup/versions`
......@@ -65,11 +78,9 @@ Take a look at the features/ direcotry for the feature related scripts. These sc
#### Guard
To enable / install guard on a node simply execute:
` $ features/guard.sh --install --enable `
` $ features/guard.sh --install --singlenode --enable `
If you are using the docker environment you can enable guard by executing the installer inside the running container:
` $ docker-compose exec singlenode bash -c "/ox-installer/features/guard.sh --install --enable" `
In an cluster environment you have to take care of the frontend and middleware node seperately.
#### additional features
Take a look into the 'features' folder. You may enable/disable additional featues by executing those scripts.
......@@ -85,13 +96,14 @@ Take a look at the docker-compose.yml at the root level of this repo.
### Build docker images
The installer script can be used as it is for docker environments. Take a look into the docker/ directory for some examples.
You can configure these environments by editing the `docker/<env>/config` file (e.g. docker/singlenode/config).
The singlenode image can be build by executing docker-composes build action:
You can configure these environments by editing the `docker/config` file.
The images can be build by executing docker-composes build action:
`$ docker-compose build `
This will automatically install OX App Suite, Guard, Documents (including documents collaboration) and the documentconverter server.
The image will be tagged with the `latest` tag on each rebuild...
This will automatically install OX App Suite, Guard (documents with its several features will be added soon, this is wip).
The image will be tagged with the `OX_VERSION` tag (located at `.env`) on each rebuild...
### Start it
......@@ -100,7 +112,7 @@ If you have docker-compose available you can use it to start the provided compos
`$ docker-compose up`
Any runtime related files will be stored at `<repo>/docker/<env>/.runtime` (e.g. <repo>/docker/singlenode/.runtime)
Any runtime related files will be stored at `<repo>/docker/.runtime`
### Stop it
......@@ -108,4 +120,4 @@ Any runtime related files will be stored at `<repo>/docker/<env>/.runtime` (e.g.
### Clean it up
`$ rm -fr docker/<env>/.runtime/`
`$ rm -fr docker/.runtime/`
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment