{"id":15140800,"url":"https://github.com/robertdebock/ansible-role-tomcat","last_synced_at":"2025-04-05T23:08:48.861Z","repository":{"id":39526454,"uuid":"115107997","full_name":"robertdebock/ansible-role-tomcat","owner":"robertdebock","description":"Install and configure tomcat on your system.","archived":false,"fork":false,"pushed_at":"2025-03-06T16:21:47.000Z","size":27680,"stargazers_count":46,"open_issues_count":14,"forks_count":59,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-29T22:06:56.975Z","etag":null,"topics":["ansible","molecule","playbook","system","tomcat","tox"],"latest_commit_sha":null,"homepage":"https://robertdebock.nl/","language":"Jinja","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/robertdebock.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"robertdebock"}},"created_at":"2017-12-22T11:08:08.000Z","updated_at":"2025-03-06T16:09:26.000Z","dependencies_parsed_at":"2023-02-15T07:45:51.090Z","dependency_job_id":"871e4ddf-9568-48c0-9d8d-f4f808a1589c","html_url":"https://github.com/robertdebock/ansible-role-tomcat","commit_stats":{"total_commits":574,"total_committers":14,"mean_commits":41.0,"dds":"0.11149825783972123","last_synced_commit":"4cbb213dab84285780856cf5bc0e13b4e9be2ed7"},"previous_names":[],"tags_count":85,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/robertdebock%2Fansible-role-tomcat","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/robertdebock%2Fansible-role-tomcat/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/robertdebock%2Fansible-role-tomcat/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/robertdebock%2Fansible-role-tomcat/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/robertdebock","download_url":"https://codeload.github.com/robertdebock/ansible-role-tomcat/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247411234,"owners_count":20934653,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ansible","molecule","playbook","system","tomcat","tox"],"created_at":"2024-09-26T08:41:25.704Z","updated_at":"2025-04-05T23:08:48.837Z","avatar_url":"https://github.com/robertdebock.png","language":"Jinja","funding_links":["https://github.com/sponsors/robertdebock"],"categories":[],"sub_categories":[],"readme":"# [Ansible role tomcat](#tomcat)\n\nInstall and configure tomcat on your system.\n\n|GitHub|GitLab|Downloads|Version|\n|------|------|---------|-------|\n|[![github](https://github.com/robertdebock/ansible-role-tomcat/workflows/Ansible%20Molecule/badge.svg)](https://github.com/robertdebock/ansible-role-tomcat/actions)|[![gitlab](https://gitlab.com/robertdebock-iac/ansible-role-tomcat/badges/master/pipeline.svg)](https://gitlab.com/robertdebock-iac/ansible-role-tomcat)|[![downloads](https://img.shields.io/ansible/role/d/robertdebock/tomcat)](https://galaxy.ansible.com/robertdebock/tomcat)|[![Version](https://img.shields.io/github/release/robertdebock/ansible-role-tomcat.svg)](https://github.com/robertdebock/ansible-role-tomcat/releases/)|\n\n## [Example Playbook](#example-playbook)\n\nThis example is taken from [`molecule/default/converge.yml`](https://github.com/robertdebock/ansible-role-tomcat/blob/master/molecule/default/converge.yml) and is tested on each push, pull request and release.\n\n```yaml\n---\n- name: Converge\n  hosts: all\n  become: true\n  gather_facts: true\n\n  vars:\n    # tomcat_address: \"127.0.0.1\"\n    tomcat_instances:\n      - name: \"tomcat\"\n      # - name: \"tomcat-version-7\"\n      #   version: 7\n      #   shutdown_port: 8007\n      #   non_ssl_connector_port: 8082\n      #   ssl_connector_port: 8445\n      #   ajp_port: 8011\n      # - name: \"tomcat-version-8\"\n      #   version: 8\n      #   shutdown_port: 8008\n      #   non_ssl_connector_port: 8083\n      #   ssl_connector_port: 8446\n      #   ajp_port: 8012\n      # - name: \"tomcat-version-9\"\n      #   version: 9\n      #   shutdown_port: 8019\n      #   non_ssl_connector_port: 8084\n      #   ssl_connector_port: 8447\n      #   ajp_port: 8013\n      # - name: \"tomcat-specific\"\n      #   user: \"specificuser\"\n      #   group: \"specificgroup\"\n      #   shutdown_port: 8020\n      #   shutdown_pass: shutme\n      #   non_ssl_connector_port: 8085\n      #   ssl_connector_port: 8448\n      #   ajp_port: 8014\n      #   xms: 256M\n      #   xmx: 512M\n      # - name: \"tomcat-with-wars\"\n      #   shutdown_port: 8021\n      #   non_ssl_connector_port: 8086\n      #   ssl_connector_port: 8449\n      #   ajp_port: 8015\n      #   wars:\n      #     - url: https://tomcat.apache.org/tomcat-7.0-doc/appdev/sample/sample.war\n      #     - url: \"https://github.com/aeimer/java-example-helloworld-war/raw/master/dist/helloworld.war\"\n      #       context_name: \"my-helloworld\"  # Store helloword.war as my-helloworld\n      # - name: \"tomcat-java_opts\"\n      #   shutdown_port: 8022\n      #   non_ssl_connector_port: 8087\n      #   ssl_connector_port: 8449\n      #   ajp_port: 8016\n      #   java_opts:\n      #     - name: UMASK\n      #       value: \"0007\"\n      # - name: \"tomcat-with_lib\"\n      #   shutdown_port: 8023\n      #   non_ssl_connector_port: 8088\n      #   ssl_connector_port: 8450\n      #   ajp_port: 8017\n      #   libs:\n      #     - url: \"https://search.maven.org/remotecontent?filepath=io/prometheus/simpleclient/0.6.0/simpleclient-0.6.0.jar\"\n      # - name: \"tomcat-access-logs\"\n      #   shutdown_port: 8024\n      #   non_ssl_connector_port: 8089\n      #   ssl_connector_port: 8451\n      #   ajp_port: 8018\n      #   access_log_enabled: true\n      #   access_log_directory: \"my-logs\"\n      #   access_log_prefix: my-access-logs\n      #   access_log_suffix: \".log\"\n      #   access_log_pattern: \"%h %l %u %t \u0026quot;%r\u0026quot; %s %b\"\n      # - name: \"tomcat-config-files\"\n      #   shutdown_port: 8025\n      #   non_ssl_connector_port: 8090\n      #   ssl_connector_port: 8452\n      #   ajp_port: 8019\n      #   ajp_secret: \"SoMe-SeCrEt\"\n      #   config_files:\n      #     - src: \"{{ role_path }}/files/dummy.properties\"\n      #       dest: \"./\"\n      #       mode: \"0644\"\n      # - name: \"tomcat-context\"\n      #   shutdown_port: 8026\n      #   shutdown_pass: shutme\n      #   non_ssl_connector_port: 8091\n      #   ssl_connector_port: 8453\n      #   ajp_port: 8020\n      #   context: |\n      #     \u003cContext\u003e\n      #       \u003cManager className=\"org.apache.catalina.session.PersistentManager\" maxIdleSwap=\"10000\" maxIdleBackup=\"10000\" /\u003e\n      #     \u003c/Context\u003e\n      # - name: \"tomcat-empty\"\n      #   shutdown_port: 8027\n      #   shutdown_pass: shutme\n      #   non_ssl_connector_port: 8092\n      #   ssl_connector_port: 8454\n      #   ajp_port: 8021\n      #   cleanup_enabled: true\n      #   remove_webapps:\n      #     - docs\n      #     - examples\n      #     - host-manager\n      #     - manager\n      #     - ROOT\n      # - name: \"tomcat-java_home\"\n      #   java_home: \"/opt/java/jdk-17\"\n\n  roles:\n    - role: robertdebock.tomcat\n```\n\nThe machine needs to be prepared. In CI this is done using [`molecule/default/prepare.yml`](https://github.com/robertdebock/ansible-role-tomcat/blob/master/molecule/default/prepare.yml):\n\n```yaml\n---\n- name: Prepare\n  hosts: all\n  become: true\n  gather_facts: false\n\n  roles:\n    - role: robertdebock.bootstrap\n    - role: robertdebock.core_dependencies\n    - role: robertdebock.java\n      # __java_version:\n      #   default: 8\n      #   Debian: 11\n      #   Debian-bookworm: 17\n      # java_version: \"{{ _desired_java_version[ansible_distribution ~ '-' ~ ansible_distribution_release] | default(_desired_java_version[ansible_distribution] | default(_desired_java_version['default'])) }}\"\n```\n\nAlso see a [full explanation and example](https://robertdebock.nl/how-to-use-these-roles.html) on how to use these roles.\n\n## [Role Variables](#role-variables)\n\nThe default values for the variables are set in [`defaults/main.yml`](https://github.com/robertdebock/ansible-role-tomcat/blob/master/defaults/main.yml):\n\n```yaml\n---\n# defaults file for tomcat\n\n# Some \"sane\" defaults.\ntomcat_name: tomcat\ntomcat_directory: /opt\ntomcat_version: 10\ntomcat_user: tomcat\ntomcat_group: tomcat\ntomcat_xms: 512M\ntomcat_xmx: 1024M\ntomcat_non_ssl_connector_port: 8080\ntomcat_ssl_connector_port: 8443\ntomcat_shutdown_port: 8005\ntomcat_shutdown_pass: SHUTDOWN\ntomcat_ajp_enabled: true\ntomcat_ajp_port: 8009\ntomcat_ajp_secret: \"SoMe-SeCrEt\"\ntomcat_jre_home: /usr\ntomcat_service_state: started\ntomcat_service_enabled: true\n# You can bind Tomcat to a specified address globally using this variable, or\n# in the `tomcat_instances`. The `tomcat_instances.address` is more specific\n# so it takes priority over `tomcat_address`.\ntomcat_address: \"0.0.0.0\"\n\n# Configure tomcat access logs\ntomcat_access_log_enabled: true\ntomcat_access_log_directory: logs\ntomcat_access_log_prefix: localhost_access_log\ntomcat_access_log_suffix: \".txt\"\ntomcat_access_log_pattern: \"%h %l %u %t \u0026quot;%r\u0026quot; %s %b\"\n\n# This role allows multiple installations of Apache Tomcat, each in their own\n# location, potentially of different version.\n# This is done by defining a \"tomcat_instances\" where \"name:\" is a unique\n# identifier of an instance.\n# The default tomcat_instances is one instance using the defaults described\n# in defaults/main.yml.\ntomcat_instances:\n  - name: \"{{ tomcat_name }}\"\n    version: \"{{ tomcat_version }}\"\n    user: \"{{ tomcat_user }}\"\n    group: \"{{ tomcat_group }}\"\n    xms: \"{{ tomcat_xms }}\"\n    xmx: \"{{ tomcat_xmx }}\"\n    non_ssl_connector_port: \"{{ tomcat_non_ssl_connector_port }}\"\n    ssl_connector_port: \"{{ tomcat_ssl_connector_port }}\"\n    shutdown_port: \"{{ tomcat_shutdown_port }}\"\n    ajp_enabled: \"{{ tomcat_ajp_enabled }}\"\n    ajp_port: \"{{ tomcat_ajp_port }}\"\n    ajp_secret: \"{{ tomcat_ajp_secret }}\"\n    # You can pick an address per instance:\n    # address: \"127.0.0.1\"\n    packet_size: 8192\n    java_opts:\n      - name: JRE_HOME\n        value: \"{{ tomcat_jre_home }}\"\n    access_log_enabled: \"{{ tomcat_access_log_enabled }}\"\n    access_log_directory: \"{{ tomcat_access_log_directory }}\"\n    access_log_prefix: \"{{ tomcat_access_log_prefix }}\"\n    access_log_suffix: \"{{ tomcat_access_log_suffix }}\"\n    access_log_pattern: \"{{ tomcat_access_log_pattern }}\"\n    service_state: \"{{ tomcat_service_state }}\"\n    service_enabled: \"{{ tomcat_service_enabled }}\"\n\n# The explicit version to use when referring to the short name.\ntomcat_version7: \"7.0.109\"\ntomcat_version8: \"8.5.100\"\ntomcat_version9: \"9.0.100\"\ntomcat_version10: \"10.1.36\"\n\n# The location where to download Apache Tomcat from.\ntomcat_mirror: \"https://archive.apache.org\"\n```\n\n## [Requirements](#requirements)\n\n- pip packages listed in [requirements.txt](https://github.com/robertdebock/ansible-role-tomcat/blob/master/requirements.txt).\n\n## [State of used roles](#state-of-used-roles)\n\nThe following roles are used to prepare a system. You can prepare your system in another way.\n\n| Requirement | GitHub | GitLab |\n|-------------|--------|--------|\n|[robertdebock.bootstrap](https://galaxy.ansible.com/robertdebock/bootstrap)|[![Build Status GitHub](https://github.com/robertdebock/ansible-role-bootstrap/workflows/Ansible%20Molecule/badge.svg)](https://github.com/robertdebock/ansible-role-bootstrap/actions)|[![Build Status GitLab](https://gitlab.com/robertdebock-iac/ansible-role-bootstrap/badges/master/pipeline.svg)](https://gitlab.com/robertdebock-iac/ansible-role-bootstrap)|\n|[robertdebock.core_dependencies](https://galaxy.ansible.com/robertdebock/core_dependencies)|[![Build Status GitHub](https://github.com/robertdebock/ansible-role-core_dependencies/workflows/Ansible%20Molecule/badge.svg)](https://github.com/robertdebock/ansible-role-core_dependencies/actions)|[![Build Status GitLab](https://gitlab.com/robertdebock-iac/ansible-role-core_dependencies/badges/master/pipeline.svg)](https://gitlab.com/robertdebock-iac/ansible-role-core_dependencies)|\n|[robertdebock.java](https://galaxy.ansible.com/robertdebock/java)|[![Build Status GitHub](https://github.com/robertdebock/ansible-role-java/workflows/Ansible%20Molecule/badge.svg)](https://github.com/robertdebock/ansible-role-java/actions)|[![Build Status GitLab](https://gitlab.com/robertdebock-iac/ansible-role-java/badges/master/pipeline.svg)](https://gitlab.com/robertdebock-iac/ansible-role-java)|\n|[robertdebock.service](https://galaxy.ansible.com/robertdebock/service)|[![Build Status GitHub](https://github.com/robertdebock/ansible-role-service/workflows/Ansible%20Molecule/badge.svg)](https://github.com/robertdebock/ansible-role-service/actions)|[![Build Status GitLab](https://gitlab.com/robertdebock-iac/ansible-role-service/badges/master/pipeline.svg)](https://gitlab.com/robertdebock-iac/ansible-role-service)|\n\n## [Context](#context)\n\nThis role is a part of many compatible roles. Have a look at [the documentation of these roles](https://robertdebock.nl/) for further information.\n\nHere is an overview of related roles:\n![dependencies](https://raw.githubusercontent.com/robertdebock/ansible-role-tomcat/png/requirements.png \"Dependencies\")\n\n## [Compatibility](#compatibility)\n\nThis role has been tested on these [container images](https://hub.docker.com/u/robertdebock):\n\n|container|tags|\n|---------|----|\n|[EL](https://hub.docker.com/r/robertdebock/enterpriselinux)|9|\n|[Debian](https://hub.docker.com/r/robertdebock/debian)|all|\n|[Fedora](https://hub.docker.com/r/robertdebock/fedora)|all|\n|[Ubuntu](https://hub.docker.com/r/robertdebock/ubuntu)|all|\n\nThe minimum version of Ansible required is 2.12, tests have been done to:\n\n- The previous version.\n- The current version.\n- The development version.\n\nIf you find issues, please register them in [GitHub](https://github.com/robertdebock/ansible-role-tomcat/issues).\n\n## [License](#license)\n\n[Apache-2.0](https://github.com/robertdebock/ansible-role-tomcat/blob/master/LICENSE).\n\n## [Author Information](#author-information)\n\n[robertdebock](https://robertdebock.nl/)\n\nPlease consider [sponsoring me](https://github.com/sponsors/robertdebock).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frobertdebock%2Fansible-role-tomcat","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frobertdebock%2Fansible-role-tomcat","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frobertdebock%2Fansible-role-tomcat/lists"}