Docker容器中通过环境变量设置Tomcat上下文路径的技术咨询

问题场景 #

我当前通过以下Dockerfile在容器中运行Tomcat：

FROM myregistry/cfw-deploy-base
COPY ./my.war /opt/tomcat/webapps/
ENV JAVA_OPTS=""
CMD ["/opt/tomcat/bin/catalina.sh", "run"]

目前应用的上下文路径由WAR包名称my决定，我希望通过容器内的环境变量来动态设置上下文路径，请问使用catalina.sh启动时能否实现？

当然可以实现！这里有两种实用的方案，你可以根据自己的需求选择：

方案一：修改Tomcat的server.xml配置Context路径 #

这种方案通过动态修改Tomcat的核心配置文件server.xml，直接指定应用的上下文路径，灵活性更高。

修改后的Dockerfile示例 #

FROM myregistry/cfw-deploy-base
COPY ./my.war /opt/tomcat/webapps/
# 定义上下文路径的环境变量，默认值可根据需求调整
ENV CONTEXT_PATH="/myapp"
ENV JAVA_OPTS=""
# 在启动前动态修改server.xml，添加Context节点
CMD sed -i '/<Host name="localhost" appBase="webapps"/a <Context path="'${CONTEXT_PATH}'" docBase="/opt/tomcat/webapps/my.war" reloadable="true"/>' /opt/tomcat/conf/server.xml && /opt/tomcat/bin/catalina.sh run

说明 #

• 这里的sed命令会在server.xml的<Host>节点下插入一个<Context>配置，明确指定path（上下文路径）和docBase（WAR包路径）。
• 如果你需要更复杂的配置（比如自定义数据源、资源链接等），可以预先准备一个带有占位符的server.xml模板，再用sed或envsubst替换占位符后替换原配置文件。
• 启动容器时通过-e参数传入自定义路径：docker run -e CONTEXT_PATH="/mycustompath" your-image-name

方案二：利用Tomcat自动部署特性重命名WAR包 #

Tomcat会自动将webapps目录下的WAR包解压，并且将WAR包的文件名（去掉.war后缀）作为默认上下文路径。我们可以基于这个特性，通过环境变量动态重命名WAR包。

修改后的Dockerfile示例 #

FROM myregistry/cfw-deploy-base
COPY ./my.war /opt/tomcat/webapps/
ENV CONTEXT_PATH="/myapp"
ENV JAVA_OPTS=""
# 根据环境变量重命名WAR包，处理根路径场景
CMD set -e; \
    if [ "$CONTEXT_PATH" = "/" ] || [ -z "$CONTEXT_PATH" ]; then \
        # 若上下文路径为根路径，重命名为ROOT.war
        mv /opt/tomcat/webapps/my.war /opt/tomcat/webapps/ROOT.war; \
    else \
        # 去掉路径开头的斜杠，避免Tomcat识别异常
        TARGET_NAME=$(echo "$CONTEXT_PATH" | sed 's/^\///'); \
        mv /opt/tomcat/webapps/my.war /opt/tomcat/webapps/${TARGET_NAME}.war; \
    fi; \
    /opt/tomcat/bin/catalina.sh run

说明 #

• 这个方案不需要修改Tomcat的配置文件，完全依赖自动部署规则，更简洁。
• 处理了根路径的特殊情况：当CONTEXT_PATH为/或空时，自动重命名为ROOT.war，此时应用会直接通过根路径访问。
• 同样可以通过docker run -e CONTEXT_PATH="/mycustompath" your-image-name传入自定义路径。

内容的提问来源于stack exchange，提问作者kosta