Skip to content

Commit 8f38659

Browse files
Clarify a bit usage and possible configuration values (related to #3)
1 parent 2d71408 commit 8f38659

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,11 @@
88

99
## Configuration
1010

11-
This extension also enables support for `stripes.*` namespace on the `application.properties` file, through the `net.sourceforge.stripes.springboot.autoconfigure.StripesProperties` class. Although it is possible to start your Stripes application without having to set any custom properties, most probably you would like to look at:
11+
This extension also enables support for `stripes.*` namespace on the `application.properties` file, through the [`net.sourceforge.stripes.springboot.autoconfigure.StripesProperties`](stripes-spring-boot-autoconfigure/src/main/java/net/sourceforge/stripes/springboot/autoconfigure/StripesProperties.java) class. Namely, there is a `stripes.*` property for each of the Stripes [configuration parameters](https://stripesframework.atlassian.net/wiki/spaces/STRIPES/pages/492126/Configuration+Reference), plus support for custom parameters and a flag to bypass this module's configuration.
12+
13+
Although it is possible to start your Stripes application without having to set any custom properties, most probably you would like to look at:
1214
* `stripes.action-resolver-packages`: if not set, Spring Boot will look for actionbean packages by scanning the whole classpath. This operation "just works", but it slows down the application's startup time.
13-
* `stripes.extension.packages`: defaults to `net.sourceforge.stripes.integration.spring` (as we are already using Spring / Spring Boot, it seems a reasonable default), change if needed.
15+
* `stripes.extension-packages`: defaults to `net.sourceforge.stripes.integration.spring` (as we are already using Spring / Spring Boot, it seems a reasonable default), change if needed.
1416
* `stripes.encryption-key`: if you would like to use an encryption key which survives application reloads.
1517
* `stripes.custom-conf.WHATEVER`: any other filter configuration value that you might need for your Stripes extension are supported through the `stripes.custom-conf` sub-namespace, i.e., `stripes.custom-conf.WHATEVER=MY_CUSTOM_VALUE` will be set as an configuration parameter of Stripes filter with key `WHATEVER` and value `MY_CUSTOM_VALUE`.
1618
* `stripes.enabled`: set to false to bypass this module's configuration.
@@ -20,9 +22,9 @@ This extension also enables support for `stripes.*` namespace on the `applicatio
2022
* Git clone + `mvn clean install`
2123
* `cd stripes-spring-boot-sample`
2224
* `mvn spring-boot:run` or `java -jar target/stripes-spring-boot-sample-1.0.0.jar`
23-
* browse http://localhost:8080/index.jsp
25+
* Browse http://localhost:8080/index.jsp
2426

2527
## Other caveats
2628

27-
* this starter module manually deactivates Spring MVC, by defining String-type beans with ids `DispatcherServletAutoConfiguration.DEFAULT_DISPATCHER_SERVLET_REGISTRATION_BEAN_NAME`, `DispatcherServletAutoConfiguration.DEFAULT_DISPATCHER_SERVLET_BEAN_NAME` and `conventionErrorViewResolver`.
28-
* if running several application instances, set the `stripes.encryption-key` property at build time to enforce the use of the same encryption key. Look at the sample (`stripes-spring-boot-sample/pom.xml`, `stripes-spring-boot-sample/src/main/resources/application.properties`) to see how to do this.
29+
* This starter module manually deactivates Spring MVC, by defining String-type beans with ids `DispatcherServletAutoConfiguration.DEFAULT_DISPATCHER_SERVLET_REGISTRATION_BEAN_NAME`, `DispatcherServletAutoConfiguration.DEFAULT_DISPATCHER_SERVLET_BEAN_NAME` and `conventionErrorViewResolver`.
30+
* If running several application instances, set the `stripes.encryption-key` property at build time to enforce the use of the same encryption key. Look at the sample (`stripes-spring-boot-sample/pom.xml`, `stripes-spring-boot-sample/src/main/resources/application.properties`) to see how to do this.

0 commit comments

Comments
 (0)