Browse code

Merge origin/master

devnewton authored on 11/03/2017 at 08:43:11
Showing 1 changed files
... ...
@@ -14,21 +14,21 @@ jb3 is a KISS tribune powered by java, spring boot and mongodb.
14 14
 
15 15
 # Demo
16 16
 
17
-A live demo is accessible [here](http://b3.bci.im).
17
+A live demo is accessible [here](https://b3.bci.im).
18 18
 
19 19
 ## Coincoin configuration
20 20
 
21 21
 You can also configure your favorite coincoin using these parameters:
22 22
 
23
-- backend URL: http://b3.bci.im/legacy/xml
24
-- post URL: http://b3.bci.im/legacy/post
23
+- backend URL: https://b3.bci.im/legacy/xml
24
+- post URL: https://b3.bci.im/legacy/post
25 25
 - post data: message=%m
26 26
 - tags: encoded
27 27
 
28 28
 ## Advanced coincoin configuration
29 29
 
30
-- backend using last id: http://b3.bci.im/legacy/xml?last=%last
31
-- post returns backend: post request to http://b3.bci.im/legacy/post include backend data (same as GET http://b3.bci.im/legacy/xml response).
30
+- backend using last id: https://b3.bci.im/legacy/xml?last=%last
31
+- post returns backend: post request to https://b3.bci.im/legacy/post include backend data (same as GET https://b3.bci.im/legacy/xml response).
32 32
 - post message using last id: message=%m&last=%last
33 33
 - XPOST: post reply body contains last messages
34 34
 - X-Post-Id: post reply returns posted message id in X-Post-Id header
... ...
@@ -37,7 +37,7 @@ You can also configure your favorite coincoin using these parameters:
37 37
 
38 38
 Rooms are like IRC channel. From a coincoin, they can be seen as independent tribune.
39 39
 
40
-- room backend : http://b3.bci.im/legacy/xml?room=%room
40
+- room backend : https://b3.bci.im/legacy/xml?room=%room
41 41
 - post message in a room: message=%m&room=%room
42 42
 
43 43
 ## Gateway rooms
... ...
@@ -52,6 +52,15 @@ Implemented gateways:
52 52
 - moules
53 53
 - sveetch
54 54
 
55
+# Build and run demo using [docker](https://www.docker.com/)
56
+
57
+Run the following commands:
58
+
59
+    docker build --tag=jb3 https://github.com/devnewton/jb3.git
60
+    docker run -p 8080:8080 jb3
61
+
62
+Then access to the jb3 application using a web browser on http://localhost:8080
63
+
55 64
 # How to use
56 65
 
57 66
 ## Skill check
... ...
@@ -60,7 +69,7 @@ Please note that a thorough knowledge of Java web application development and ho
60 60
 
61 61
 ## Requirements
62 62
 
63
-- JDK 7+
63
+- JDK 8+
64 64
 - Maven 3+
65 65
 - mongodb 2+
66 66
 
... ...
@@ -81,7 +90,7 @@ The frontend is now accessible on [locahost:8080](http://localhost:8080).
81 81
 There is several options to deploy and host jb3. Here is one that requires:
82 82
 
83 83
 - a domain name (example: mydomain.me).
84
-- a web server with http proxy capabilities (example [Cherokee](http://cherokee-project.com/)).
84
+- a web server with http proxy capabilities (example [ngix](http://nginx.org/)).
85 85
 
86 86
 ### Application configuration
87 87
 
... ...
@@ -95,12 +104,10 @@ to your application.properties configuration. If you don't do it, jb3 will do
95 95
 VERY INSECURE operations like:
96 96
 
97 97
 - not verifying self signed HTTPS certificates.
98
-- not verifying untrusted HTTPS certificates (like linuxfr.org CACERT certificate).
98
+- not verifying untrusted HTTPS certificates.
99 99
 
100 100
 It is VERY RECOMMENDED, to use jb3.secure=true and add certificates to your
101
-keystore. For example to add CACERT, use this guide:
102
-
103
-http://wiki.cacert.org/FAQ/ImportRootCert?action=show&redirect=ImportRootCert#Java
101
+keystore.
104 102
 
105 103
 ### Deployment
106 104