Skip to content

Commit

Permalink
#123 : Docs n props cleanup + licensing updates
Browse files Browse the repository at this point in the history
  • Loading branch information
gazbert committed Apr 4, 2020
1 parent bdeddb0 commit 113acc2
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 18 deletions.
20 changes: 13 additions & 7 deletions 3rd-party-licenses.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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

Expand Down
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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.

Expand Down
8 changes: 0 additions & 8 deletions config/application.properties
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 113acc2

Please sign in to comment.