rombert commented on code in PR #79: URL: https://github.com/apache/sling-org-apache-sling-starter/pull/79#discussion_r1165602560
########## README.md: ########## @@ -83,12 +73,41 @@ The [docker/](docker/) directory contains sample files related to container-base The Sling Starter will execute two suites of tests using the `maven-surefire-plugin`: 1. A small set of smoke tests, embedded in the project, that verify the basic functionality of the Starter -1. An extensive set of end-to-end tests that verify the overall functionality of the Starter and the bundles that are embedded into it +2. An extensive set of end-to-end tests that verify the overall functionality of the Starter and the bundles that are embedded into it By default, these are both executed when building the project against an Oak SegmentNodeStore backend. Additionally, when the `ci` profile is enabled the smoke tests are also executed in against an Oak DocumentNodeStore backend. For technical resons, the full end-to-end tests are not executed. + +## Docker + +> The Sling Starter Docker image is only for testing/learning purposes. For your custom applications, +> please configure your [Feature model](https://github.com/apache/sling-org-apache-sling-feature) and +> build your image with all dependencies and configurations built in. + +Our example Docker image uses `/opt/sling/bin/launch.sh` script as the `entrypoint`. It supports the +following environment variables: + +| Environment variable | Description | Default | +|----------------------|----------------------------------------------------------------------|----------| +| `SLING_DEBUG` | Run Sling Starter in debug mode. Allowed values are `false`, `true`. | `false` | +| `JAVA_DEBUG_PORT` | Custom debug port. | `5005` | Review Comment: I think it's simpler if we enable debug whenever `JAVA_DEBUG_PORT` is defined and do away with `SLING_DEBUG`. ########## docker/docker-compose-mongodb.yaml: ########## @@ -15,17 +15,20 @@ # specific language governing permissions and limitations # under the License. -# note that the project needs to be built once with `mvn clean install` +# note that the project needs to be built once with `mvn clean install -Ddocker.skip=false` services: sling: image: apache/sling:snapshot ports: - - "8080" + - "8080:8080" + # when SLING_DEBUG=true + # - "5005:5005" Review Comment: I think we can always leave the port mapping on. If the debugger is not enabled there is no harm done. ########## docker/docker-compose-tar.yaml: ########## @@ -15,12 +15,16 @@ # specific language governing permissions and limitations # under the License. -# note that the project needs to be built once with `mvn clean install` +# note that the project needs to be built once with `mvn clean install -Ddocker.skip=false` services: sling: image: apache/sling:snapshot ports: - - "8080" + - "8080:8080" + # when SLING_DEBUG=true + # - "5005:5005" Review Comment: Same as above, we can always leave the port mapping on. If the debugger is not enabled there is no harm done. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
