Hithomelabs/CFTunnels#150: Add Spring Boot Actuator health check endpoints for portainer-automation

- Add spring-boot-starter-actuator dependency to portainer-automation/build.gradle
- Configure management.server.port=8082 with health,info exposure in application.properties
- Map 5005:8082 in portainer-automation/docker-compose.yaml
- Add MGMT_PORT=5005 to portainer-automation/.env.example
- EXPOSE 8081 8082 in portainer-automation Dockerfile
- No ActuatorSecurityConfig needed: service has no Spring Security/OIDC
- Management port stays LAN-only, NOT added to any tunnel ingress

.env.example

@@ -2,3 +2,4 @@ CLOUDFLARE_ACCOUNT_ID="<cloudflare account id>"
 CLOUDFLARE_API_KEY="<cloudflare account key>"
 CLOUDFLARE_EMAIL="<cloudflare email>"
 ENV="<deployment env>"
+MGMT_PORT="5003"

cftunnels-service/Dockerfile

@@ -9,4 +9,5 @@ RUN ./gradlew :cftunnels-service:bootJar
 
 FROM openjdk:17-jdk-slim
 COPY --from=build /app/cftunnels-service/build/libs/*.jar app.jar
+EXPOSE 8080 8081
 ENTRYPOINT ["java", "-jar", "/app.jar"]

cftunnels-service/build.gradle

@@ -7,6 +7,7 @@ dependencies {
     implementation 'org.springframework.boot:spring-boot-starter-oauth2-client'
     implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
     implementation 'org.springframework.boot:spring-boot-starter-security'
+    implementation 'org.springframework.boot:spring-boot-starter-actuator'
     implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.8.5'
     implementation 'org.hibernate.validator:hibernate-validator'
 

cftunnels-service/src/main/java/com/hithomelabs/cftunnels/Config/Security/ActuatorSecurityConfig.java

@@ -0,0 +1,39 @@
+package com.hithomelabs.cftunnels.Config.Security;
+
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.core.Ordered;
+import org.springframework.core.annotation.Order;
+import org.springframework.security.config.annotation.web.builders.HttpSecurity;
+import org.springframework.security.web.SecurityFilterChain;
+import org.springframework.boot.actuate.autoconfigure.security.servlet.EndpointRequest;
+
+/**
+ * Security configuration for Spring Boot Actuator endpoints.
+ *
+ * This configuration permits unauthenticated access to /actuator/health and /actuator/info
+ * endpoints, enabling health monitoring by Uptime Kuma without requiring OIDC authentication.
+ * All other actuator endpoints remain protected and require authentication.
+ *
+ * Uses @Order(Ordered.HIGHEST_PRECEDENCE) to ensure this filter chain is evaluated BEFORE
+ * any auto-configured management security filter chains (e.g., ManagementWebSecurityAutoConfiguration).
+ * Without this, the catch-all SecurityFilterChain in SecuirtyConfig can intercept actuator
+ * requests on the separate management port (management.server.port=8081) and redirect to OIDC login.
+ */
+@Configuration
+@Order(Ordered.HIGHEST_PRECEDENCE)
+public class ActuatorSecurityConfig {
+
+    @Bean
+    public SecurityFilterChain actuatorSecurityChain(HttpSecurity http) throws Exception {
+        http
+                .securityMatcher(EndpointRequest.toAnyEndpoint())
+                .authorizeHttpRequests(auth -> auth
+                        .requestMatchers("/actuator/health", "/actuator/info").permitAll()
+                        .anyRequest().authenticated()
+                )
+                .csrf(csrf -> csrf.disable());
+
+        return http.build();
+    }
+}

cftunnels-service/src/main/java/com/hithomelabs/cftunnels/Config/Security/SecuirtyConfig.java

@@ -29,6 +29,7 @@ public class SecuirtyConfig {
         http
                 .authorizeHttpRequests(auth -> auth
                         //.requestMatchers( "/v3/api-docs/**", "/swagger-ui/**", "/swagger-ui.html" ).permitAll()
+                        .requestMatchers("/actuator/health", "/actuator/info").permitAll()
                         .anyRequest().authenticated()
                 ).csrf(csrf -> csrf.disable())
                 .with(new OAuth2LoginConfigurer<>(),

cftunnels-service/src/main/resources/application-ci.properties

@@ -5,3 +5,7 @@ spring.datasource.driver-class-name=org.h2.Driver
 spring.datasource.username=sa
 spring.datasource.password=
 spring.jpa.hibernate.ddl-auto=none
+
+# Actuator configuration for CI
+management.endpoints.web.exposure.include=health,info
+management.endpoint.health.show-details=never

cftunnels-service/src/main/resources/application-local.properties

@@ -1,8 +1,10 @@
 api.baseUrl=http://localhost:8080
 
-management.health.db.enabled=true
+# Actuator configuration for local development
-management.endpoints.web.exposure.include=health
+management.server.port=8081
+management.endpoints.web.exposure.include=health,info
 management.endpoint.health.show-details=always
+management.health.db.enabled=true
 
 logging.level.org.hibernate.SQL=DEBUG
 debug=true

cftunnels-service/src/main/resources/application-prod.properties

@@ -10,3 +10,7 @@ spring.datasource.driver-class-name=org.postgresql.Driver
 spring.jpa.hibernate.ddl-auto=create-drop
 spring.jpa.show-sql=false
 spring.jpa.properties.hibernate.dialect=org.hibernate.dialect.PostgreSQLDialect
+
+# Actuator configuration
+management.endpoints.web.exposure.include=health,info
+management.endpoint.health.show-details=when-authorized

cftunnels-service/src/main/resources/application-test.properties

@@ -10,3 +10,7 @@ spring.datasource.driver-class-name=org.postgresql.Driver
 spring.jpa.hibernate.ddl-auto=update
 spring.jpa.show-sql=true
 spring.jpa.properties.hibernate.dialect=org.hibernate.dialect.PostgreSQLDialect
+
+# Actuator configuration
+management.endpoints.web.exposure.include=health,info
+management.endpoint.health.show-details=when-authorized

cftunnels-service/src/main/resources/application.properties

@@ -36,3 +36,8 @@ spring.jpa.show-sql=true
 spring.jpa.properties.hibernate.dialect=org.hibernate.dialect.PostgreSQLDialect
 
 spring.jpa.open-in-view=false
+
+# Actuator configuration - management port and exposed endpoints
+management.server.port=8081
+management.endpoints.web.exposure.include=health,info
+management.endpoint.health.show-details=when-authorized

docker-compose.yaml

@@ -4,6 +4,7 @@ services:
     container_name: cftunnels_${ENV}
     ports:
       - ${HOST_PORT}:8080
+      - ${MGMT_PORT:-5003}:8081
     environment:
       - CLOUDFLARE_ACCOUNT_ID=${CLOUDFLARE_ACCOUNT_ID}
       - CLOUDFLARE_API_KEY=${CLOUDFLARE_API_KEY}

portainer-automation/.env.example

@@ -36,3 +36,6 @@ ENV=dev
 
 # Host port to map to container port 8081
 HOST_PORT=8081
+
+# Host port to map to actuator management port 8082 (health checks, LAN only)
+MGMT_PORT=5005

portainer-automation/Dockerfile

@@ -9,4 +9,5 @@ RUN ./gradlew :portainer-automation:bootJar
 
 FROM openjdk:17-jdk-slim
 COPY --from=build /app/portainer-automation/build/libs/*.jar app.jar
+EXPOSE 8081 8082
 ENTRYPOINT ["java", "-jar", "/app.jar"]

portainer-automation/build.gradle

@@ -5,6 +5,7 @@ dependencies {
 
     implementation 'org.springframework.boot:spring-boot-starter-web'
     implementation 'org.springframework.boot:spring-boot-starter-validation'
+    implementation 'org.springframework.boot:spring-boot-starter-actuator'
     implementation 'org.apache.httpcomponents.client5:httpclient5'
 
     compileOnly 'org.projectlombok:lombok'

portainer-automation/docker-compose.yaml

@@ -3,7 +3,8 @@ services:
     image: gitea.hithomelabs.com/hithomelabs/portainer-automation:${ENV:-test}
     container_name: portainer-automation_${ENV:-test}
     ports:
-      - "${HOST_PORT:-8081}:8081"
+      - "${HOST_PORT:-8081}:8081"   # Application port (internal service)
+      - "${MGMT_PORT:-5005}:8082"   # Health management port (LAN only)
     environment:
       - SPRING_PROFILES_ACTIVE=${SPRING_PROFILES_ACTIVE:-local}
       - PORTAINER_API_KEY=${PORTAINER_API_KEY}

portainer-automation/src/main/resources/application.properties

@@ -3,3 +3,9 @@ portainer.base-url=https://192.168.0.100:9442
 portainer.api-key=${PORTAINER_API_KEY:}
 portainer.endpoint-id=1
 portainer.service.api-key=${PORTAINER_SERVICE_API_KEY:change-me}
+
+# Actuator configuration - management port and exposed endpoints
+# App runs on server.port=8081, so management port must differ (8082)
+management.server.port=8082
+management.endpoints.web.exposure.include=health,info
+management.endpoint.health.show-details=when-authorized