behaimits/makedoc-server repository overview

⁠MakeDoc

MakeDoc is a documentation tool providing a static documentation and analysis of selected SW technologies and products (TIBCO BW5/6, BWCE, EMS, iProcess) and it is maintained and sold by Behaim ITS company (https://www.behaimits.com⁠). In case of issues, interest or pricing questions, please contact us at [email protected]⁠.

This image provides you with the server version of MakeDoc.

⁠How to run the Docker container?

⁠1. As a standalone container:

docker pull behaimits/makedoc-server:4.4.5

docker run -d \
  --name makedoc-jenkins \
  -p 9080:8080 \
  -v $(pwd)/projects:/opt/makedoc/projects \
  -v $(pwd)/jenkins_home:/var/jenkins_home \
  -v $(pwd)/storages:/opt/makedoc/storages \
  behaimits/makedoc-server:4.4.5

⁠2. Prepare Required Directories

Ensure all necessary directories exist before running Docker Compose. If not, create them:

mkdir -p projects storages portal

These directories will be automatically mounted by the container:

• projects/ — Place your BW5/6 projects and makedoc.key license file here
• storages/ — Generated documentation outputs will be stored here
• portal/ — Portal application outputs (when using docker compose)

⁠3. As a part of a docker compose app that includes behaimits/makedoc-tomcat:

Example compose.yml:

services:
  makedoc-jenkins:
    container_name: makedoc-jenkins
    image: behaimits/makedoc-server:4.4.5 
    ports: 
      - 9080:8080
    volumes:
      - ./projects:/opt/makedoc/projects
      - shared-jenkins-volume:/var/jenkins_home
      - shared-portal-volume:/opt/makedoc/portal
      - shared-storage-volume:/opt/makedoc/storages
  makedoc-tomcat:
    container_name: makedoc-tomcat
    image: behaimits/makedoc-tomcat:4.4.5
    ports: 
      - 9081:8080
    volumes:
      - shared-portal-volume:/usr/local/tomcat/webapps/portal
      - shared-storage-volume:/usr/local/tomcat/webapps/storage
volumes:
  shared-portal-volume:
    driver: local
    driver_opts:
      device: ./portal
      type: none
      o: bind
  shared-storage-volume:
    driver: local
    driver_opts:
      device: ./storages
      type: none
      o: bind
  shared-jenkins-volume:

⁠Notes:

• Add the projects you want to generate documentation for to the projects directory.
• The Makedoc license key (makedoc.key) should be placed in the projects directory.
• The service will be accessible at localhost:9080 (Jenkins) and localhost:9081/portal (Portal, when using docker compose)