MARMOTTA-636: last details of documentation
Project: http://git-wip-us.apache.org/repos/asf/marmotta/repo Commit: http://git-wip-us.apache.org/repos/asf/marmotta/commit/1d204839 Tree: http://git-wip-us.apache.org/repos/asf/marmotta/tree/1d204839 Diff: http://git-wip-us.apache.org/repos/asf/marmotta/diff/1d204839 Branch: refs/heads/MARMOTTA-584 Commit: 1d2048394fcce7a41ef060ff05a6445c824819b8 Parents: 48b8a9d Author: Sergio Fernández <[email protected]> Authored: Mon May 2 09:09:07 2016 +0200 Committer: Sergio Fernández <[email protected]> Committed: Mon May 2 09:09:07 2016 +0200 ---------------------------------------------------------------------- README.md | 18 ++++++++++++++++++ launchers/marmotta-webapp/README.md | 2 +- 2 files changed, 19 insertions(+), 1 deletion(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/marmotta/blob/1d204839/README.md ---------------------------------------------------------------------- diff --git a/README.md b/README.md index 906be16..4cf2b8e 100644 --- a/README.md +++ b/README.md @@ -82,6 +82,23 @@ The installer can then be tried out by running java -jar target/marmotta-installer-x.x.x.jar +## Building a Docker image + +Marmotta also comes with support for creating a Docker images that you can use for development +or testing: + +1. Locate at the root of the source repository +2. Build image: `docker build -t marmotta .` +3. Run the container: `docker run -p 8080:8080 marmotta` +4. Access Marmotta at [localhost:8080/marmotta](http://localhost:8080/marmotta) (IP address may + be different, see information bellow). + +An official images is [available from Docker Hub](https://hub.docker.com/r/apache/marmotta/) as +an automated build, so you just need to pull it from there to replace the second step above: + + docker pull apache/marmotta + + ## Building with a Clean Repository Sometimes it is useful to check if the build runs properly on a clean local @@ -93,6 +110,7 @@ runs the build. This can be achieved by running Maven as follows: The command changes the local repository location from ~/.m2 to the directory passed as argument + ## Simulating a Release To test the release build without actually deploying the software, we have http://git-wip-us.apache.org/repos/asf/marmotta/blob/1d204839/launchers/marmotta-webapp/README.md ---------------------------------------------------------------------- diff --git a/launchers/marmotta-webapp/README.md b/launchers/marmotta-webapp/README.md index b3bdd21..b377940 100644 --- a/launchers/marmotta-webapp/README.md +++ b/launchers/marmotta-webapp/README.md @@ -22,7 +22,7 @@ and you can find the `.deb` file under `target/`. ## Docker -It also comes with support for creating a Docker images that you can user for developing or testing: +It also comes with support for creating a Docker images that you can use for development or testing: 1. Locate at the root of the source repository 2. Build image: `docker build -t marmotta .`
