Merge changes from topic 'bp/input'

[clamp.git] / README.md

diff --git a/README.md b/README.md
index 4fe12ff..d129e5b 100644 (file)
--- a/README.md
+++ b/README.md
@@ -88,3 +88,22 @@ Once the image has been built and is available locally, you can use the `docker-
 Clamp uses logback framework to generate logs. The logback.xml file cand be found under the [src/main/resources/ folder](src/main/resources). \r
 \r
 With the default log settings, all logs will be generated into console and into root.log file under the Clamp root folder. The root.log file is not allowed to be appended, thus restarting the clamp will result in cleaning of the old log files.\r
+\r
+### Api\r
+\r
+You can see the swagger definition for the jaxrs apis at `/restservices/clds/v1/openapi.json`\r
+\r
+\r
+## Clamp Credentials\r
+\r
+Credentials should be specified in `src/main/resources/clds/clds-users.json`. You might specify you own credential file by redefining the `clamp.config.files.cldsUsers` in `application.properties`.\r
+\r
+Passwords should be hashed using Bcrypt :\r
+```\r
+# pip3 install bcrypt  # if you don't have the bcrypt python lib installed, should be done once.\r
+# python3 -c 'import bcrypt; print(bcrypt.hashpw("password".encode(), bcrypt.gensalt(rounds=10, prefix=b"2a")))'\r
+```\r
+\r
+Default credentials are admin/password and cs0008/password.\r
+\r
+\r