From 0c7af98f0bd16b0423d302ae01ec9e215cdf4f6e Mon Sep 17 00:00:00 2001 From: Jody Garnett Date: Mon, 15 Aug 2022 10:39:01 -0700 Subject: [PATCH] Double check readme headings --- README.md | 73 +++++++++++++++++++++++++++++++++++-------------------- 1 file changed, 46 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index 525b628..56644d8 100644 --- a/README.md +++ b/README.md @@ -22,6 +22,12 @@ docker pull docker.osgeo.org/geoserver:2.21.1 docker run -it -p 80:8080 docker.osgeo.org/geoserver:2.21.1 ``` +or if you want to start the container daemonized: + +``` +docker run -d -p 80:8080 docker.osgeo.org/geoserver:2.21.1 +``` + Check http://localhost/geoserver to see the geoserver page, and login with geoserver default `admin:geoserver` credentials. @@ -29,21 +35,6 @@ and login with geoserver default `admin:geoserver` credentials. For more information see the user-guide [docker installation instructions](https://docs.geoserver.org/latest/en/user/installation/docker). - -### How to run local build? - -After building run using local tag: - -``` -docker run -it -p 80:8080 {YOUR_TAG} -``` - -or if you want to start the container daemonized: - -``` -docker run -d -p 80:8080 {YOUR_TAG} -``` - ## How to download and install additional extensions on startup? The ``startup.sh`` script allows some customization on startup: @@ -86,7 +77,7 @@ docker run -it -p 80:8080 \ ### How to watch geoserver.log from host? -To watch ``geoserver.log`` of a running container:` +To watch ``geoserver.log`` of a running container: ``` docker exec -it {CONTAINER_ID} tail -f /opt/geoserver_data/logs/geoserver.log @@ -104,32 +95,60 @@ Run ``docker-compose``: docker-compose -f docker-compose-demo.yml up --build ``` - - ## How to Build? -`docker build -t {YOUR_TAG} .` -## How to build a specific GeoServer version? +### How to build a local image? -`docker build --build-arg GS_VERSION={YOUR_VERSION} -t {YOUR_TAG} .` +``` +docker build -t {YOUR_TAG} . +``` -## How to build with custom geoserver data? +### How to run local build? -`docker build --build-arg GS_DATA_PATH={RELATIVE_PATH_TO_YOUR_GS_DATA} .` +After building run using local tag: + +``` +docker run -it -p 80:8080 {YOUR_TAG} +``` + +### How to build a specific GeoServer version? + +``` +docker build \ + --build-arg GS_VERSION={YOUR_VERSION} \ + -t {YOUR_TAG} . +``` + +### How to build with custom geoserver data directory? + +``` +docker build \ + --build-arg GS_DATA_PATH={RELATIVE_PATH_TO_YOUR_GS_DATA} \ + -t {YOUR_TAG} . +``` **Note:** The passed path **must not** be absolute! Instead, the path should be within the build context (e.g. next to the Dockerfile) and should be passed as a relative path, e.g. `GS_DATA_PATH=./my_data/` -## Can I build a specific GS version with custom data? +### Can a build use a specific GeoServer version AND custom data? Yes! Just pass the `--build-arg` param twice, e.g. -`... --build-arg GS_VERSION={VERSION} --build-arg GS_DATA_PATH={PATH} ...` +``` +docker build \ + --build-arg GS_VERSION={VERSION} \ + --build-arg GS_DATA_PATH={PATH} \ + -t {YOUR_TAG} . +``` -## How to build with additional libs/extensions/plugins? +### How to build with additional libs/extensions/plugins? Put your `*.jar` files (e.g. the WPS extension) in the `additional_libs` folder and build with one of the commands from above! (They will be copied to the GeoServer `WEB-INF/lib` folder during the build.) **Note:** Similar to the GeoServer data path from above, you can also configure the path to the additional libraries by passing the `ADDITIONAL_LIBS_PATH` argument when building: -`--build-arg ADDITIONAL_LIBS_PATH={RELATIVE_PATH_TO_YOUR_LIBS}` +``` +docker build \ + --build-arg ADDITIONAL_LIBS_PATH={RELATIVE_PATH_TO_YOUR_LIBS} + -t {YOUR_TAG} . +``` \ No newline at end of file