Browse code

update Readme with docker instructions

devnewton authored on 02/01/2016 at 12:58:27
Showing 1 changed files
... ...
@@ -2,21 +2,28 @@
2 2
 
3 3
 passgrid is a KISS password grid generator and manager powered by java, spring boot and mongodb.
4 4
 
5
-## Skill check
5
+## Build and run demo using [docker](https://www.docker.com/)
6
+
7
+    docker build --tag=passgrid https://github.com/devnewton/passgrid.git
8
+    docker run -p 8080:8080 passgrid
9
+
10
+## Build, run and deploy manually
11
+
12
+### Skill check
6 13
 
7 14
 Please note that a thorough knowledge of Java web application development and hosting is required.
8 15
 
9
-## Requirements
16
+### Requirements
10 17
 
11 18
 - JDK 7+
12 19
 - Maven 3+
13 20
 - mongodb 2+
14 21
 
15
-## Build
22
+### Build
16 23
 
17 24
     mvn package
18 25
 
19
-## Run locally
26
+### Run locally
20 27
 
21 28
 Ensure that mongodb is running and listening on 127.0.0.1 then run:
22 29
 
... ...
@@ -24,20 +31,14 @@ Ensure that mongodb is running and listening on 127.0.0.1 then run:
24 24
 
25 25
 The frontend is now accessible on [locahost:8080](http://localhost:8080).
26 26
 
27
-## Deploy and hosting on a production server
27
+### Deploy and hosting on a production server
28 28
 
29 29
 There is several options to deploy and host jb3. Here is one that requires:
30 30
 
31 31
 - a domain name (example: mydomain.me).
32 32
 - a web server with http proxy capabilities (example [Cherokee](http://cherokee-project.com/)).
33 33
 
34
-### Application configuration
35
-
36
-Edit the application.properties file and change the jb3.host property:
37
-
38
-    jb3.host=http://mydomain.me
39
-
40
-### Security
34
+#### Application configuration
41 35
 
42 36
 In production environnement, please change the following parameters
43 37
 
... ...
@@ -46,7 +47,7 @@ In production environnement, please change the following parameters
46 46
 
47 47
 to your application.properties configuration.
48 48
 
49
-### Deployment
49
+#### Deployment
50 50
 
51 51
 1. Build and launch passgrid on the server.
52 52
 2. Configure your web server to act as reverse proxy on http://localhost:8080