With the docker image provided, Kitodo.Production can be started in no time at all. A MySQL/MariaDB database and ElasticSearch must be present to start the application. There is also a docker-compose file for a quick start.
Install Docker Engine https://docs.docker.com/get-docker/
Install Docker Compose https://docs.docker.com/compose/install/
Go to the directory where you've put docker-compose.yml.
The builder use a release or git repository archive as source to generate build resources for docker image.
First you have to decide what source do you prefer.
Release files will be downloaded, renamed and moved to build resource folder.
Archive with specified commit / branch and source url will be downloaded. Next builder triggers maven to build sources, creates database and migrate database using flyway migration steps. After build resource files will be renamed and moved to build resource folder.
docker-compose -f ./docker-compose.yml -f ./docker-compose-builder.yml up --build kitodo-builder
| Name | Default | Description |
|---|---|---|
| APP_BUILD_CONTEXT | . | Directory of Dockerfile-Builder |
| APP_BUILD_RESOURCES | build-resources | Directory of build resource results for application |
| BUILDER_TYPE | RELEASE | available types RELEASE and GIT - RELEASE means build the build resources by a Kitodo.Production Release and its assets - GIT means build the build resources by commit/branch and |
| BUILDER_RELEASE_VERSION | 3.4.2 | Release version name |
| BUILDER_RELEASE_WAR_NAME | kitodo-3.4.2 | Release asset war file name |
| BUILDER_RELEASE_SQL_NAME | kitodo_3-4-2 | Release assets sql file name |
| BUILDER_RELEASE_CONFIG_MODULES_NAME | kitodo_3-4-2_config_modules | Release asset config modules zip file name |
| BUILDER_GIT_COMMIT | master | Branch or commit of BUILDER_GIT_SOURCE_URL |
| BUILDER_GIT_SOURCE_URL | https://github.com/kitodo/kitodo-production/ | Repository of BUILDER_GIT_COMMIT |
| DB_PORT | 3306 | Port of database |
| DB_ROOT_PASSWORD | 1234 | Root password |
| DB_NAME | kitodo | Database name of Kitodo.Production |
| DB_USER | kitodo | User of DB_NAME |
| DB_USER_PASSWORD | kitodo | Password of DB_USER |
The image contains the WAR, the database file and the config modules of the corresponding release for the Docker image tag.
docker pull markusweigelt/kitodo-production:TAG
After the container has been started Kitodo.Production can be reached at http://localhost:8080/kitodo with initial credentials username "testadmin" and password "test".
| Name | Default | Description |
|---|---|---|
| KITODO_DB_HOST | localhost | Host of MySQL or MariaDB database |
| KITODO_DB_PORT | 3306 | Port of MySQL or MariaDB database |
| KITODO_DB_NAME | kitodo | Name of database used by Kitodo.Productions |
| KITODO_DB_USER | kitodo | Username to access database |
| KITODO_DB_PASSWORD | kitodo | Password used by username to access database |
| KITODO_ES_HOST | localhost | Host of Elasticsearch |
| KITODO_MQ_HOST | localhost | Host of Active MQ |
| KITODO_MQ_PORT | 61616 | Port of Active MQ |
| Name | Path | Description |
|---|---|---|
| Config Modules | /usr/local/kitodo | If the directory is mounted or bind per volume and is empty, then it will be prefilled with the provided config modules of the release. |
If the database is still empty, it will be initialized with the database script from the release.
Install Docker Engine https://docs.docker.com/get-docker/
Install Docker Compose https://docs.docker.com/compose/install/
Go to the directory where you've put docker-compose.yml.
docker-compose up -d
docker-compose stop
docker-compose logs -f
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent