docker-compose-dev.yml

version: "2.4"

services:

  dev_dataverse:
    container_name: "dev_dataverse"
    hostname: dataverse
    image: ${APP_IMAGE}
    restart: on-failure
    user: payara
    environment:
      DATAVERSE_DB_HOST: postgres
      DATAVERSE_DB_PASSWORD: secret
      DATAVERSE_DB_USER: ${DATAVERSE_DB_USER}
      ENABLE_JDWP: "1"
      ENABLE_RELOAD: "1"
      SKIP_DEPLOY: "${SKIP_DEPLOY}"
      # Java agents to attach, see JAVA_AGENTS in the base image guide (empty: none)
      JAVA_AGENTS: "${JAVA_AGENTS}"
      DATAVERSE_JSF_REFRESH_PERIOD: "1"
      DATAVERSE_FEATURE_API_BEARER_AUTH: "1"
      DATAVERSE_FEATURE_INDEX_HARVESTED_METADATA_SOURCE: "1"
      DATAVERSE_FEATURE_API_BEARER_AUTH_PROVIDE_MISSING_CLAIMS: "1"
      DATAVERSE_FEATURE_API_BEARER_AUTH_USE_BUILTIN_USER_ON_ID_MATCH: "1"
      DATAVERSE_MAIL_SYSTEM_EMAIL: "dataverse@localhost"
      DATAVERSE_MAIL_MTA_HOST: "smtp"
      DATAVERSE_AUTH_OIDC_ENABLED: "1"
      DATAVERSE_AUTH_OIDC_HIDDEN_JSF: "1"
      DATAVERSE_AUTH_OIDC_CLIENT_ID: test
      DATAVERSE_AUTH_OIDC_CLIENT_SECRET: 94XHrfNRwXsjqTqApRrwWmhDLDHpIYV8
      DATAVERSE_AUTH_OIDC_AUTH_SERVER_URL: http://keycloak.mydomain.com:8090/realms/test
      DATAVERSE_SPI_EXPORTERS_DIRECTORY: "/dv/exporters"
      # These two oai settings are here to get HarvestingServerIT to pass
      dataverse_oai_server_maxidentifiers: "2"
      dataverse_oai_server_maxrecords: "2"
      JVM_ARGS: -Ddataverse.files.storage-driver-id=file1
        -Ddataverse.files.file1.type=file
        -Ddataverse.files.file1.label=Filesystem
        -Ddataverse.files.file1.directory=${STORAGE_DIR}/store
        -Ddataverse.files.localstack1.type=s3
        -Ddataverse.files.localstack1.label=LocalStack
        -Ddataverse.files.localstack1.custom-endpoint-url=http://localstack:4566
        -Ddataverse.files.localstack1.custom-endpoint-region=us-east-2
        -Ddataverse.files.localstack1.bucket-name=mybucket
        -Ddataverse.files.localstack1.path-style-access=true
        -Ddataverse.files.localstack1.upload-redirect=true
        -Ddataverse.files.localstack1.download-redirect=true
        -Ddataverse.files.localstack1.access-key=default
        -Ddataverse.files.localstack1.secret-key=default
        -Ddataverse.files.localstack_noredirect.type=s3
        -Ddataverse.files.localstack_noredirect.label=LocalStackNoRedirect
        -Ddataverse.files.localstack_noredirect.custom-endpoint-url=http://localstack:4566
        -Ddataverse.files.localstack_noredirect.custom-endpoint-region=us-east-2
        -Ddataverse.files.localstack_noredirect.bucket-name=mybucket-noredirect
        -Ddataverse.files.localstack_noredirect.path-style-access=true
        -Ddataverse.files.localstack_noredirect.upload-redirect=false
        -Ddataverse.files.localstack_noredirect.download-redirect=false
        -Ddataverse.files.localstack_noredirect.access-key=default
        -Ddataverse.files.localstack_noredirect.secret-key=default
        -Ddataverse.files.s3.type=s3
        -Ddataverse.files.s3.label=S3
        -Ddataverse.files.s3.custom-endpoint-url=http://s3.localhost:4566
        -Ddataverse.files.s3.custom-endpoint-region=us-east-2
        -Ddataverse.files.s3.bucket-name=mybucket
        -Ddataverse.files.s3.path-style-access=true
        -Ddataverse.files.s3.upload-redirect=true
        -Ddataverse.files.s3.download-redirect=true
        -Ddataverse.files.s3.access-key=default
        -Ddataverse.files.s3.secret-key=default
        -Ddataverse.pid.providers=fake
        -Ddataverse.pid.default-provider=fake
        -Ddataverse.pid.fake.type=FAKE
        -Ddataverse.pid.fake.label=FakeDOIProvider
        -Ddataverse.pid.fake.authority=10.5072
        -Ddataverse.pid.fake.shoulder=FK2/
        -Ddataverse.cors.origin=* \
        -Ddataverse.cors.methods=GET,POST,PUT,DELETE,OPTIONS \
        -Ddataverse.cors.headers.allow=range,content-type,x-dataverse-key,accept \
        -Ddataverse.cors.headers.expose=content-encoding,content-range,accept-ranges \
        #-Ddataverse.files.guestbook-at-request=true
        #-Ddataverse.lang.directory=/dv/lang
    ports:
      - "8080:8080" # HTTP (Dataverse Application)
      - "4949:4848" # HTTPS (Payara Admin Console)
      - "9009:9009" # JDWP
      - "8686:8686" # JMX
      - "6300:6300" # JaCoCo agent, when attached via JAVA_AGENTS
    networks:
      - dataverse
    depends_on:
      - dev_postgres
      - dev_solr
      - dev_dv_initializer
    volumes:
      - ./docker-dev-volumes/app/data:/dv
      - ./docker-dev-volumes/app/secrets:/secrets
      - ./target/dataverse:/opt/payara/deployments/dataverse:ro
    tmpfs:
      - /dumps:mode=770,size=2052M,uid=1000,gid=1000
      - /tmp:mode=770,size=2052M,uid=1000,gid=1000
    mem_limit: 2684354560 # 2.5 GiB
    mem_reservation: 1024m
    privileged: false

  dev_bootstrap:
    container_name: "dev_bootstrap"
    image: gdcc/configbaker:unstable
    restart: "no"
    command:
      - bootstrap.sh
      - dev
    networks:
      - dataverse
    volumes:
      - ./docker-dev-volumes/solr/data:/var/solr

  dev_dv_initializer:
    container_name: "dev_dv_initializer"
    image: gdcc/configbaker:unstable
    restart: "no"
    command:
      - sh
      - -c
      - "fix-fs-perms.sh dv"
    volumes:
      - ./docker-dev-volumes/app/data:/dv

  dev_postgres:
    container_name: "dev_postgres"
    hostname: postgres
    image: postgres:${POSTGRES_VERSION}
    restart: on-failure
    environment:
      - POSTGRES_USER=${DATAVERSE_DB_USER}
      - POSTGRES_PASSWORD=secret
    ports:
      - "5432:5432"
    networks:
      - dataverse
    volumes:
      - ./docker-dev-volumes/postgresql/data:/var/lib/postgresql/data

  dev_solr_initializer:
    container_name: "dev_solr_initializer"
    image: gdcc/configbaker:unstable
    restart: "no"
    command:
      - sh
      - -c
      - "fix-fs-perms.sh solr && cp -a /template/* /solr-template"
    volumes:
      - ./docker-dev-volumes/solr/data:/var/solr
      - ./docker-dev-volumes/solr/conf:/solr-template

  # This is optional. Uncomment to try and experiment with schema sidecar.
  # dev_solr_schema_sidecar:
  #   container_name: "dev_solr_schema_sidecar"
  #   hostname: "solr-schema"
  #   image: gdcc/configbaker:unstable
  #   depends_on:
  #     - dev_dv_initializer
  #     - dev_solr
  #   restart: on-failure
  #   networks:
  #     - dataverse
  #   # Note: no quotes here - they will become part of the arguments passed to the script!
  #   command: >-
  #     solr-driver.sh --mode watch --startup-check wait
  #     --dataverse-url http://dataverse:8080
  #     --solr-url http://solr:8983
  #     --core collection1
  #   volumes:
  #     - ./docker-dev-volumes/solr/data:/var/solr

  dev_solr:
    container_name: "dev_solr"
    hostname: "solr"
    image: solr:${SOLR_VERSION}
    depends_on:
      - dev_solr_initializer
    restart: on-failure
    ports:
      - "8983:8983"
    environment:
      - SOLR_OPTS=-Dsolr.jetty.request.header.size=102400 -Dsolr.autoSoftCommit.maxTime=100
    networks:
      - dataverse
    command:
      - "solr-precreate"
      - "collection1"
      - "/template"
    volumes:
      - ./docker-dev-volumes/solr/data:/var/solr
      - ./docker-dev-volumes/solr/conf:/template

  dev_smtp:
    container_name: "dev_smtp"
    hostname: "smtp"
    image: maildev/maildev:2.0.5
    restart: on-failure
    ports:
      - "25:25" # smtp server
      - "1080:1080" # web ui
    environment:
      - MAILDEV_SMTP_PORT=25
      - MAILDEV_MAIL_DIRECTORY=/mail
    networks:
      - dataverse
    #volumes:
    #  - ./docker-dev-volumes/smtp/data:/mail
    tmpfs:
      - /mail:mode=770,size=128M,uid=1000,gid=1000

  dev_keycloak:
    container_name: "dev_keycloak"
    # Custom image with the Dataverse builtin users SPI; imports test-realm-include-spi.json
    build:
      context: ./conf/keycloak
      dockerfile: Dockerfile
    image: gdcc/keycloak
    hostname: keycloak
    depends_on:
      - dev_postgres
    environment:
      - KEYCLOAK_ADMIN=kcadmin
      - KEYCLOAK_ADMIN_PASSWORD=kcpassword
      - KEYCLOAK_LOGLEVEL=DEBUG
      - KC_HOSTNAME_STRICT=false
      # Browser-facing URL is the nginx proxy (dev_nginx) so the SPA and Dataverse agree on the issuer
      - KC_HOSTNAME=http://localhost:8000
      - KC_HOSTNAME_BACKCHANNEL_DYNAMIC=true
      # Used by the builtin users SPI to read the Dataverse database
      - DATAVERSE_DB_HOST=postgres
      - DATAVERSE_DB_PORT=5432
      - DATAVERSE_DB_USER=${DATAVERSE_DB_USER}
      - DATAVERSE_DB_PASSWORD=secret
    networks:
      dataverse:
        aliases:
          - keycloak.mydomain.com #create a DNS alias within the network (add the same alias to your /etc/hosts to get a working OIDC flow)
    command: start-dev --import-realm --http-port=8090  # change port to 8090, so within the network and external the same port is used
    ports:
      - "8090:8090"

  # Registers the builtin users SPI in the test realm (kept out of the realm JSON so a stock Keycloak can import it)
  dev_keycloak_initializer:
    container_name: "dev_keycloak_initializer"
    image: alpine:latest
    restart: "no"
    depends_on:
      - dev_keycloak
    environment:
      - KEYCLOAK_ADMIN=kcadmin
      - KEYCLOAK_ADMIN_PASSWORD=kcpassword
    volumes:
      - ./conf/keycloak/setup-spi.sh:/usr/local/bin/setup-spi.sh:ro
    command: [ "/bin/sh", "-c", "apk add --no-cache curl jq && /usr/local/bin/setup-spi.sh" ]
    networks:
      - dataverse

  # Reverse proxy on port 8000 for the SPA (dataverse-frontend running "npm start -- --host" on the host)
  dev_nginx:
    container_name: "dev_nginx"
    image: nginx:stable
    ports:
      - "8000:80"
    depends_on:
      - dev_dataverse
      - dev_keycloak
    networks:
      - dataverse
    volumes:
      - ./conf/nginx-spa/nginx.conf:/etc/nginx/nginx.conf:ro

  # This proxy configuration is only intended to be used for development purposes!
  # DO NOT USE IN PRODUCTION! HIGH SECURITY RISK!
  dev_proxy:
    image: caddy:2-alpine
    # The command below is enough to enable using the admin gui, but it will not rewrite location headers to HTTP.
    # To achieve rewriting from https:// to http://, we need a simple configuration file
    #command: ["caddy", "reverse-proxy", "-f", ":4848", "-t", "https://dataverse:4848", "--insecure"]
    command: ["caddy", "run", "-c", "/Caddyfile"]
    ports:
      - "4848:4848" # Will expose Payara Admin Console (HTTPS) as HTTP
    restart: always
    volumes:
      - ./conf/proxy/Caddyfile:/Caddyfile:ro
    depends_on:
      - dev_dataverse
    networks:
      - dataverse

  dev_localstack:
    container_name: "dev_localstack"
    hostname: "localstack"
    image: localstack/localstack:4.2.0
    restart: on-failure
    ports:
      - "127.0.0.1:4566:4566"
    environment:
      - DEBUG=${DEBUG-}
      - DOCKER_HOST=unix:///var/run/docker.sock
      - HOSTNAME_EXTERNAL=localstack
    networks:
      dataverse:
        # Same hostname from browsers (*.localhost resolves to loopback) and containers, so presigned URLs from the "s3" store work in both
        aliases:
          - s3.localhost
    volumes:
      - ./conf/localstack:/etc/localstack/init/ready.d
    tmpfs:
      - /localstack:mode=770,size=128M,uid=1000,gid=1000

  previewers-provider:
    container_name: previewers-provider
    hostname: previewers-provider
    image: trivadis/dataverse-previewers-provider:latest
    ports:
      - "9080:9080"
    networks:
      - dataverse
    environment:
      # have nginx match the port we run previewers on
      - NGINX_HTTP_PORT=9080
      - PREVIEWERS_PROVIDER_URL=http://localhost:9080
      - VERSIONS="v1.4,betatest"
    # https://docs.docker.com/reference/compose-file/services/#platform
    # https://github.com/fabric8io/docker-maven-plugin/issues/1750
    platform: linux/amd64

  register-previewers:
    container_name: register-previewers
    hostname: register-previewers
    image: trivadis/dataverse-deploy-previewers:latest
    networks:
      - dataverse
    environment:
      - DATAVERSE_URL=http://dataverse:8080
      - TIMEOUT=10m
      - PREVIEWERS_PROVIDER_URL=http://localhost:9080
      # Uncomment to specify which previewers you want. Otherwise you get all of them.
      #- INCLUDE_PREVIEWERS=text,html,pdf,csv,comma-separated-values,tsv,tab-separated-values,jpeg,png,gif,markdown,x-markdown
      - EXCLUDE_PREVIEWERS=
      - REMOVE_EXISTING=true
    command:
      - deploy
    restart: "no"
    platform: linux/amd64

networks:
  dataverse:
    driver: bridge