├── .gitignore ├── docker-compose ├── otobo-nginx-custom-config.yml ├── otobo-override-http.yml ├── otobo-selenium.yml ├── otobo-localstack.yml ├── otobo-minio.yml ├── otobo-override-db-exposed.yml ├── testing │ └── openldap.yml ├── otobo-override-https.yml ├── otobo-override-https-kerberos.yml └── otobo-base.yml ├── README.md ├── scripts ├── devel │ └── generate_sample_env_files.sh └── update.sh ├── .docker_compose_env_http ├── .docker_compose_env_http_selenium ├── .docker_compose_env_https ├── .docker_compose_env_https_custom_nginx ├── .docker_compose_env_https_selenium ├── .docker_compose_env_https_kerberos ├── etc └── templates │ └── dot_env.m4 └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | # Files created by the user 2 | .env 3 | dot_env.m4 4 | 5 | # files that might be generated during development 6 | *.out 7 | 8 | # Editor swap files 9 | *.swn 10 | *.swp 11 | *.swo 12 | *~ 13 | *.bak 14 | 15 | # temporary dir 16 | tmp 17 | -------------------------------------------------------------------------------- /docker-compose/otobo-nginx-custom-config.yml: -------------------------------------------------------------------------------- 1 | # Provide a custom nginx config. 2 | 3 | # See also README.md. 4 | 5 | version: '3.3' 6 | 7 | services: 8 | nginx: 9 | volumes: 10 | - otobo_nginx_custom_config:/etc/nginx/config/template-custom 11 | 12 | volumes: 13 | otobo_nginx_custom_config: 14 | external: true 15 | -------------------------------------------------------------------------------- /docker-compose/otobo-override-http.yml: -------------------------------------------------------------------------------- 1 | # Run the OTOBO web app via HTTP on the port $OTOBO_WEB_HTTP_PORT or port 80 per default. 2 | # The HTTP port is set up in a extension file because there are use cases that have no HTTP port exposed. 3 | 4 | # See also README.md. 5 | 6 | # most current docker-compose file version, as of 2020-05-21 7 | version: '3.3' 8 | 9 | services: 10 | 11 | web: 12 | ports: 13 | - "${OTOBO_WEB_HTTP_IPADDR:-0.0.0.0}:${OTOBO_WEB_HTTP_PORT:-80}:5000" 14 | -------------------------------------------------------------------------------- /docker-compose/otobo-selenium.yml: -------------------------------------------------------------------------------- 1 | # Run a standalone container for Selenium testing. 2 | # Access via port 4444. 3 | 4 | # See also README.md. 5 | 6 | # most current docker-compose file version, as of 2020-05-21 7 | version: '3.3' 8 | 9 | services: 10 | 11 | selenium-chrome: 12 | image: ${OTOBO_IMAGE_OTOBO_SELENIUM_CHROME:-rotheross/otobo-selenium-chrome:latest-11_0} 13 | #cap_drop: 14 | # - ALL 15 | #cap_add: 16 | # - CAP_SYS_CHROOT 17 | # - CAP_CHOWN 18 | # - CAP_DAC_OVERRIDE 19 | # - CAP_SETGID 20 | # - CAP_SETUID 21 | restart: always 22 | volumes: 23 | - /dev/shm:/dev/shm 24 | ports: 25 | - "${OTOBO_SELENIUM_VNC_CHROME:-5900}:5900" 26 | -------------------------------------------------------------------------------- /docker-compose/otobo-localstack.yml: -------------------------------------------------------------------------------- 1 | # Docker compose file for mocking AWS S3 with localstack. 2 | # This is intended only for development and for testing. 3 | 4 | # Access via port 4566 which is exposed to the Docker host. 5 | 6 | # See also README.md . 7 | # See also https://hub.docker.com/r/localstack/localstack . 8 | 9 | # same version as in otobo-base.yml 10 | version: '3.3' 11 | 12 | services: 13 | 14 | localstack: 15 | image: localstack/localstack 16 | ports: 17 | - "4566:4566" 18 | - "4571:4571" 19 | - "${PORT_WEB_UI-8080}:${PORT_WEB_UI-8080}" 20 | environment: 21 | - SERVICES=${SERVICES-s3} 22 | - DEFAULT_REGION=eu-central-1 23 | volumes: 24 | - tmp_localstack:/tmp/localstack 25 | volumes: 26 | tmp_localstack: {} 27 | -------------------------------------------------------------------------------- /docker-compose/otobo-minio.yml: -------------------------------------------------------------------------------- 1 | # Docker compose file for mocking AWS S3 with MinIO. 2 | # This is intended only for development and for testing. 3 | 4 | # Access via port 9000 which is exposed to the Docker host. 5 | 6 | # See also README.md . 7 | # See also https://hub.docker.com/r/localstack/localstack . 8 | # Ses also https://docs.min.io/docs/deploy-minio-on-docker-compose.html 9 | 10 | # same version as in otobo-base.yml 11 | version: '3.3' 12 | 13 | services: 14 | 15 | minio: 16 | image: minio/minio 17 | # ports can be exposed to the Docker as only a single minio container is running 18 | ports: 19 | - "9000:9000" 20 | - "9001:9001" 21 | restart: always 22 | volumes: 23 | - minio_data:/data 24 | command: server --console-address ":9001" /data 25 | 26 | # no volumes need to be exposed across services 27 | volumes: 28 | minio_data: {} 29 | -------------------------------------------------------------------------------- /docker-compose/otobo-override-db-exposed.yml: -------------------------------------------------------------------------------- 1 | # This exposes the database port and adds SSL certificates used by nginx. 2 | # Hence, requires a working HTTPS setup with otobo-override-https*.yml. 3 | # The db user has UID 999. Make sure the cert and key are readable for this user. 4 | # 5 | # WARNING: Currently the db users root and otobo are allowed to login 6 | # from every host. We strongly suggest to limit this option. 7 | 8 | services: 9 | db: 10 | volumes: 11 | - otobo_nginx_ssl:/etc/nginx/ssl 12 | ports: 13 | - "${OTOBO_DB_EXPOSED_PORT:-3306}:3306" 14 | command: --max-allowed-packet=136314880 --character-set-server=utf8mb4 --collation-server=utf8mb4_unicode_ci --innodb-log-file-size=268435456 --query-cache-size=${OTOBO_DB_QUERY_CACHE_SIZE:-33554432} --ssl-key=${OTOBO_NGINX_SSL_CERTIFICATE_KEY:?err} --ssl_cert=${OTOBO_NGINX_SSL_CERTIFICATE:?err} --max-password-errors=50 15 | -------------------------------------------------------------------------------- /docker-compose/testing/openldap.yml: -------------------------------------------------------------------------------- 1 | # Run a standalone container for OpenLDAP testing. 2 | 3 | # There is no persistent data 4 | 5 | # Can be activated by appending the path to this file to the setting COMPOSE_FILE 6 | # in the setup file .env. 7 | 8 | # The ports are exposed. On the Docker host the tree can be dumped with: 9 | 10 | # Examples for querying LDAP: 11 | 12 | #ldapsearch -x -b "dc=otobotesting" -H ldap://localhost:1389 13 | 14 | # check connectivity 15 | #ldapsearch -x -H ldap://localhost:1389 -b dc=otobotesting -D "dc=otobotesting" -w password 16 | 17 | # list all entries 18 | #ldapsearch -x -H ldap://localhost:1389 -b dc=otobotesting -s sub -D "cn=openldap_admin,dc=otobotesting" -w password '(objectClass=*)' + 19 | 20 | # show a group 21 | #ldapsearch -x -H ldap://localhost:1389 -b dc=otobotesting -s sub -D "cn=openldap_admin,dc=otobotesting" -w password '(cn=admins)' dn member 22 | 23 | # show a user 24 | #ldapsearch -x -H ldap://localhost:1389 -b dc=otobotesting -s sub -D "cn=openldap_admin,dc=otobotesting" -w password '(uid=testadmin)' uid memberOf 25 | 26 | services: 27 | 28 | testing-openldap: 29 | image: bitnamilegacy/openldap:latest 30 | ports: 31 | - 1389:1389 32 | - 1636:1636 33 | environment: 34 | - LDAP_ADMIN_USERNAME=openldap_admin 35 | - LDAP_ADMIN_PASSWORD=openldap_admin 36 | - LDAP_USERS=otobotestuser1,otobotestuser2 37 | - LDAP_PASSWORDS=otobotestuser1,otobotestuser2 38 | - LDAP_ROOT=dc=otobotesting 39 | - LDAP_USER_OU=agents 40 | - LDAP_GROUP_OU=agent_groups 41 | - LDAP_LOGLEVEL=any 42 | restart: always 43 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | OTOBO comes with official support for Docker. 2 | 3 | The chapter "Installing using Docker and Docker Compose" in the "Installation and Update" manual 4 | has more information on how the get started. 5 | See https://doc.otobo.org/manual/installation/11.0/en/content/installation-docker.html. 6 | 7 | Here is quick overview over the files in this distribution. Note that some of the files are hidden 8 | and are only listed with ls -a. 9 | 10 | - .docker_compose_env_http sample .env file for a HTTP based installation 11 | - .docker_compose_env_https sample .env file for a HTTPS based installation 12 | - .docker_compose_env_https_custom_nginx sample .env file for a HTTPS based installation with custom Nginx config 13 | - .docker_compose_env_https_kerberos sample .env file for a HTTPS based installation with support for Kerberos 14 | - .docker_compose_env_http_selenium sample .env file for development, support Selenium testing via HTTP 15 | - .docker_compose_env_https_selenium sample .env file for development, support Selenium testing via HTTPS 16 | - .env Docker Compose environment file, must be created by the user 17 | - docker-compose directory with Docker Compose configuration snippets 18 | - etc/templates/dot_env.m4 template file used by create_sample_env_files.sh 19 | - scripts/devel/create_sample_env_files.sh a small helper for creating the sample env files 20 | - scripts/devel/generate_dot_env.sh a small helper for recreating .env from dot_env.m4 21 | - scripts/update.sh a small helper for updating to updated images 22 | -------------------------------------------------------------------------------- /docker-compose/otobo-override-https.yml: -------------------------------------------------------------------------------- 1 | # Run the OTOBO web app via HTTPS on the port $OTOBO_WEB_HTTPS_PORT or port 443 per default. 2 | # HTTP on port 80 redirects to HTTPS on port 443. 3 | # This is implemented by running nginx as a reverse proxy for a webserver running otobo.psgi. 4 | 5 | # See also README.md. 6 | 7 | # most current docker-compose file version, as of 2020-05-21 8 | version: '3.3' 9 | 10 | services: 11 | 12 | # There is no HTTP port is specified, as the otobo webserver should only be reachable via HTTPS. 13 | # Note that the nginx service does provide service to port 80, but only to redirect to HTTPS. 14 | #web: 15 | # ports: 16 | # - "${OTOBO_WEB_HTTP_IPADDR:-0.0.0.0}:${OTOBO_WEB_HTTP_PORT:-80}:5000" 17 | 18 | nginx: 19 | image: ${OTOBO_IMAGE_OTOBO_NGINX:-rotheross/otobo-nginx-webproxy:latest-11_0} 20 | # according to https://stackoverflow.com/questions/43467670/which-capabilities-can-i-drop-in-a-docker-nginx-container 21 | cap_drop: 22 | - ALL 23 | cap_add: 24 | - CAP_SYS_CHROOT 25 | - CAP_CHOWN 26 | - CAP_DAC_OVERRIDE 27 | - CAP_SETGID 28 | - CAP_SETUID 29 | depends_on: 30 | - web 31 | restart: always 32 | volumes: 33 | - otobo_nginx_ssl:/etc/nginx/ssl 34 | # The HTTP port is exposed, but only redirects to HTTPS 35 | ports: 36 | - "${OTOBO_WEB_HTTPS_IPADDR:-0.0.0.0}:${OTOBO_WEB_HTTPS_PORT:-443}:8443" 37 | - "${OTOBO_WEB_HTTP_IPADDR:-0.0.0.0}:${OTOBO_WEB_HTTP_PORT:-80}:8080" 38 | # inside the docker network the host and the port is fixed 39 | environment: 40 | OTOBO_NGINX_WEB_HOST: web 41 | OTOBO_NGINX_WEB_PORT: 5000 42 | OTOBO_WEB_HTTPS_PORT: ${OTOBO_WEB_HTTPS_PORT:-} 43 | OTOBO_NGINX_SSL_CERTIFICATE: ${OTOBO_NGINX_SSL_CERTIFICATE:?err} 44 | OTOBO_NGINX_SSL_CERTIFICATE_KEY: ${OTOBO_NGINX_SSL_CERTIFICATE_KEY:?err} 45 | NGINX_ENVSUBST_TEMPLATE_DIR: ${NGINX_ENVSUBST_TEMPLATE_DIR:-} 46 | healthcheck: 47 | test: service nginx status || exit 1 48 | 49 | volumes: 50 | otobo_nginx_ssl: 51 | external: true 52 | -------------------------------------------------------------------------------- /docker-compose/otobo-override-https-kerberos.yml: -------------------------------------------------------------------------------- 1 | # Run the OTOBO web app via HTTPS on the port $OTOBO_WEB_HTTPS_PORT or port 443 per default. 2 | # HTTP on port 80 redirects to HTTPS on port 443. 3 | # This is implemented by running nginx as a reverse proxy for a webserver running otobo.psgi. 4 | 5 | # See also README.md. 6 | 7 | # most current docker-compose file version, as of 2020-05-21 8 | version: '3.3' 9 | 10 | services: 11 | 12 | # There is no HTTP port is specified, as the otobo webserver should only be reachable via HTTPS. 13 | # Note that the nginx service does provide service to port 80, but only to redirect to HTTPS. 14 | #web: 15 | # ports: 16 | # - "${OTOBO_WEB_HTTP_IPADDR:-0.0.0.0}:${OTOBO_WEB_HTTP_PORT:-80}:5000" 17 | 18 | nginx: 19 | image: ${OTOBO_IMAGE_OTOBO_NGINX:-rotheross/otobo-nginx-kerberos-webproxy:latest-11_0} 20 | # according to https://stackoverflow.com/questions/43467670/which-capabilities-can-i-drop-in-a-docker-nginx-container 21 | cap_drop: 22 | - ALL 23 | cap_add: 24 | - CAP_SYS_CHROOT 25 | - CAP_CHOWN 26 | - CAP_DAC_OVERRIDE 27 | - CAP_SETGID 28 | - CAP_SETUID 29 | depends_on: 30 | - web 31 | restart: always 32 | volumes: 33 | - otobo_nginx_ssl:/etc/nginx/ssl 34 | - ${OTOBO_NGINX_KERBEROS_KEYTAB:-/etc/krb5.keytab}:/etc/krb5.keytab:ro 35 | # uncomment when /etc/krb5.conf should be mounted from the Docker host 36 | #- ${OTOBO_NGINX_KERBEROS_CONFIG:-/etc/krb5.conf}:/etc/krb5.conf:ro 37 | # The HTTP port is exposed, but only redirects to HTTPS 38 | ports: 39 | - "${OTOBO_WEB_HTTPS_IPADDR:-0.0.0.0}:${OTOBO_WEB_HTTPS_PORT:-443}:8443" 40 | - "${OTOBO_WEB_HTTP_IPADDR:-0.0.0.0}:${OTOBO_WEB_HTTP_PORT:-80}:8080" 41 | # inside the docker network the host and the port is fixed 42 | environment: 43 | OTOBO_NGINX_WEB_HOST: web 44 | OTOBO_NGINX_WEB_PORT: 5000 45 | OTOBO_WEB_HTTPS_PORT: ${OTOBO_WEB_HTTPS_PORT:-} 46 | OTOBO_NGINX_SSL_CERTIFICATE: ${OTOBO_NGINX_SSL_CERTIFICATE:?err} 47 | OTOBO_NGINX_SSL_CERTIFICATE_KEY: ${OTOBO_NGINX_SSL_CERTIFICATE_KEY:?err} 48 | NGINX_ENVSUBST_TEMPLATE_DIR: ${NGINX_ENVSUBST_TEMPLATE_DIR:-} 49 | OTOBO_NGINX_KERBEROS_SERVICE_NAME: ${OTOBO_NGINX_KERBEROS_SERVICE_NAME:?err} 50 | OTOBO_NGINX_KERBEROS_REALM: ${OTOBO_NGINX_KERBEROS_REALM:?err} 51 | OTOBO_NGINX_KERBEROS_KDC: ${OTOBO_NGINX_KERBEROS_KDC:?err} 52 | OTOBO_NGINX_KERBEROS_ADMIN_SERVER: ${OTOBO_NGINX_KERBEROS_ADMIN_SERVER:?err} 53 | OTOBO_NGINX_KERBEROS_DEFAULT_DOMAIN: ${OTOBO_NGINX_KERBEROS_DEFAULT_DOMAIN:?err} 54 | healthcheck: 55 | test: service nginx status || exit 1 56 | 57 | volumes: 58 | otobo_nginx_ssl: 59 | external: true 60 | -------------------------------------------------------------------------------- /scripts/devel/generate_sample_env_files.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | # This script is a helper for generating sample Docker Compose environment files from a template. 4 | # It is meant to be used by developers of otobo-docker. 5 | # The goal is to have a single source file for all sample .env files. 6 | # The default template is located at "etc/templates/dot_env.m4" 7 | 8 | # Pass -h for usage info. 9 | 10 | # parse command line argument 11 | function args() 12 | { 13 | # -h and --help take no parameters 14 | # --repository and --tag have mandatory parameters, as indicated by ':' 15 | options=$(getopt -o h --long help -- "$@") 16 | 17 | # print help message in case of invalid optiond 18 | [ $? -eq 0 ] || { 19 | print_help_and_exit 1 20 | } 21 | 22 | # set default values 23 | HELP_FLAG=0 24 | 25 | eval set -- "$options" 26 | while true; do 27 | case "$1" in 28 | -h) 29 | HELP_FLAG=1 30 | ;; 31 | 32 | --help) 33 | HELP_FLAG=1 34 | ;; 35 | 36 | --) 37 | shift 38 | break 39 | ;; 40 | 41 | esac 42 | shift 43 | done 44 | } 45 | 46 | # print help 47 | function print_help_and_exit() { 48 | cat < .docker_compose_env_https 86 | 87 | # HTTPS with Kerberos configuration 88 | cp --backup=numbered .docker_compose_env_https_kerberos .docker_compose_env_https_kerberos.bak || : 89 | m4 --prefix-builtins --define "otoflag_KERBEROS" etc/templates/dot_env.m4 > .docker_compose_env_https_kerberos 90 | 91 | # HTTP only 92 | cp --backup=numbered .docker_compose_env_http .docker_compose_env_http.bak || : 93 | m4 --prefix-builtins --define "otoflag_HTTP" etc/templates/dot_env.m4 > .docker_compose_env_http 94 | 95 | # HTTPS with a custom nginx config 96 | cp --backup=numbered .docker_compose_env_https_custom_nginx .docker_compose_env_https_custom_nginx.bak || : 97 | m4 --prefix-builtins --define "otoflag_HTTPS" --define "otoflag_CUSTOM_NGINX" etc/templates/dot_env.m4 > .docker_compose_env_https_custom_nginx 98 | 99 | # for testing: HTTPS and additionally Selenium Testing with Chrome 100 | cp --backup=numbered .docker_compose_env_https_selenium .docker_compose_env_https_selenium.bak || : 101 | m4 --prefix-builtins --define "otoflag_HTTPS" --define "otoflag_SELENIUM" etc/templates/dot_env.m4 > .docker_compose_env_https_selenium 102 | 103 | # for testing: HTTP and additionally Selenium Testing with Chrome 104 | cp --backup=numbered .docker_compose_env_http_selenium .docker_compose_env_http_selenium.bak || : 105 | m4 --prefix-builtins --define "otoflag_HTTP" --define "otoflag_SELENIUM" etc/templates/dot_env.m4 > .docker_compose_env_http_selenium 106 | 107 | fi 108 | -------------------------------------------------------------------------------- /.docker_compose_env_http: -------------------------------------------------------------------------------- 1 | # This file contains default values for environment values that are needed either by Docker Compose itself 2 | # or by the docker compose files. 3 | 4 | # COMPOSE_PROJECT_NAME declares the prefix of the name of the Docker containers. So if the 5 | # project name is 'acme_support' then the web container is named either 'acme_support_web_1' for 6 | # Compose V1 or 'acme_support-web-1 for Compose V2. The project name also declares 7 | # the prefix of named volumes. Thus changing the project name allows to have 8 | # seperate containers and volumes for separate installations of OTOBO. 9 | # 10 | # Note that when COMPOSE_PROJECT_NAME is set in the shell environment, 11 | # then that setting has higher precedence. 12 | COMPOSE_PROJECT_NAME=otobo 13 | #COMPOSE_PROJECT_NAME=acme_support 14 | 15 | # COMPOSE_FILE is a collection of files, separated by COMPOSE_PATH_SEPARATOR, that make up the final config. 16 | # These files usually reside in the subdirectory docker-compose. 17 | # 18 | # Additional services can be added by concatenating more files to COMPOSE_FILE. An example would services 19 | # for S3 compatible storage. That is: :docker-compose/otobo-localstack.yml or :docker-compose/otobo-minio.yml. 20 | # An OpenLDAP server for use by the unit tests can be activated by appending :docker-compose/testing/openldap.yml. 21 | COMPOSE_PATH_SEPARATOR=: 22 | COMPOSE_FILE=docker-compose/otobo-base.yml:docker-compose/otobo-override-http.yml 23 | 24 | # Database configuration 25 | # OTOBO_DB_ROOT_PASSWORD must be set 26 | OTOBO_DB_ROOT_PASSWORD= 27 | 28 | # Set this to a value in bytes to overwrite the default query size set for OTOBO 29 | #OTOBO_DB_QUERY_CACHE_SIZE= 30 | 31 | # HTTP options 32 | # Set OTOBO_WEB_HTTP_PORT when the HTTP port is not 80 33 | #OTOBO_WEB_HTTP_PORT= 34 | 35 | # Set OTOBO_WEB_HTTP_IPADDR when only requests addressed to a specific IP should be served. 36 | # See https://docs.docker.com/compose/compose-file/compose-file-v3/#ports 37 | #OTOBO_WEB_HTTP_IPADDR= 38 | 39 | # The option OTOBO_WEB_OPTION influences which webserver is used with which options. 40 | # The default value is 'deployment' 41 | #OTOBO_WEB_OPTION=deployment # the default, should be used in production and most times during development 42 | #OTOBO_WEB_OPTION=development # can be useful during development, sets PLACK_ENV to 'development' 43 | #OTOBO_WEB_OPTION=shotgun # use the shotgun, start a new process for every request 44 | 45 | # Elasticsearch options 46 | OTOBO_ELASTICSEARCH_ES_JAVA_OPTS=-Xms512m -Xmx512m 47 | 48 | ################################################################################ 49 | # The Docker image for the service 'db' can be specified explicitly. 50 | # The default is mariadb:lts-noble 51 | ################################################################################ 52 | #OTOBO_IMAGE_DB= 53 | 54 | ################################################################################ 55 | # The Docker image for the services 'web' and 'daemon' can be specified explicitly. 56 | # The default is rotheross/otobo:latest-11_0 57 | ################################################################################ 58 | 59 | # Examples: 60 | #OTOBO_IMAGE_OTOBO=rotheross/otobo:rel-11_0_14 61 | #OTOBO_IMAGE_OTOBO=rotheross/otobo:devel-rel-11_0 62 | #OTOBO_IMAGE_OTOBO=otobo:local-11.0.x 63 | 64 | ################################################################################ 65 | # The Docker image for the service 'eleastic' can be specified explicitly. 66 | # The default is rotheross/otobo-elasticsearch:latest-11_0 67 | ################################################################################ 68 | 69 | # Examples: 70 | #OTOBO_IMAGE_OTOBO_ELASTICSEARCH=rotheross/otobo-elasticsearch:rel-11_0_14 71 | #OTOBO_IMAGE_OTOBO_ELASTICSEARCH=rotheross/otobo-elasticsearch:devel-rel-11_0 72 | #OTOBO_IMAGE_OTOBO_ELASTICSEARCH=otobo-elasticsearch:local-11.0.x 73 | 74 | ################################################################################ 75 | # The Docker image for the service 'redis' can be specified explicitly. 76 | # The default is redis:8-bookworm 77 | ################################################################################ 78 | #OTOBO_IMAGE_REDIS= 79 | 80 | -------------------------------------------------------------------------------- /scripts/update.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | # This is a shortcut for the commands documented in 4 | # https://doc.otobo.org/manual/installation/stable/de/content/updating-docker.html . 5 | # Pass -h for usage info. 6 | 7 | # Initial Values 8 | # DONT_WARN=false - Disabled - https://github.com/RotherOSS/otobo-docker/pull/124#issuecomment-1590879464 9 | 10 | # Help Message 11 | function display_help() { 12 | echo "Usage: update.sh [OPTIONS]" 13 | echo "Options:" 14 | echo " -h, --help Display this help screen" 15 | # echo " --dontwarn Don't warn about Docker Compose warnings." 16 | echo " " 17 | echo "The standard behavior is to use the setup from .env." 18 | echo "In .env one may set up a specific repositories and specific tags." 19 | echo " " 20 | } 21 | 22 | # Docker Compose Warning 23 | #function docker_warning() { 24 | # if [ "$DONT_WARN" = false ]; then 25 | # # assuming the change would be made automatically? 26 | # # haven't migrated v1 compose to v2 before 27 | # echo "Due to changes with docker, your container names may appear differently after the upgrade, [docker-compose] used to be the command used, but with compose v2, [docker compose] is now used." 28 | # echo "This may change some container names, such as changing [otobo_web_1] to [otobo-web-1]." 29 | # echo "Please see https://github.com/RotherOSS/otobo-docker/issues/122 for more information." 30 | # echo " " 31 | # read -p "Do you understand? (y/n) " yon 32 | # case "$yon" in 33 | # [Yy]*) 34 | # echo "Continuing." 35 | # ;; 36 | # *) 37 | # echo "Please read the issue mentioned above for more information. Exiting." 38 | # exit $1 39 | # ;; 40 | # esac 41 | # fi 42 | #} 43 | 44 | # Parse cli args 45 | while [[ $# -gt 0 ]]; do 46 | case "$1" in 47 | -h|--help) 48 | display_help 49 | exit 0 50 | ;; 51 | # --dontwarn) 52 | # DONT_WARN=true 53 | # shift 54 | # ;; 55 | *) 56 | echo "Invalid option: $1" 57 | echo "Use -h or --help for usage instructions." 58 | exit 1 59 | ;; 60 | esac 61 | done 62 | 63 | ### Disable for the time being - https://github.com/RotherOSS/otobo-docker/pull/124#issuecomment-1590879464 64 | # docker_warning 65 | 66 | # if docker-compose exists, use that, otherwise, use `docker compose` 67 | if ! command -v docker-compose &> /dev/null 68 | then 69 | echo "[Note] docker-compose was not found, using docker compose" 70 | echo "[Note] See https://github.com/RotherOSS/otobo-docker/issues/122 for more into on this." 71 | DOCKERCOMPOSE="docker compose" 72 | else 73 | echo "[Note] docker-compose found, will continue to use that." 74 | echo "[Note] See https://github.com/RotherOSS/otobo-docker/issues/122 for more info on this." 75 | DOCKERCOMPOSE="docker-compose" 76 | fi 77 | 78 | 79 | # get, or update, the non-local images 80 | # There will be error messages for local images, 81 | # but this is acceptable as developers are responsible for the local images. 82 | echo "Updating Docker images from their repositories." 83 | echo "See the file .env for which repositories and tags are used." 84 | echo "Error messages for local images can be ignored." 85 | $DOCKERCOMPOSE pull 86 | 87 | # stop and remove the containers, but keep the named volumes 88 | $DOCKERCOMPOSE down 89 | 90 | # The containers are still stopped. 91 | # Copy the OTOBO software from the potentially changed image into the volume mounted at /opt/otobo. 92 | # The required config is taken from the .env file. 93 | $DOCKERCOMPOSE run --no-deps --rm web copy_otobo_next 94 | 95 | # start containers again, using the new version 96 | $DOCKERCOMPOSE up --detach 97 | 98 | # a quick sanity check 99 | $DOCKERCOMPOSE ps 100 | 101 | # There isn't yet a good check that the database is already running when the webserver starts up. 102 | # So let's sleep for a while and hope the best for later. 103 | echo "sleeping for 10s, while the database is starting up" 104 | sleep 10 105 | echo "finished with sleeping" 106 | 107 | # complete the update, with running database 108 | $DOCKERCOMPOSE exec web /opt/otobo_install/entrypoint.sh do_update_tasks 109 | 110 | # inspect the update log 111 | $DOCKERCOMPOSE exec web cat /opt/otobo/var/log/update.log 112 | -------------------------------------------------------------------------------- /.docker_compose_env_http_selenium: -------------------------------------------------------------------------------- 1 | # This file contains default values for environment values that are needed either by Docker Compose itself 2 | # or by the docker compose files. 3 | 4 | # COMPOSE_PROJECT_NAME declares the prefix of the name of the Docker containers. So if the 5 | # project name is 'acme_support' then the web container is named either 'acme_support_web_1' for 6 | # Compose V1 or 'acme_support-web-1 for Compose V2. The project name also declares 7 | # the prefix of named volumes. Thus changing the project name allows to have 8 | # seperate containers and volumes for separate installations of OTOBO. 9 | # 10 | # Note that when COMPOSE_PROJECT_NAME is set in the shell environment, 11 | # then that setting has higher precedence. 12 | COMPOSE_PROJECT_NAME=otobo 13 | #COMPOSE_PROJECT_NAME=acme_support 14 | 15 | # COMPOSE_FILE is a collection of files, separated by COMPOSE_PATH_SEPARATOR, that make up the final config. 16 | # These files usually reside in the subdirectory docker-compose. 17 | # 18 | # Additional services can be added by concatenating more files to COMPOSE_FILE. An example would services 19 | # for S3 compatible storage. That is: :docker-compose/otobo-localstack.yml or :docker-compose/otobo-minio.yml. 20 | # An OpenLDAP server for use by the unit tests can be activated by appending :docker-compose/testing/openldap.yml. 21 | COMPOSE_PATH_SEPARATOR=: 22 | COMPOSE_FILE=docker-compose/otobo-base.yml:docker-compose/otobo-override-http.yml:docker-compose/otobo-selenium.yml 23 | 24 | # Database configuration 25 | # OTOBO_DB_ROOT_PASSWORD must be set 26 | OTOBO_DB_ROOT_PASSWORD= 27 | 28 | # Set this to a value in bytes to overwrite the default query size set for OTOBO 29 | #OTOBO_DB_QUERY_CACHE_SIZE= 30 | 31 | # HTTP options 32 | # Set OTOBO_WEB_HTTP_PORT when the HTTP port is not 80 33 | #OTOBO_WEB_HTTP_PORT= 34 | 35 | # Set OTOBO_WEB_HTTP_IPADDR when only requests addressed to a specific IP should be served. 36 | # See https://docs.docker.com/compose/compose-file/compose-file-v3/#ports 37 | #OTOBO_WEB_HTTP_IPADDR= 38 | 39 | # The option OTOBO_WEB_OPTION influences which webserver is used with which options. 40 | # The default value is 'deployment' 41 | #OTOBO_WEB_OPTION=deployment # the default, should be used in production and most times during development 42 | #OTOBO_WEB_OPTION=development # can be useful during development, sets PLACK_ENV to 'development' 43 | #OTOBO_WEB_OPTION=shotgun # use the shotgun, start a new process for every request 44 | 45 | # Elasticsearch options 46 | OTOBO_ELASTICSEARCH_ES_JAVA_OPTS=-Xms512m -Xmx512m 47 | 48 | ################################################################################ 49 | # The Docker image for the service 'db' can be specified explicitly. 50 | # The default is mariadb:lts-noble 51 | ################################################################################ 52 | #OTOBO_IMAGE_DB= 53 | 54 | ################################################################################ 55 | # The Docker image for the services 'web' and 'daemon' can be specified explicitly. 56 | # The default is rotheross/otobo:latest-11_0 57 | ################################################################################ 58 | 59 | # Examples: 60 | #OTOBO_IMAGE_OTOBO=rotheross/otobo:rel-11_0_14 61 | #OTOBO_IMAGE_OTOBO=rotheross/otobo:devel-rel-11_0 62 | #OTOBO_IMAGE_OTOBO=otobo:local-11.0.x 63 | 64 | ################################################################################ 65 | # The Docker image for the service 'eleastic' can be specified explicitly. 66 | # The default is rotheross/otobo-elasticsearch:latest-11_0 67 | ################################################################################ 68 | 69 | # Examples: 70 | #OTOBO_IMAGE_OTOBO_ELASTICSEARCH=rotheross/otobo-elasticsearch:rel-11_0_14 71 | #OTOBO_IMAGE_OTOBO_ELASTICSEARCH=rotheross/otobo-elasticsearch:devel-rel-11_0 72 | #OTOBO_IMAGE_OTOBO_ELASTICSEARCH=otobo-elasticsearch:local-11.0.x 73 | 74 | ################################################################################ 75 | # The Docker image for the service 'redis' can be specified explicitly. 76 | # The default is redis:8-bookworm 77 | ################################################################################ 78 | #OTOBO_IMAGE_REDIS= 79 | 80 | ################################################################################ 81 | # The Docker image for the service 'selenium' can be specified explicitly. 82 | # The default image is rotheross/otobo-selenium-chrome:latest-11_0 83 | ################################################################################ 84 | 85 | # Examples: 86 | #OTOBO_IMAGE_OTOBO_SELENIUM_CHROME=rotheross/otobo-selenium-chrome:rel-11_0_14 87 | #OTOBO_IMAGE_OTOBO_SELENIUM_CHROME=rotheross/otobo-selenium-chrome:devel-rel-11_0 88 | #OTOBO_IMAGE_OTOBO_SELENIUM_CHROME=otobo-selenium-chrome:local-11.0.x 89 | 90 | -------------------------------------------------------------------------------- /.docker_compose_env_https: -------------------------------------------------------------------------------- 1 | # This file contains default values for environment values that are needed either by Docker Compose itself 2 | # or by the docker compose files. 3 | 4 | # COMPOSE_PROJECT_NAME declares the prefix of the name of the Docker containers. So if the 5 | # project name is 'acme_support' then the web container is named either 'acme_support_web_1' for 6 | # Compose V1 or 'acme_support-web-1 for Compose V2. The project name also declares 7 | # the prefix of named volumes. Thus changing the project name allows to have 8 | # seperate containers and volumes for separate installations of OTOBO. 9 | # 10 | # Note that when COMPOSE_PROJECT_NAME is set in the shell environment, 11 | # then that setting has higher precedence. 12 | COMPOSE_PROJECT_NAME=otobo 13 | #COMPOSE_PROJECT_NAME=acme_support 14 | 15 | # COMPOSE_FILE is a collection of files, separated by COMPOSE_PATH_SEPARATOR, that make up the final config. 16 | # These files usually reside in the subdirectory docker-compose. 17 | # 18 | # Additional services can be added by concatenating more files to COMPOSE_FILE. An example would services 19 | # for S3 compatible storage. That is: :docker-compose/otobo-localstack.yml or :docker-compose/otobo-minio.yml. 20 | # An OpenLDAP server for use by the unit tests can be activated by appending :docker-compose/testing/openldap.yml. 21 | COMPOSE_PATH_SEPARATOR=: 22 | COMPOSE_FILE=docker-compose/otobo-base.yml:docker-compose/otobo-override-https.yml 23 | 24 | # Database configuration 25 | # OTOBO_DB_ROOT_PASSWORD must be set 26 | OTOBO_DB_ROOT_PASSWORD= 27 | 28 | # Set this to a value in bytes to overwrite the default query size set for OTOBO 29 | #OTOBO_DB_QUERY_CACHE_SIZE= 30 | 31 | # HTTP options 32 | # In the HTTPS case http:// redirects to https:// 33 | # Set OTOBO_WEB_HTTP_PORT when the HTTP port is not 80 34 | #OTOBO_WEB_HTTP_PORT= 35 | 36 | # Set OTOBO_WEB_HTTP_IPADDR when only requests addressed to a specific IP should be served. 37 | # See https://docs.docker.com/compose/compose-file/compose-file-v3/#ports 38 | #OTOBO_WEB_HTTP_IPADDR= 39 | 40 | # The option OTOBO_WEB_OPTION influences which webserver is used with which options. 41 | # The default value is 'deployment' 42 | #OTOBO_WEB_OPTION=deployment # the default, should be used in production and most times during development 43 | #OTOBO_WEB_OPTION=development # can be useful during development, sets PLACK_ENV to 'development' 44 | #OTOBO_WEB_OPTION=shotgun # use the shotgun, start a new process for every request 45 | 46 | # HTTPS options 47 | 48 | # set OTOBO_WEB_HTTPS_PORT when the HTTPS port is not 443 49 | #OTOBO_WEB_HTTPS_PORT= 50 | 51 | # Set OTOBO_WEB_HTTPS_IPADDR when only requests addressed to a specific IP should be served. 52 | # See https://docs.docker.com/compose/compose-file/compose-file-v3/#ports 53 | #OTOBO_WEB_HTTPS_IPADDR= 54 | 55 | # The settings OTOBO_NGINX_SSL_CERTIFICATE and OTOBO_NGINX_SSL_CERTIFICATE_KEY 56 | # are mandatory when HTTPS is used. 57 | # The configured pathes must be absolute pathes that are available in the container. 58 | #OTOBO_NGINX_SSL_CERTIFICATE=/etc/nginx/ssl/ssl-cert.crt 59 | #OTOBO_NGINX_SSL_CERTIFICATE_KEY=/etc/nginx/ssl/ssl-key.key 60 | OTOBO_NGINX_SSL_CERTIFICATE= 61 | OTOBO_NGINX_SSL_CERTIFICATE_KEY= 62 | 63 | # Elasticsearch options 64 | OTOBO_ELASTICSEARCH_ES_JAVA_OPTS=-Xms512m -Xmx512m 65 | 66 | ################################################################################ 67 | # The Docker image for the service 'db' can be specified explicitly. 68 | # The default is mariadb:lts-noble 69 | ################################################################################ 70 | #OTOBO_IMAGE_DB= 71 | 72 | ################################################################################ 73 | # The Docker image for the services 'web' and 'daemon' can be specified explicitly. 74 | # The default is rotheross/otobo:latest-11_0 75 | ################################################################################ 76 | 77 | # Examples: 78 | #OTOBO_IMAGE_OTOBO=rotheross/otobo:rel-11_0_14 79 | #OTOBO_IMAGE_OTOBO=rotheross/otobo:devel-rel-11_0 80 | #OTOBO_IMAGE_OTOBO=otobo:local-11.0.x 81 | 82 | ################################################################################ 83 | # The Docker image for the service 'eleastic' can be specified explicitly. 84 | # The default is rotheross/otobo-elasticsearch:latest-11_0 85 | ################################################################################ 86 | 87 | # Examples: 88 | #OTOBO_IMAGE_OTOBO_ELASTICSEARCH=rotheross/otobo-elasticsearch:rel-11_0_14 89 | #OTOBO_IMAGE_OTOBO_ELASTICSEARCH=rotheross/otobo-elasticsearch:devel-rel-11_0 90 | #OTOBO_IMAGE_OTOBO_ELASTICSEARCH=otobo-elasticsearch:local-11.0.x 91 | 92 | ################################################################################ 93 | # The Docker image for the service 'redis' can be specified explicitly. 94 | # The default is redis:8-bookworm 95 | ################################################################################ 96 | #OTOBO_IMAGE_REDIS= 97 | 98 | ################################################################################ 99 | # The Docker image for the service 'nginx' can be specified explicitly. 100 | # The default image is rotheross/otobo-nginx-webproxy:latest-11_0 101 | ################################################################################ 102 | 103 | # Examples: 104 | #OTOBO_IMAGE_OTOBO_NGINX=rotheross/otobo-nginx-webproxy:rel-11_0_14 105 | #OTOBO_IMAGE_OTOBO_NGINX=rotheross/otobo-nginx-webproxy:devel-rel-11_0 106 | #OTOBO_IMAGE_OTOBO_NGINX=otobo-nginx-webproxy:local-11.0.x 107 | 108 | -------------------------------------------------------------------------------- /.docker_compose_env_https_custom_nginx: -------------------------------------------------------------------------------- 1 | # This file contains default values for environment values that are needed either by Docker Compose itself 2 | # or by the docker compose files. 3 | 4 | # COMPOSE_PROJECT_NAME declares the prefix of the name of the Docker containers. So if the 5 | # project name is 'acme_support' then the web container is named either 'acme_support_web_1' for 6 | # Compose V1 or 'acme_support-web-1 for Compose V2. The project name also declares 7 | # the prefix of named volumes. Thus changing the project name allows to have 8 | # seperate containers and volumes for separate installations of OTOBO. 9 | # 10 | # Note that when COMPOSE_PROJECT_NAME is set in the shell environment, 11 | # then that setting has higher precedence. 12 | COMPOSE_PROJECT_NAME=otobo 13 | #COMPOSE_PROJECT_NAME=acme_support 14 | 15 | # COMPOSE_FILE is a collection of files, separated by COMPOSE_PATH_SEPARATOR, that make up the final config. 16 | # These files usually reside in the subdirectory docker-compose. 17 | # 18 | # Additional services can be added by concatenating more files to COMPOSE_FILE. An example would services 19 | # for S3 compatible storage. That is: :docker-compose/otobo-localstack.yml or :docker-compose/otobo-minio.yml. 20 | # An OpenLDAP server for use by the unit tests can be activated by appending :docker-compose/testing/openldap.yml. 21 | COMPOSE_PATH_SEPARATOR=: 22 | COMPOSE_FILE=docker-compose/otobo-base.yml:docker-compose/otobo-override-https.yml:docker-compose/otobo-nginx-custom-config.yml 23 | 24 | # Database configuration 25 | # OTOBO_DB_ROOT_PASSWORD must be set 26 | OTOBO_DB_ROOT_PASSWORD= 27 | 28 | # Set this to a value in bytes to overwrite the default query size set for OTOBO 29 | #OTOBO_DB_QUERY_CACHE_SIZE= 30 | 31 | # HTTP options 32 | # In the HTTPS case http:// redirects to https:// 33 | # Set OTOBO_WEB_HTTP_PORT when the HTTP port is not 80 34 | #OTOBO_WEB_HTTP_PORT= 35 | 36 | # Set OTOBO_WEB_HTTP_IPADDR when only requests addressed to a specific IP should be served. 37 | # See https://docs.docker.com/compose/compose-file/compose-file-v3/#ports 38 | #OTOBO_WEB_HTTP_IPADDR= 39 | 40 | # The option OTOBO_WEB_OPTION influences which webserver is used with which options. 41 | # The default value is 'deployment' 42 | #OTOBO_WEB_OPTION=deployment # the default, should be used in production and most times during development 43 | #OTOBO_WEB_OPTION=development # can be useful during development, sets PLACK_ENV to 'development' 44 | #OTOBO_WEB_OPTION=shotgun # use the shotgun, start a new process for every request 45 | 46 | # HTTPS options 47 | 48 | # set OTOBO_WEB_HTTPS_PORT when the HTTPS port is not 443 49 | #OTOBO_WEB_HTTPS_PORT= 50 | 51 | # Set OTOBO_WEB_HTTPS_IPADDR when only requests addressed to a specific IP should be served. 52 | # See https://docs.docker.com/compose/compose-file/compose-file-v3/#ports 53 | #OTOBO_WEB_HTTPS_IPADDR= 54 | 55 | # The settings OTOBO_NGINX_SSL_CERTIFICATE and OTOBO_NGINX_SSL_CERTIFICATE_KEY 56 | # are mandatory when HTTPS is used. 57 | # The configured pathes must be absolute pathes that are available in the container. 58 | #OTOBO_NGINX_SSL_CERTIFICATE=/etc/nginx/ssl/ssl-cert.crt 59 | #OTOBO_NGINX_SSL_CERTIFICATE_KEY=/etc/nginx/ssl/ssl-key.key 60 | OTOBO_NGINX_SSL_CERTIFICATE= 61 | OTOBO_NGINX_SSL_CERTIFICATE_KEY= 62 | 63 | # Elasticsearch options 64 | OTOBO_ELASTICSEARCH_ES_JAVA_OPTS=-Xms512m -Xmx512m 65 | 66 | ################################################################################ 67 | # The Docker image for the service 'db' can be specified explicitly. 68 | # The default is mariadb:lts-noble 69 | ################################################################################ 70 | #OTOBO_IMAGE_DB= 71 | 72 | ################################################################################ 73 | # The Docker image for the services 'web' and 'daemon' can be specified explicitly. 74 | # The default is rotheross/otobo:latest-11_0 75 | ################################################################################ 76 | 77 | # Examples: 78 | #OTOBO_IMAGE_OTOBO=rotheross/otobo:rel-11_0_14 79 | #OTOBO_IMAGE_OTOBO=rotheross/otobo:devel-rel-11_0 80 | #OTOBO_IMAGE_OTOBO=otobo:local-11.0.x 81 | 82 | ################################################################################ 83 | # The Docker image for the service 'eleastic' can be specified explicitly. 84 | # The default is rotheross/otobo-elasticsearch:latest-11_0 85 | ################################################################################ 86 | 87 | # Examples: 88 | #OTOBO_IMAGE_OTOBO_ELASTICSEARCH=rotheross/otobo-elasticsearch:rel-11_0_14 89 | #OTOBO_IMAGE_OTOBO_ELASTICSEARCH=rotheross/otobo-elasticsearch:devel-rel-11_0 90 | #OTOBO_IMAGE_OTOBO_ELASTICSEARCH=otobo-elasticsearch:local-11.0.x 91 | 92 | ################################################################################ 93 | # The Docker image for the service 'redis' can be specified explicitly. 94 | # The default is redis:8-bookworm 95 | ################################################################################ 96 | #OTOBO_IMAGE_REDIS= 97 | 98 | ################################################################################ 99 | # The Docker image for the service 'nginx' can be specified explicitly. 100 | # The default image is rotheross/otobo-nginx-webproxy:latest-11_0 101 | ################################################################################ 102 | 103 | # Examples: 104 | #OTOBO_IMAGE_OTOBO_NGINX=rotheross/otobo-nginx-webproxy:rel-11_0_14 105 | #OTOBO_IMAGE_OTOBO_NGINX=rotheross/otobo-nginx-webproxy:devel-rel-11_0 106 | #OTOBO_IMAGE_OTOBO_NGINX=otobo-nginx-webproxy:local-11.0.x 107 | 108 | 109 | # provide a custom Nginx config template dir 110 | NGINX_ENVSUBST_TEMPLATE_DIR=/etc/nginx/config/template-custom 111 | -------------------------------------------------------------------------------- /docker-compose/otobo-base.yml: -------------------------------------------------------------------------------- 1 | # Docker compose file for the OTOBO webapp. 2 | # Note that no port is exposed as both HTTP and HTTPS are supported. 3 | # For HTTP see the extension file docker-compose/otobo-override-http.yml. 4 | # For HTTPS see the extension file docker-compose/otobo-override-https.yml. 5 | 6 | # See also README.md. 7 | 8 | # The toplevel attribute 'version' is obsolet and not used by current versions of docker compose. 9 | # The attribute is still provided here because there were problems with standalone Docker Compose 1.25 10 | # after removing the attribute. 11 | version: '3.3' 12 | 13 | services: 14 | 15 | # the database 16 | db: 17 | image: ${OTOBO_IMAGE_DB:-mariadb:lts-noble} 18 | user: mysql:mysql 19 | cap_drop: 20 | - ALL 21 | cap_add: 22 | - CAP_SYS_CHROOT 23 | restart: always 24 | logging: 25 | driver: "local" 26 | options: 27 | max-file: "5" 28 | max-size: "10m" 29 | volumes: 30 | - mariadb_data:/var/lib/mysql 31 | 32 | # Within the container network the MariaDB server listens to its default port 3306. 33 | # Per default this port is not exposed to the outside world. 34 | # One can use 'docker-compose exec -it db mysql ...' when access to the database is needed. 35 | # But for development it can be useful to expose the port 3306. E.g. when a graphical client 36 | # like MySQL Workbench or DBeaver is used. Uncomment the following lines for making MariaDB available 37 | # on port 3307 on the Docker host. A non-standard port is chosen here, because 3306 is 38 | # often already used on the Docker host. 39 | # 40 | # Instead of changing the port here one can also use 41 | # the the compose file docker-compose/otobo-override-db-exposed.yml 42 | # ports: 43 | # - "3307:3306" 44 | 45 | # Set the db root password which has to be entered when running otobo/installer.pl. 46 | # The passwort is secret and can be stored in the file .env. 47 | # The content of the .env file is something like: 48 | # OTOBO_DB_ROOT_PASSWORD=otobo_root 49 | environment: 50 | MYSQL_ROOT_PASSWORD: ${OTOBO_DB_ROOT_PASSWORD:?err} 51 | MARIADB_AUTO_UPGRADE: "1" 52 | 53 | # The entrypoint script adds the name daemon exectutable. 54 | # Up to MariaDB 10.5 the server executable was 'mysqld'. Later versions use 'mariadbd'. 55 | command: --max-allowed-packet=136314880 --character-set-server=utf8mb4 --collation-server=utf8mb4_unicode_ci --innodb-log-file-size=268435456 --query-cache-size=${OTOBO_DB_QUERY_CACHE_SIZE:-33554432} 56 | 57 | # "mariadb-admin ping" sets the exit code $?. The exit code will be 0 (success) when the server can be reached, 58 | # not 0 (failure) otherwise. 59 | # The host is given as db, because localhost might not be resolved on some systems. 60 | # The credentials are not really needed for pinging, but without them we would get "Access denied" log messages 61 | # every time the health check is executed. 62 | # Note: alternatively /usr/local/bin/healthcheck.sh could be used. 63 | healthcheck: 64 | test: mariadb-admin -h db --user=root --password='${OTOBO_DB_ROOT_PASSWORD}' ping 65 | 66 | # a container running a webserver 67 | web: 68 | # The services 'web' and 'daemon' use the same image. 69 | image: ${OTOBO_IMAGE_OTOBO:-rotheross/otobo:latest-11_0} 70 | cap_drop: 71 | - ALL 72 | #cap_add: 73 | depends_on: 74 | - db 75 | - elastic 76 | - redis 77 | restart: always 78 | logging: 79 | driver: "local" 80 | options: 81 | max-file: "5" 82 | max-size: "10m" 83 | # The HTTP port might be specified in a docker-compose extension file, e.g. docker-compose/otobo-override-http.yml. 84 | # For HTTPS no HTTP port is exposed. 85 | #ports: 86 | # - "80:5000" 87 | volumes: 88 | - opt_otobo:/opt/otobo 89 | command: web ${OTOBO_WEB_OPTION:-} 90 | healthcheck: 91 | test: curl -s -f http://localhost:5000/robots.txt 92 | 93 | # a container running the OTOBO daemon 94 | daemon: 95 | # The services 'web' and 'daemon' use the same image. 96 | image: ${OTOBO_IMAGE_OTOBO:-rotheross/otobo:latest-11_0} 97 | cap_drop: 98 | - ALL 99 | #cap_add: 100 | depends_on: 101 | - web 102 | restart: always 103 | logging: 104 | driver: "local" 105 | options: 106 | max-file: "5" 107 | max-size: "10m" 108 | volumes: 109 | - opt_otobo:/opt/otobo 110 | command: daemon 111 | healthcheck: 112 | test: ./bin/otobo.Daemon.pl status | grep 'Daemon running' 113 | 114 | # a container running Elasticsearch 115 | elastic: 116 | image: ${OTOBO_IMAGE_OTOBO_ELASTICSEARCH:-rotheross/otobo-elasticsearch:latest-11_0} 117 | cap_drop: 118 | - ALL 119 | cap_add: 120 | - CAP_SYS_CHROOT 121 | - CAP_SETUID 122 | - CAP_SETGID 123 | restart: always 124 | logging: 125 | driver: "local" 126 | options: 127 | max-file: "5" 128 | max-size: "10m" 129 | environment: 130 | discovery.type: single-node 131 | ES_JAVA_OPTS: ${OTOBO_ELASTICSEARCH_ES_JAVA_OPTS:?err} 132 | volumes: 133 | - elasticsearch_data:/usr/share/elasticsearch/data 134 | healthcheck: 135 | test: curl -s -f http://localhost:9200/_cat/health 136 | 137 | # a container running Redis 138 | redis: 139 | image: ${OTOBO_IMAGE_REDIS:-redis:8-bookworm} 140 | user: redis:redis 141 | cap_drop: 142 | - ALL 143 | #cap_add: 144 | restart: always 145 | logging: 146 | driver: "local" 147 | options: 148 | max-file: "5" 149 | max-size: "10m" 150 | healthcheck: 151 | test: redis-cli ping 152 | command: [ "redis-server", "--save", "" ] 153 | 154 | 155 | # no volumes need to be exposed across services 156 | volumes: 157 | mariadb_data: {} 158 | opt_otobo: {} 159 | elasticsearch_data: {} 160 | -------------------------------------------------------------------------------- /.docker_compose_env_https_selenium: -------------------------------------------------------------------------------- 1 | # This file contains default values for environment values that are needed either by Docker Compose itself 2 | # or by the docker compose files. 3 | 4 | # COMPOSE_PROJECT_NAME declares the prefix of the name of the Docker containers. So if the 5 | # project name is 'acme_support' then the web container is named either 'acme_support_web_1' for 6 | # Compose V1 or 'acme_support-web-1 for Compose V2. The project name also declares 7 | # the prefix of named volumes. Thus changing the project name allows to have 8 | # seperate containers and volumes for separate installations of OTOBO. 9 | # 10 | # Note that when COMPOSE_PROJECT_NAME is set in the shell environment, 11 | # then that setting has higher precedence. 12 | COMPOSE_PROJECT_NAME=otobo 13 | #COMPOSE_PROJECT_NAME=acme_support 14 | 15 | # COMPOSE_FILE is a collection of files, separated by COMPOSE_PATH_SEPARATOR, that make up the final config. 16 | # These files usually reside in the subdirectory docker-compose. 17 | # 18 | # Additional services can be added by concatenating more files to COMPOSE_FILE. An example would services 19 | # for S3 compatible storage. That is: :docker-compose/otobo-localstack.yml or :docker-compose/otobo-minio.yml. 20 | # An OpenLDAP server for use by the unit tests can be activated by appending :docker-compose/testing/openldap.yml. 21 | COMPOSE_PATH_SEPARATOR=: 22 | COMPOSE_FILE=docker-compose/otobo-base.yml:docker-compose/otobo-override-https.yml:docker-compose/otobo-selenium.yml 23 | 24 | # Database configuration 25 | # OTOBO_DB_ROOT_PASSWORD must be set 26 | OTOBO_DB_ROOT_PASSWORD= 27 | 28 | # Set this to a value in bytes to overwrite the default query size set for OTOBO 29 | #OTOBO_DB_QUERY_CACHE_SIZE= 30 | 31 | # HTTP options 32 | # In the HTTPS case http:// redirects to https:// 33 | # Set OTOBO_WEB_HTTP_PORT when the HTTP port is not 80 34 | #OTOBO_WEB_HTTP_PORT= 35 | 36 | # Set OTOBO_WEB_HTTP_IPADDR when only requests addressed to a specific IP should be served. 37 | # See https://docs.docker.com/compose/compose-file/compose-file-v3/#ports 38 | #OTOBO_WEB_HTTP_IPADDR= 39 | 40 | # The option OTOBO_WEB_OPTION influences which webserver is used with which options. 41 | # The default value is 'deployment' 42 | #OTOBO_WEB_OPTION=deployment # the default, should be used in production and most times during development 43 | #OTOBO_WEB_OPTION=development # can be useful during development, sets PLACK_ENV to 'development' 44 | #OTOBO_WEB_OPTION=shotgun # use the shotgun, start a new process for every request 45 | 46 | # HTTPS options 47 | 48 | # set OTOBO_WEB_HTTPS_PORT when the HTTPS port is not 443 49 | #OTOBO_WEB_HTTPS_PORT= 50 | 51 | # Set OTOBO_WEB_HTTPS_IPADDR when only requests addressed to a specific IP should be served. 52 | # See https://docs.docker.com/compose/compose-file/compose-file-v3/#ports 53 | #OTOBO_WEB_HTTPS_IPADDR= 54 | 55 | # The settings OTOBO_NGINX_SSL_CERTIFICATE and OTOBO_NGINX_SSL_CERTIFICATE_KEY 56 | # are mandatory when HTTPS is used. 57 | # The configured pathes must be absolute pathes that are available in the container. 58 | #OTOBO_NGINX_SSL_CERTIFICATE=/etc/nginx/ssl/ssl-cert.crt 59 | #OTOBO_NGINX_SSL_CERTIFICATE_KEY=/etc/nginx/ssl/ssl-key.key 60 | OTOBO_NGINX_SSL_CERTIFICATE= 61 | OTOBO_NGINX_SSL_CERTIFICATE_KEY= 62 | 63 | # Elasticsearch options 64 | OTOBO_ELASTICSEARCH_ES_JAVA_OPTS=-Xms512m -Xmx512m 65 | 66 | ################################################################################ 67 | # The Docker image for the service 'db' can be specified explicitly. 68 | # The default is mariadb:lts-noble 69 | ################################################################################ 70 | #OTOBO_IMAGE_DB= 71 | 72 | ################################################################################ 73 | # The Docker image for the services 'web' and 'daemon' can be specified explicitly. 74 | # The default is rotheross/otobo:latest-11_0 75 | ################################################################################ 76 | 77 | # Examples: 78 | #OTOBO_IMAGE_OTOBO=rotheross/otobo:rel-11_0_14 79 | #OTOBO_IMAGE_OTOBO=rotheross/otobo:devel-rel-11_0 80 | #OTOBO_IMAGE_OTOBO=otobo:local-11.0.x 81 | 82 | ################################################################################ 83 | # The Docker image for the service 'eleastic' can be specified explicitly. 84 | # The default is rotheross/otobo-elasticsearch:latest-11_0 85 | ################################################################################ 86 | 87 | # Examples: 88 | #OTOBO_IMAGE_OTOBO_ELASTICSEARCH=rotheross/otobo-elasticsearch:rel-11_0_14 89 | #OTOBO_IMAGE_OTOBO_ELASTICSEARCH=rotheross/otobo-elasticsearch:devel-rel-11_0 90 | #OTOBO_IMAGE_OTOBO_ELASTICSEARCH=otobo-elasticsearch:local-11.0.x 91 | 92 | ################################################################################ 93 | # The Docker image for the service 'redis' can be specified explicitly. 94 | # The default is redis:8-bookworm 95 | ################################################################################ 96 | #OTOBO_IMAGE_REDIS= 97 | 98 | ################################################################################ 99 | # The Docker image for the service 'nginx' can be specified explicitly. 100 | # The default image is rotheross/otobo-nginx-webproxy:latest-11_0 101 | ################################################################################ 102 | 103 | # Examples: 104 | #OTOBO_IMAGE_OTOBO_NGINX=rotheross/otobo-nginx-webproxy:rel-11_0_14 105 | #OTOBO_IMAGE_OTOBO_NGINX=rotheross/otobo-nginx-webproxy:devel-rel-11_0 106 | #OTOBO_IMAGE_OTOBO_NGINX=otobo-nginx-webproxy:local-11.0.x 107 | 108 | ################################################################################ 109 | # The Docker image for the service 'selenium' can be specified explicitly. 110 | # The default image is rotheross/otobo-selenium-chrome:latest-11_0 111 | ################################################################################ 112 | 113 | # Examples: 114 | #OTOBO_IMAGE_OTOBO_SELENIUM_CHROME=rotheross/otobo-selenium-chrome:rel-11_0_14 115 | #OTOBO_IMAGE_OTOBO_SELENIUM_CHROME=rotheross/otobo-selenium-chrome:devel-rel-11_0 116 | #OTOBO_IMAGE_OTOBO_SELENIUM_CHROME=otobo-selenium-chrome:local-11.0.x 117 | 118 | -------------------------------------------------------------------------------- /.docker_compose_env_https_kerberos: -------------------------------------------------------------------------------- 1 | # This file contains default values for environment values that are needed either by Docker Compose itself 2 | # or by the docker compose files. 3 | 4 | # COMPOSE_PROJECT_NAME declares the prefix of the name of the Docker containers. So if the 5 | # project name is 'acme_support' then the web container is named either 'acme_support_web_1' for 6 | # Compose V1 or 'acme_support-web-1 for Compose V2. The project name also declares 7 | # the prefix of named volumes. Thus changing the project name allows to have 8 | # seperate containers and volumes for separate installations of OTOBO. 9 | # 10 | # Note that when COMPOSE_PROJECT_NAME is set in the shell environment, 11 | # then that setting has higher precedence. 12 | COMPOSE_PROJECT_NAME=otobo 13 | #COMPOSE_PROJECT_NAME=acme_support 14 | 15 | # COMPOSE_FILE is a collection of files, separated by COMPOSE_PATH_SEPARATOR, that make up the final config. 16 | # These files usually reside in the subdirectory docker-compose. 17 | # 18 | # Additional services can be added by concatenating more files to COMPOSE_FILE. An example would services 19 | # for S3 compatible storage. That is: :docker-compose/otobo-localstack.yml or :docker-compose/otobo-minio.yml. 20 | # An OpenLDAP server for use by the unit tests can be activated by appending :docker-compose/testing/openldap.yml. 21 | COMPOSE_PATH_SEPARATOR=: 22 | COMPOSE_FILE=docker-compose/otobo-base.yml:docker-compose/otobo-override-https-kerberos.yml 23 | 24 | # Database configuration 25 | # OTOBO_DB_ROOT_PASSWORD must be set 26 | OTOBO_DB_ROOT_PASSWORD= 27 | 28 | # Set this to a value in bytes to overwrite the default query size set for OTOBO 29 | #OTOBO_DB_QUERY_CACHE_SIZE= 30 | 31 | # HTTP options 32 | # In the HTTPS case http:// redirects to https:// 33 | # Set OTOBO_WEB_HTTP_PORT when the HTTP port is not 80 34 | #OTOBO_WEB_HTTP_PORT= 35 | 36 | # Set OTOBO_WEB_HTTP_IPADDR when only requests addressed to a specific IP should be served. 37 | # See https://docs.docker.com/compose/compose-file/compose-file-v3/#ports 38 | #OTOBO_WEB_HTTP_IPADDR= 39 | 40 | # The option OTOBO_WEB_OPTION influences which webserver is used with which options. 41 | # The default value is 'deployment' 42 | #OTOBO_WEB_OPTION=deployment # the default, should be used in production and most times during development 43 | #OTOBO_WEB_OPTION=development # can be useful during development, sets PLACK_ENV to 'development' 44 | #OTOBO_WEB_OPTION=shotgun # use the shotgun, start a new process for every request 45 | 46 | # HTTPS options 47 | 48 | # set OTOBO_WEB_HTTPS_PORT when the HTTPS port is not 443 49 | #OTOBO_WEB_HTTPS_PORT= 50 | 51 | # Set OTOBO_WEB_HTTPS_IPADDR when only requests addressed to a specific IP should be served. 52 | # See https://docs.docker.com/compose/compose-file/compose-file-v3/#ports 53 | #OTOBO_WEB_HTTPS_IPADDR= 54 | 55 | # The settings OTOBO_NGINX_SSL_CERTIFICATE and OTOBO_NGINX_SSL_CERTIFICATE_KEY 56 | # are mandatory when HTTPS is used. 57 | # The configured pathes must be absolute pathes that are available in the container. 58 | #OTOBO_NGINX_SSL_CERTIFICATE=/etc/nginx/ssl/ssl-cert.crt 59 | #OTOBO_NGINX_SSL_CERTIFICATE_KEY=/etc/nginx/ssl/ssl-key.key 60 | OTOBO_NGINX_SSL_CERTIFICATE= 61 | OTOBO_NGINX_SSL_CERTIFICATE_KEY= 62 | 63 | # Kerberos Options 64 | 65 | # Kerberos keytab, default is /etc/krb5.keytab 66 | #OTOBO_NGINX_KERBEROS_KEYTAB=/opt/otobo-docker/nginx-conf/krb5.keytab 67 | 68 | # Kerberos config, default is /etc/krb5.conf as generated krb5.conf.template 69 | #OTOBO_NGINX_KERBEROS_CONFIG=/opt/otobo-docker/nginx-conf/krb5.conf 70 | 71 | # Kerberos Service Name 72 | OTOBO_NGINX_KERBEROS_SERVICE_NAME=HTTP/portal.rother-oss.com 73 | 74 | # Kerberos REALM 75 | OTOBO_NGINX_KERBEROS_REALM=ROTHER-OSS.COM 76 | 77 | # Kerberos kdc / AD Controller 78 | OTOBO_NGINX_KERBEROS_KDC=rother-oss.com 79 | 80 | # Kerberos Admin Server 81 | OTOBO_NGINX_KERBEROS_ADMIN_SERVER=rother-oss.com 82 | 83 | # Kerberos Default Domain 84 | OTOBO_NGINX_KERBEROS_DEFAULT_DOMAIN=rother-oss.com 85 | 86 | # Kerberos Substitute Template Directory 87 | NGINX_ENVSUBST_TEMPLATE_DIR= 88 | 89 | # Elasticsearch options 90 | OTOBO_ELASTICSEARCH_ES_JAVA_OPTS=-Xms512m -Xmx512m 91 | 92 | ################################################################################ 93 | # The Docker image for the service 'db' can be specified explicitly. 94 | # The default is mariadb:lts-noble 95 | ################################################################################ 96 | #OTOBO_IMAGE_DB= 97 | 98 | ################################################################################ 99 | # The Docker image for the services 'web' and 'daemon' can be specified explicitly. 100 | # The default is rotheross/otobo:latest-11_0 101 | ################################################################################ 102 | 103 | # Examples: 104 | #OTOBO_IMAGE_OTOBO=rotheross/otobo:rel-11_0_14 105 | #OTOBO_IMAGE_OTOBO=rotheross/otobo:devel-rel-11_0 106 | #OTOBO_IMAGE_OTOBO=otobo:local-11.0.x 107 | 108 | ################################################################################ 109 | # The Docker image for the service 'eleastic' can be specified explicitly. 110 | # The default is rotheross/otobo-elasticsearch:latest-11_0 111 | ################################################################################ 112 | 113 | # Examples: 114 | #OTOBO_IMAGE_OTOBO_ELASTICSEARCH=rotheross/otobo-elasticsearch:rel-11_0_14 115 | #OTOBO_IMAGE_OTOBO_ELASTICSEARCH=rotheross/otobo-elasticsearch:devel-rel-11_0 116 | #OTOBO_IMAGE_OTOBO_ELASTICSEARCH=otobo-elasticsearch:local-11.0.x 117 | 118 | ################################################################################ 119 | # The Docker image for the service 'redis' can be specified explicitly. 120 | # The default is redis:8-bookworm 121 | ################################################################################ 122 | #OTOBO_IMAGE_REDIS= 123 | 124 | ################################################################################ 125 | # The Docker image for the service 'nginx' can be specified explicitly. 126 | # The default image is rotheross/otobo-nginx-kerberos-webproxy:latest-11_0 127 | ################################################################################ 128 | 129 | # Examples: 130 | #OTOBO_IMAGE_OTOBO_NGINX=rotheross/otobo-nginx-kerberos-webproxy:rel-11_0_14 131 | #OTOBO_IMAGE_OTOBO_NGINX=rotheross/otobo-nginx-kerberos-webproxy:devel-rel-11_0 132 | #OTOBO_IMAGE_OTOBO_NGINX=otobo-nginx-kerberos-webproxy:local-11.0.x 133 | 134 | -------------------------------------------------------------------------------- /etc/templates/dot_env.m4: -------------------------------------------------------------------------------- 1 | m4_divert(-1) 2 | 3 | This file, etc/templates/dot_env.m4, is a M4 template file. The script script/devel/generate_sample_env_files.sh 4 | takes this template and generates the following files from it: 5 | 6 | .docker_compose_env_http 7 | .docker_compose_env_http_selenium 8 | .docker_compose_env_https 9 | .docker_compose_env_https_custom_nginx 10 | .docker_compose_env_https_kerberos 11 | .docker_compose_env_https_selenium 12 | 13 | These generated files are not used for running OTOBO. They are only sample files for the actual config file .env. 14 | Users can choose their use case and use the appropriate sample file as a starting point for their own .env file. 15 | 16 | Please adapt the macros otovar_MINOR_RELEASE_TAG, otovar_PATCH_LEVEL_TAG, otovar_DEVEL_TAG, and otovar_LOCAL_BUILD_TAG 17 | when creating new releases or development branches. 18 | See ./scripts/devel/generate_sample_env_files.sh -h for how to regenerate the sample file after making changes here. 19 | 20 | # These are the macros that should be adapted for new releases and new development branches. 21 | # All of these macros affect only comment lines in the generated sample .env files. 22 | m4_define(`otovar_MINOR_RELEASE_TAG',`latest-11_0') 23 | m4_define(`otovar_PATCH_LEVEL_TAG',`rel-11_0_14') 24 | m4_define(`otovar_DEVEL_TAG',`devel-rel-11_0') 25 | m4_define(`otovar_LOCAL_BUILD_TAG',`local-11.0.x') 26 | 27 | # Collect which services should be started by collecting the relevant 28 | # Docker Compose .yml files. The otobo-base.yml file is always needed. 29 | m4_define(`otovar_COMPOSE_FILE',`docker-compose/otobo-base.yml') 30 | 31 | # add the .yml file for HTTP 32 | m4_define( 33 | `otovar_COMPOSE_FILE', 34 | otovar_COMPOSE_FILE`'m4_ifdef( 35 | `otoflag_HTTP', 36 | `:docker-compose/otobo-override-http.yml', 37 | `')) 38 | 39 | # add the .yml file for HTTPS with Kerberos 40 | m4_define( 41 | `otovar_COMPOSE_FILE', 42 | otovar_COMPOSE_FILE`'m4_ifdef( 43 | `otoflag_KERBEROS', 44 | `:docker-compose/otobo-override-https-kerberos.yml', 45 | `')) 46 | 47 | # add the .yml file for HTTPS, including the custom config and the Selenium case 48 | m4_define( 49 | `otovar_COMPOSE_FILE', 50 | otovar_COMPOSE_FILE`'m4_ifdef( 51 | `otoflag_HTTPS', 52 | `:docker-compose/otobo-override-https.yml', 53 | `')) 54 | 55 | # add the .yml file for the custom Nginx config if required 56 | m4_define( 57 | `otovar_COMPOSE_FILE', 58 | otovar_COMPOSE_FILE`'m4_ifdef( 59 | `otoflag_CUSTOM_NGINX', 60 | `:docker-compose/otobo-nginx-custom-config.yml', 61 | `')) 62 | 63 | # add the .yml file for Selenium if required 64 | m4_define( 65 | `otovar_COMPOSE_FILE', 66 | otovar_COMPOSE_FILE`'m4_ifdef( 67 | `otoflag_SELENIUM', 68 | `:docker-compose/otobo-selenium.yml', 69 | `')) 70 | 71 | m4_divert(0)m4_dnl 72 | # This file contains default values for environment values that are needed either by Docker Compose itself 73 | # or by the docker compose files. 74 | 75 | # COMPOSE_PROJECT_NAME declares the prefix of the name of the Docker containers. So if the 76 | # project name is 'acme_support' then the web container is named either 'acme_support_web_1' for 77 | # Compose V1 or 'acme_support-web-1 for Compose V2. The project name also declares 78 | # the prefix of named volumes. Thus changing the project name allows to have 79 | # seperate containers and volumes for separate installations of OTOBO. 80 | # 81 | # Note that when COMPOSE_PROJECT_NAME is set in the shell environment, 82 | # then that setting has higher precedence. 83 | COMPOSE_PROJECT_NAME=otobo 84 | #COMPOSE_PROJECT_NAME=acme_support 85 | 86 | # COMPOSE_FILE is a collection of files, separated by COMPOSE_PATH_SEPARATOR, that make up the final config. 87 | # These files usually reside in the subdirectory docker-compose. 88 | # 89 | # Additional services can be added by concatenating more files to COMPOSE_FILE. An example would services 90 | # for S3 compatible storage. That is: :docker-compose/otobo-localstack.yml or :docker-compose/otobo-minio.yml. 91 | # An OpenLDAP server for use by the unit tests can be activated by appending :docker-compose/testing/openldap.yml. 92 | COMPOSE_PATH_SEPARATOR=: 93 | COMPOSE_FILE=otovar_COMPOSE_FILE 94 | 95 | # Database configuration 96 | # OTOBO_DB_ROOT_PASSWORD must be set 97 | OTOBO_DB_ROOT_PASSWORD= 98 | 99 | # Set this to a value in bytes to overwrite the default query size set for OTOBO 100 | #OTOBO_DB_QUERY_CACHE_SIZE= 101 | 102 | # HTTP options 103 | m4_ifdef( 104 | `otoflag_HTTP', 105 | `', 106 | `# In the HTTPS case http:// redirects to https:// 107 | ')m4_dnl 108 | # Set OTOBO_WEB_HTTP_PORT when the HTTP port is not 80 109 | #OTOBO_WEB_HTTP_PORT= 110 | 111 | # Set OTOBO_WEB_HTTP_IPADDR when only requests addressed to a specific IP should be served. 112 | # See https://docs.docker.com/compose/compose-file/compose-file-v3/#ports 113 | #OTOBO_WEB_HTTP_IPADDR= 114 | 115 | # The option OTOBO_WEB_OPTION influences which webserver is used with which options. 116 | # The default value is 'deployment' 117 | #OTOBO_WEB_OPTION=deployment # the default, should be used in production and most times during development 118 | #OTOBO_WEB_OPTION=development # can be useful during development, sets PLACK_ENV to 'development' 119 | #OTOBO_WEB_OPTION=shotgun # use the shotgun, start a new process for every request 120 | m4_ifdef( `otoflag_HTTP', `m4_divert(-1)')m4_dnl 121 | 122 | # HTTPS options 123 | 124 | # set OTOBO_WEB_HTTPS_PORT when the HTTPS port is not 443 125 | #OTOBO_WEB_HTTPS_PORT= 126 | 127 | # Set OTOBO_WEB_HTTPS_IPADDR when only requests addressed to a specific IP should be served. 128 | # See https://docs.docker.com/compose/compose-file/compose-file-v3/#ports 129 | #OTOBO_WEB_HTTPS_IPADDR= 130 | 131 | # The settings OTOBO_NGINX_SSL_CERTIFICATE and OTOBO_NGINX_SSL_CERTIFICATE_KEY 132 | # are mandatory when HTTPS is used. 133 | # The configured pathes must be absolute pathes that are available in the container. 134 | #OTOBO_NGINX_SSL_CERTIFICATE=/etc/nginx/ssl/ssl-cert.crt 135 | #OTOBO_NGINX_SSL_CERTIFICATE_KEY=/etc/nginx/ssl/ssl-key.key 136 | OTOBO_NGINX_SSL_CERTIFICATE= 137 | OTOBO_NGINX_SSL_CERTIFICATE_KEY= 138 | m4_ifdef( `otoflag_HTTP', `m4_divert(0)')m4_dnl 139 | m4_ifdef( `otoflag_KERBEROS', `', `m4_divert(-1)')m4_dnl 140 | 141 | # Kerberos Options 142 | 143 | # Kerberos keytab, default is /etc/krb5.keytab 144 | #OTOBO_NGINX_KERBEROS_KEYTAB=/opt/otobo-docker/nginx-conf/krb5.keytab 145 | 146 | # Kerberos config, default is /etc/krb5.conf as generated krb5.conf.template 147 | #OTOBO_NGINX_KERBEROS_CONFIG=/opt/otobo-docker/nginx-conf/krb5.conf 148 | 149 | # Kerberos Service Name 150 | OTOBO_NGINX_KERBEROS_SERVICE_NAME=HTTP/portal.rother-oss.com 151 | 152 | # Kerberos REALM 153 | OTOBO_NGINX_KERBEROS_REALM=ROTHER-OSS.COM 154 | 155 | # Kerberos kdc / AD Controller 156 | OTOBO_NGINX_KERBEROS_KDC=rother-oss.com 157 | 158 | # Kerberos Admin Server 159 | OTOBO_NGINX_KERBEROS_ADMIN_SERVER=rother-oss.com 160 | 161 | # Kerberos Default Domain 162 | OTOBO_NGINX_KERBEROS_DEFAULT_DOMAIN=rother-oss.com 163 | 164 | # Kerberos Substitute Template Directory 165 | NGINX_ENVSUBST_TEMPLATE_DIR= 166 | m4_ifdef( `otoflag_KERBEROS', `', `m4_divert(0)')m4_dnl 167 | 168 | # Elasticsearch options 169 | OTOBO_ELASTICSEARCH_ES_JAVA_OPTS=-Xms512m -Xmx512m 170 | 171 | ################################################################################ 172 | # The Docker image for the service 'db' can be specified explicitly. 173 | # The default is mariadb:lts-noble 174 | ################################################################################ 175 | #OTOBO_IMAGE_DB= 176 | 177 | ################################################################################ 178 | # The Docker image for the services 'web' and 'daemon' can be specified explicitly. 179 | `#' The default is rotheross/otobo:otovar_MINOR_RELEASE_TAG() 180 | ################################################################################ 181 | 182 | # Examples: 183 | `#'OTOBO_IMAGE_OTOBO=rotheross/otobo:otovar_PATCH_LEVEL_TAG() 184 | `#'OTOBO_IMAGE_OTOBO=rotheross/otobo:otovar_DEVEL_TAG() 185 | `#'OTOBO_IMAGE_OTOBO=otobo:otovar_LOCAL_BUILD_TAG() 186 | 187 | ################################################################################ 188 | # The Docker image for the service 'eleastic' can be specified explicitly. 189 | `#' The default is rotheross/otobo-elasticsearch:otovar_MINOR_RELEASE_TAG() 190 | ################################################################################ 191 | 192 | # Examples: 193 | `#'OTOBO_IMAGE_OTOBO_ELASTICSEARCH=rotheross/otobo-elasticsearch:otovar_PATCH_LEVEL_TAG() 194 | `#'OTOBO_IMAGE_OTOBO_ELASTICSEARCH=rotheross/otobo-elasticsearch:otovar_DEVEL_TAG() 195 | `#'OTOBO_IMAGE_OTOBO_ELASTICSEARCH=otobo-elasticsearch:otovar_LOCAL_BUILD_TAG() 196 | 197 | ################################################################################ 198 | # The Docker image for the service 'redis' can be specified explicitly. 199 | # The default is redis:8-bookworm 200 | ################################################################################ 201 | #OTOBO_IMAGE_REDIS= 202 | 203 | m4_divert(-1)m4_dnl 204 | 205 | # find the image used for Nginx service 206 | m4_define( 207 | `otovar_NGINX_IMAGE', 208 | m4_ifdef( 209 | `otoflag_KERBEROS', 210 | `otobo-nginx-kerberos-webproxy', 211 | `otobo-nginx-webproxy')) 212 | 213 | m4_divert(0)m4_dnl 214 | m4_ifdef( `otoflag_HTTP', `m4_divert(-1)')m4_dnl 215 | ################################################################################ 216 | # The Docker image for the service 'nginx' can be specified explicitly. 217 | `#' The default image is rotheross/otovar_NGINX_IMAGE():otovar_MINOR_RELEASE_TAG() 218 | ################################################################################ 219 | 220 | # Examples: 221 | `#'OTOBO_IMAGE_OTOBO_NGINX=rotheross/otovar_NGINX_IMAGE():otovar_PATCH_LEVEL_TAG() 222 | `#'OTOBO_IMAGE_OTOBO_NGINX=rotheross/otovar_NGINX_IMAGE():otovar_DEVEL_TAG() 223 | `#'OTOBO_IMAGE_OTOBO_NGINX=otovar_NGINX_IMAGE():otovar_LOCAL_BUILD_TAG() 224 | 225 | m4_ifdef( `otoflag_HTTP', `m4_divert(0)')m4_dnl 226 | m4_ifdef( `otoflag_CUSTOM_NGINX', `', `m4_divert(-1)')m4_dnl 227 | 228 | # provide a custom Nginx config template dir 229 | NGINX_ENVSUBST_TEMPLATE_DIR=/etc/nginx/config/template-custom 230 | m4_ifdef( `otoflag_CUSTOM_NGINX', `', `m4_divert(0)')m4_dnl 231 | m4_ifdef( `otoflag_SELENIUM', `', `m4_divert(-1)')m4_dnl 232 | ################################################################################ 233 | # The Docker image for the service 'selenium' can be specified explicitly. 234 | `#' The default image is rotheross/otobo-selenium-chrome:otovar_MINOR_RELEASE_TAG() 235 | ################################################################################ 236 | 237 | # Examples: 238 | `#'OTOBO_IMAGE_OTOBO_SELENIUM_CHROME=rotheross/otobo-selenium-chrome:otovar_PATCH_LEVEL_TAG() 239 | `#'OTOBO_IMAGE_OTOBO_SELENIUM_CHROME=rotheross/otobo-selenium-chrome:otovar_DEVEL_TAG() 240 | `#'OTOBO_IMAGE_OTOBO_SELENIUM_CHROME=otobo-selenium-chrome:otovar_LOCAL_BUILD_TAG() 241 | 242 | m4_ifdef( `otoflag_SELENIUM', `', `m4_divert(0)')m4_dnl 243 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------