You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@isis.apache.org by ah...@apache.org on 2020/01/11 21:40:42 UTC
[isis] branch master updated: brings demo-app docker instructions
up to speed
This is an automated email from the ASF dual-hosted git repository.
ahuber pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/isis.git
The following commit(s) were added to refs/heads/master by this push:
new d371050 brings demo-app docker instructions up to speed
d371050 is described below
commit d3710504fc8920f358d59c544ccc60b921c511a3
Author: Andi Huber <ah...@apache.org>
AuthorDate: Sat Jan 11 22:40:34 2020 +0100
brings demo-app docker instructions up to speed
---
examples/demo/README.adoc | 64 ++++++++++++-----------------------------------
1 file changed, 16 insertions(+), 48 deletions(-)
diff --git a/examples/demo/README.adoc b/examples/demo/README.adoc
index 45a0598..10cbdd4 100644
--- a/examples/demo/README.adoc
+++ b/examples/demo/README.adoc
@@ -1,4 +1,4 @@
-image:https://gitlab.com/apache-isis-committers/isis-2-demo/badges/v2/build.svg[]
+image:https://github.com/apache-isis-committers/isis-nightly/workflows/Nightly/badge.svg[link="https://github.com/apache-isis-committers/isis-nightly/actions?query=workflow%3A%22Nightly%22"]
= Demo App
@@ -9,37 +9,37 @@ Apache Isis version 2 is still work in progress and only made available as miles
The app is built against the latest https://github.com/apache/isis/tree/v2[snapshot] builds of Apache Isis v2 and is published as a Docker image on https://hub.docker.com/repository/docker/apacheisis/isis-2-demo[Docker hub].
-== Prereqs
+== Docker
+
+The demo-app demonstrates features available in Apache Isis, accompanied by introductory description text. While the demo-app is still work in progress, it might be used to learn the very basics of the framework interactively.
+
+NOTE: With the following *<tag>* is used as a placeholder for the docker image tag of your choice. Actual tag names might be changed without notice. Currently we have tag *springboot*. See https://hub.docker.com/r/apacheisis/isis-2-demo/tags/[apacheisis/isis-2-demo] (Docker-Hub)
+
+=== Prereqs
Install https://www.docker.com/community-edition[Docker] on your computer.
-== Pulling the Docker Image
+=== Pulling the Docker Image
Pull the demo image using:
[source]
----
-docker pull apacheisis/isis-2-demo
+docker pull apacheisis/isis-2-demo:<tag>
----
-This will pull down the latest demo image from https://hub.docker.com/r/apacheisis/isis-2-demo/tags/[Docker hub]
-
-== Running the Docker Image
+=== Running the Docker Image
Run the demo image using:
[source]
----
-docker run --name demo --detach -p8080:8080 apacheisis/isis-2-demo
+docker run --name demo --detach -p8080:8080 apacheisis/isis-2-demo:<tag>
----
This will start a new Docker container named 'demo'.
-The demo-app can then be accessed at
-
-. http://localhost:8080/wicket/[] (tomcat)
-. http://localhost:8080/isis-2-demo/wicket/[] (payara, using a context-path)
-
+The demo-app can then be accessed at http://localhost:8080/wicket/[].
Login with `sven:pass`.
To stop and remove the container named 'demo' use:
@@ -49,55 +49,23 @@ To stop and remove the container named 'demo' use:
docker stop demo && docker rm demo
----
-== Customization
+=== Customization
To run the _Demo App_ in _prototyping_ mode, add an environment variable `PROTOTYPING=true`.
The 'run' command above then becomes:
[source]
----
-docker run --name demo --detach -p8080:8080 -ePROTOTYPING=true apacheisis/isis-2-demo
+docker run --name demo --detach -p8080:8080 -ePROTOTYPING=true apacheisis/isis-2-demo:<tag>
----
To run the container with your console attached, replace the '--detach' argument with '-it'. (Use CTRL-C to stop and detach.)
[source]
----
-docker run --name demo -it -p8080:8080 apacheisis/isis-2-demo
-----
-
-=== Supported tags
-. `tomcat` = `latest`
-. `payara` ... the latest payara server-web release
-
-To use a different tag than the default `latest`, append one of the supported tags to the image name like eg. `payara`:
-----
-docker pull apacheisis/isis-2-demo:payara
-docker run --name demo --detach -p8080:8080 apacheisis/isis-2-demo:payara
-----
-
-=== How we build the image
-
-This repo is mirrored to https://gitlab.com/apache-isis-committers/isis-2-demo[gitlab], where a https://gitlab.com/apache-isis-committers/isis-2-demo/blob/master/.gitlab-ci.yml[CI pipeline] builds the image and pushes to Docker hub.
-
-Building a new image of the app in this repo just requires configuring a gitlab remote and pushing to that remote.
-We just add the following to `.git/config`:
-
-[source]
-----
-[remote "gitlab"]
- url = https://gitlab.com/apache-isis-committers/isis-2-demo.git
- fetch = +refs/heads/*:refs/remotes/gitlab/*
+docker run --name demo -it -p8080:8080 apacheisis/isis-2-demo:<tag>
----
-== Roadmap
-
-We are in the process of reshaping http://isis.apache.org/[Apache Isis] for a version 2.0.
-The process is open to the community.
-With this repository we'd like to inspire discussion on design drafts.
-
-https://github.com/andi-huber/isis-2-roadmap/wiki[Apache Isis 2 Roadmap]
-
== Contributing
If you like to get involved (with this demo), please feel free to open new issues https://github.com/andi-huber/isis-2-roadmap/issues[here] or just join the discussion and provide feedback.