Browse code

edit readme

devnewton authored on 27/12/2015 at 17:24:03
Showing 1 changed files
... ...
@@ -1,55 +1,6 @@
1
-# jb3
1
+# passgrid
2 2
 
3
-jb3 is a KISS tribune powered by java, spring boot and mongodb.
4
-
5
-## Features
6
-
7
-- archives
8
-- fortunes
9
-- bots
10
-- last id
11
-- XPost
12
-- X-Post-Id
13
-- rooms
14
-
15
-# Demo
16
-
17
-A live demo is accessible [here](http://b3.bci.im).
18
-
19
-## Coincoin configuration
20
-
21
-You can also configure your favorite coincoin using these parameters:
22
-
23
-- backend URL: http://b3.bci.im/legacy/xml
24
-- post URL: http://b3.bci.im/legacy/post
25
-- post data: message=%m
26
-- tags: encoded
27
-
28
-## Advanced coincoin configuration
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).
32
-- post message using last id: message=%m&last=%last
33
-- XPOST: post reply body contains last messages
34
-- X-Post-Id: post reply returns posted message id in X-Post-Id header
35
-
36
-## Rooms
37
-
38
-Rooms are like IRC channel. From a coincoin, they can be seen as independent tribune.
39
-
40
-- room backend : http://b3.bci.im/legacy/xml?room=%room
41
-- post message in a room: message=%m&room=%room
42
-
43
-## Gateway rooms
44
-
45
-Gateway are used to receive and post on external tribunes or other chat systems.
46
-
47
-Implemented gateways:
48
-
49
-- euromussels
50
-- sveetch
51
-
52
-# How to use
3
+passgrid is a KISS password grid generator and manager powered by java, spring boot and mongodb.
53 4
 
54 5
 ## Skill check
55 6
 
... ...
@@ -69,7 +20,7 @@ Please note that a thorough knowledge of Java web application development and ho
69 69
 
70 70
 Ensure that mongodb is running and listening on 127.0.0.1 then run:
71 71
 
72
-    java -jar target/jb3-*.jar
72
+    java -jar target/passgrid-*.jar
73 73
 
74 74
 The frontend is now accessible on [locahost:8080](http://localhost:8080).
75 75
 
... ...
@@ -88,22 +39,14 @@ Edit the application.properties file and change the jb3.host property:
88 88
 
89 89
 ### Security
90 90
 
91
-In production environnement, please add
92
-
93
-    jb3.secure=true
94
-
95
-to your application.properties configuration. If you don't do it, jb3 will do
96
-VERY INSECURE operations like:
97
-
98
-- not verifying self signed HTTPS certificates.
99
-- not verifying untrusted HTTPS certificates (like linuxfr.org CACERT certificate).
91
+In production environnement, please change the following parameters
100 92
 
101
-It is VERY RECOMMENDED, to use jb3.secure=true and add certificates to your
102
-keystore. For example to add CACERT, use this guide:
93
+- security.user.name
94
+- security.user.password
103 95
 
104
-http://wiki.cacert.org/FAQ/ImportRootCert?action=show&redirect=ImportRootCert#Java
96
+to your application.properties configuration.
105 97
 
106 98
 ### Deployment
107 99
 
108
-1. Build and launch jb3 on the server.
100
+1. Build and launch passgrid on the server.
109 101
 2. Configure your web server to act as reverse proxy on http://localhost:8080