From 113acc26facfecdbf4a33fc37f45b55d51694644 Mon Sep 17 00:00:00 2001 From: gazbert Date: Sat, 4 Apr 2020 14:15:23 +0100 Subject: [PATCH] #123 : Docs n props cleanup + licensing updates --- 3rd-party-licenses.md | 20 +++++++++++++------- README.md | 9 ++++++--- config/application.properties | 8 -------- 3 files changed, 19 insertions(+), 18 deletions(-) diff --git a/3rd-party-licenses.md b/3rd-party-licenses.md index 90402c48..ac91edc0 100644 --- a/3rd-party-licenses.md +++ b/3rd-party-licenses.md @@ -2,13 +2,18 @@ ## Product -* GSON - https://github.com/google/gson/blob/master/LICENSE -* Guava - https://github.com/google/guava/blob/master/COPYING -* log4j - https://logging.apache.org/log4j/2.0/license.html -* JavaMail - https://glassfish.java.net/public/CDDL+GPL_1_1.html -* Spring Boot - https://github.com/spring-projects/spring-boot/blob/master/LICENSE.txt -* Snake YAML - https://bitbucket.org/asomov/snakeyaml/src/default/LICENSE.txt -* Springfox - https://github.com/springfox/springfox/blob/master/LICENSE +* GSON - https://github.com/google/gson/blob/master/LICENSE +* Guava - https://github.com/google/guava/blob/master/COPYING +* log4j - https://logging.apache.org/log4j/2.0/license.html +* JavaMail - https://glassfish.java.net/public/CDDL+GPL_1_1.html +* Spring Boot - https://github.com/spring-projects/spring-boot/blob/master/LICENSE.txt +* Snake YAML - https://bitbucket.org/asomov/snakeyaml/src/default/LICENSE.txt +* H2 - https://www.h2database.com/html/license.html +* JJWT - https://github.com/jwtk/jjwt/blob/master/LICENSE +* JAXB - https://javaee.github.io/jaxb-v2/LICENSE +* Jakarta Bean Validation - https://beanvalidation.org/licensing/ +* Springfox - https://github.com/springfox/springfox/blob/master/LICENSE +* Swagger - https://github.com/swagger-api/swagger-core/blob/master/LICENSE ## Build & Test @@ -22,6 +27,7 @@ * spring-boot-starter-test - http://docs.spring.io/spring-boot/docs/current/reference/html/boot-features-testing.html * SpotBugs - https://spotbugs.github.io/index.html * JaCoCo - https://www.jacoco.org/license.html +* Checkstyle - https://checkstyle.org/licenses.html * SonarQube - https://www.sonarqube.org/downloads/license * JBehave - https://jbehave.org/license.html diff --git a/README.md b/README.md index bcd5a061..08093e26 100644 --- a/README.md +++ b/README.md @@ -114,8 +114,11 @@ If you plan on developing the bot, you'll need [openjdk-11-jdk](http://openjdk.j You can use [Maven](https://maven.apache.org) or [Gradle](https://gradle.org/) to build the bot and pull down the dependencies. BX-bot depends on [Spring Boot](http://projects.spring.io/spring-boot/), [log4j](http://logging.apache.org/log4j), [JavaMail](https://java.net/projects/javamail/pages/Home), -[Google Gson](https://code.google.com/p/google-gson/), [Google Guava](https://github.com/google/guava), and -[Snake YAML](https://bitbucket.org/asomov/snakeyaml). +[Google Gson](https://code.google.com/p/google-gson/), [Google Guava](https://github.com/google/guava), +[Snake YAML](https://bitbucket.org/asomov/snakeyaml), [Java JWT](https://github.com/jwtk/jjwt), +[H2](https://www.h2database.com/html/main.html), [JAXB](https://javaee.github.io/jaxb-v2/), +[Jakarta Bean Validation](https://beanvalidation.org/), [Springfox](https://github.com/springfox/springfox), +and [Swagger](https://github.com/swagger-api/swagger-core). The instructions below are for Linux/macOS, but equivalent Windows scripts are included. @@ -611,7 +614,7 @@ keytool -genkeypair -alias rest-api-keystore -keyalg RSA -keysize 2048 -storetyp ``` The keystore must be on the app's classpath - you can put it in -the [./src/main/resources](./src/main/resources) and re-build the app to get up and running fast. +the [./bxbot-rest-api/src/main/resources](./bxbot-rest-api/src/main/resources) and re-build the app to get up and running fast. For a Production system, you'll want to replace the self-signed certificate with a CA signed certificate. diff --git a/config/application.properties b/config/application.properties index e2f196a6..38aa5577 100644 --- a/config/application.properties +++ b/config/application.properties @@ -39,14 +39,6 @@ bxbot.restapi.jwt.audience=bxbot-ui # For dev environment, we allow any origin. restapi.cors.allowed_origin=* -# Database config for storing User details -#spring.h2.console.enabled=true -#spring.datasource.url=jdbc:h2:mem:testdb;DB_CLOSE_DELAY=-1;DB_CLOSE_ON_EXIT=FALSE -#spring.datasource.driverClassName=org.h2.Driver -#spring.datasource.username=sa -#spring.datasource.password= -#spring.jpa.database-platform=org.hibernate.dialect.H2Dialect - # Spring Actuator endpoints that are used by REST API. management.endpoints.enabled-by-default=false management.endpoint.restart.enabled=true