Commit Graph

276 Commits

Author SHA1 Message Date
Brian Kelly 0f2c25c4b8 Clarify location for Flyway callback scripts
Closes gh-4947
2016-01-15 18:02:57 +00:00
Andy Wilkinson 97c5a1b3aa Merge branch '1.2.x' 2016-01-15 12:51:31 +00:00
Andy Wilkinson 2f2bba4d26 Fix docs for using YAML to configure Log4J 2
Previously, the documentation stated that jackson-dataformat-yaml was
the only required dependency. This is incorrect. jackson-databind is
also required.

Closes gh-4924
2016-01-15 12:51:19 +00:00
Phillip Webb 91c801d6fe Add how-to log to file without console section
Fixes gh-4388
2015-12-16 22:25:13 +00:00
Johnny Lim 4fbc6d810a Polish docs
Closes gh-4768
2015-12-12 18:55:34 +01:00
cornelcreanga@yahoo.com 1e9d4a22c2 Document how to use Actuator with Jersey
Closes gh-4577
2015-12-03 11:33:43 +00:00
Stephane Nicoll 1ec40ed666 Polish 2015-11-30 15:08:40 +01:00
Stephane Nicoll e78ddc903e Polish 2015-11-30 10:47:25 +01:00
Stephane Nicoll 6146817ba3 Polish 2015-11-18 12:36:41 +00:00
NersesAM 732658af89 Update documentation with new Jackson 2.6 feature
Update the "How To" section with a new Jackson value that was added in
2.6.

Closes gh-4491
2015-11-14 16:52:30 -08:00
Johnny Lim 4d9111606b Polish docs
Closes gh-4446
2015-11-12 17:23:04 +01:00
Johnny Lim 4c1398148b Polish docs
Closes gh-4433
2015-11-11 15:04:45 +01:00
Phillip Webb 6c2ea4648f Polish 2015-11-03 20:36:20 -08:00
Stephane Nicoll 6491eafc4a Polish doc
`ConfigFileEnvironmentPostProcessor` was renamed to
`ConfigFileApplicationListener`.

See gh-4258
2015-10-28 20:07:45 +01:00
Stephane Nicoll b74c10ba3a Document FilterRegistrationBeans specific default
If a filter is registered in `web.xml` with no `dispatcher` element, the
spec states that it should have the `REQUEST` dispatcher type only.

As we are adding more dispatcher types by default, it can be surprising
for users migrating from a `web.xml` based  web app. The documentation
has now an explicit note about this.

Closes gh-2689
2015-10-27 11:05:56 +01:00
Stephane Nicoll 9af17555c0 Polish 2015-10-27 09:20:16 +01:00
Stephane Nicoll 0e99ba9004 Polish contribution
I don't think we want to keep this on a single line.

Closes gh-4309
2015-10-27 08:58:24 +01:00
Johnny Lim 396bea22b9 Polish docs
See gh-4309
2015-10-27 08:58:12 +01:00
Johnny Lim e477598cc6 Fix broken links
Closes gh-4272
2015-10-22 17:45:35 +02:00
Stephane Nicoll f43817dd27 Fix broken link
Closes gh-4268
2015-10-22 14:11:30 +02:00
Stephane Nicoll 168fc2f61f Disable addResources by default
Flip the default value of `addResources` for both the Maven and Gradle
plugins. This effectively turns off static resources reloading and, more
importantly, the pruning of duplicate resources from the target
directory.

As devetools is our mainstram solution for such feature, the documantion
has been updated to reflect that.

Closes gh-4227
2015-10-20 15:04:25 +02:00
Andy Wilkinson 8ee8c9fe90 Merge branch '1.2.x' 2015-10-12 14:12:20 +01:00
Andy Wilkinson d33d068fae Upgrade to Tomcat 8.0.28 and test support for SSL config from classpath
Prior to 8.0.28 Tomcat required the key store and trust store (if any)
to be available directly on the filesystem, i.e. classpath: resources
would not work. Tomcat 8.0.28 removed this limitation.

This commit updates to Tomcat 8.0.28, updates the tests to verify
the new Tomcat capability and removes the obsolete documentation of
the restriction.

Closes gh-4048
2015-10-12 13:36:32 +01:00
Andy Wilkinson 01eb4cf954 Rework breaking API changes
This commit changes the new mode-based configuration to use two new
methods – setBannerMode on SpringApplication and bannerMode on
SpringApplicationBuilder. The old methods, setShowBanner and
showBanner on SpringApplication and SpringApplicationBuilder
respectively, have been reinstated and deprecated.

Closes gh-4001
2015-10-08 14:41:50 +01:00
“Jeremy 3090659971 Add an option to log banner rather than printing it to standard out
This commit adds the option to output the banner using the logger
instead of standard out. Rather than taking a boolean
spring.main.show-banner is now configured using an enum. Three values
are supported:

 - LOG: the banner is logged
 - CONSOLE: the banner is printed to standard out (previously true)
 - OFF: the banner is switched off (previously false)

The default behavior remains unchanged; the banner will be printed to
standard out.

Closes gh-4022
See gh-4001
2015-10-08 14:41:50 +01:00
Stephane Nicoll b2c3e7e2ed Rename error.* properties to server.error.*
Closes gh-4050
2015-10-02 14:03:24 +02:00
Phillip Webb d4c2959cee Document X-Forwarded-For support
Closes gh-4018
2015-10-02 00:00:22 -07:00
Phillip Webb 026c3019df Polish 2015-09-08 13:37:28 -07:00
Stephane Nicoll ac582709e7 Clarify doc
Closes gh-3858
2015-09-08 14:04:39 +02:00
Phillip Webb 899537deb0 Use dashed property form in documentation 2015-09-03 15:47:55 -07:00
Phillip Webb 6193b640a4 Polish 2015-09-02 23:44:19 -07:00
Andy Wilkinson 003268fb4e Add support for @WebFilter, @WebListener, @WebServlet
This commit adds a new annotation, @ServletComponentScan, that can be
used to enable scanning for @WebFilter, @WebListener, and @WebServlet
annotated classes. Registration beans will be automatically created for
any classes that are found, with the configuration derived from the
annotation.
2015-08-26 15:58:52 +01:00
Dave Syer 2583f8050a Enable Tomcat RemoteIpValve by default
Fixes gh-3782
2015-08-21 09:26:05 +01:00
Stephane Nicoll 7c0c953f81 Add value alias for SpringApplicationConfiguration
Given that Spring Boot uses java config accross the board, a new `value`
attribute is now aliased to the existing `classes` attribute such that
one could write the following:

@SpringApplicationConfiguration(MyConfig.class)
public class MyTest {}

Closes gh-3635
2015-08-19 17:09:34 +02:00
Stephane Nicoll 35c92348ae Document Velocity view resolver customization
Changing the velocity view resolver to a VelocityLayoutViewResolver seems
a common use case so it has now a dedicated section in the relevant how
to.

Closes gh-3732
2015-08-19 14:32:31 +02:00
Dave Syer 68af0a73ec Clarify documentation in a few areas
Fixes gh-3527
2015-08-10 11:50:48 +01:00
Stephane Nicoll 3507451c9a Merge branch '1.2.x' 2015-08-07 16:03:47 +02:00
Stephane Nicoll f88d548de0 Fix typo
Closes gh-3700
2015-08-07 16:03:25 +02:00
Stephane Nicoll 95dac0bbec Polish documentation
Improve the documentation on using two entity managers if Spring Data is
used.

Closes gh-3433
2015-08-07 10:13:34 +02:00
Andy Wilkinson 1a11ed20ba Provide a property to configure conversion word used to log exceptions
This commit adds a new property, logging.exception-conversion-word,
that can be used to configure the conversion word that is used when
logging exceptions. The default value, %rEx, will log exceptions
with the root cause first and include class packaging information in
the stack trace. The new property is supported when using either
Logback or Log4J2.

Closes gh-3684
2015-08-06 11:37:54 +01:00
Rob Winch 91b2c3aee5 Document how to override a dependency version when using Gradle
Closes gh-3651
2015-08-04 09:53:14 +01:00
Phillip Webb 891dd5a0f6 Polish 2015-08-03 11:03:48 -07:00
Andy Wilkinson 24c63c9b55 Adopt RepositoryRestConfigurer and discourage subclassing
A RepositoryRestMvcConfiguration subclass provided by a user is
problematic in a Spring Boot application as it causes
RepositoryRestMvcConfiguration's bean declarations to be processed
before any auto-configuration runs.

One problem that this causes is that it switches off Boot's Jackson
auto-configuration due to RepositoryRestMvcConfiguration having
already declared multiple ObjectMapper beans. Unlike Boot's
auto-configured ObjectMapper, none of these ObjectMappers are marked
as @Primary. This then leads to wiring failures due to multiple
candidates being available.

To address this problem a new RepositoryRestConfigurer abstract has been
introduced in Spring Data Gosling. Its use is now strongly preferred
over subclassing RepositoryRestMvcConfiguration. Note that our own
RepositoryRestMvcConfiguration subclass remains. It is imported as part
of auto-configuration (avoiding the ordering problems described above),
and provides configuration properties binding for
RepositoryRestConfiguration. However, the Jackson ObjectMapper
configuration has been moved out into a new RepositoryRestConfigurer
implementation.

While SpringBootRepositoryRestMvcConfiguration remains, this commit
makes it package private to discourage users from subclassing it. While
this may break existing applications, it, coupled with the documentation
updates, will hopefully guide them toward using
RepositoryRestConfigurer.

Closes gh-3439
2015-07-23 11:58:21 +01:00
izeye 31d8a647d0 Fix typos
Closes gh-3531
2015-07-17 09:08:47 +02:00
Andrew Landsverk 85621a34fb Fix typo in devtools doc
Closes gh-3463
2015-07-13 10:42:51 +01:00
Stephane Nicoll afd357f45a Reduce ConfigFileApplicationListener logs
Previously, all attempts to log a configuration file were logged at DEBUG
level which lead to a lot of noise as Spring Boot looks in many places by
default.

We now only log the files that are effectively found at DEBUG level and
all failed attempts at TRACE level.

Closes gh-3129
2015-07-06 18:05:36 +02:00
izeye 631a02b8bc Fix typo
Closes gh-3403
2015-07-02 07:02:54 -07:00
Matt Benson ae4559eb4f Create spring-boot-antlib module
Create a new spring-boot-antlib module which allows Apache Ant users
to easily create executable jars.

Fixes gh-3339
2015-06-30 00:30:28 -07:00
Andy Wilkinson 00d594dcda Replace GzipFilter and Tomcat compression with general purpose approach
Closes gh-3296
2015-06-29 15:58:57 +01:00
Phillip Webb 4f072f4046 Update logging documentation
Update logging documentation to show the new `-spring` convention and
the Logback extensions.

See gh-1788
See gh-2558
See gh-3338
2015-06-26 15:59:08 -07:00
Stephane Nicoll b2960a7221 Fix typo 2015-06-18 16:55:59 +02:00
Stephane Nicoll df4e08834b Fix inconsistency in doc
See gh-3280
2015-06-18 16:55:28 +02:00
Stephane Nicoll be5e30b409 Migrate spring.view properties
Migrate `spring.view.prefix` and `spring.view.suffix` to
`spring.mvc.view.prefix` and `spring.mvc.view.suffix` respectively. The
former properties are still handled in a backward compatible way and are
defined as deprecated in the meta-data.

Closes gh-3250
2015-06-18 13:55:44 +02:00
Stephane Nicoll c177a774a5 Provide seamless support for local.server.port
Previously, the actual HTTP port on which a web application is running on
was only exposed in tests. This commit makes sure to provide that feature
regardless of the environment so that applications can know on which port
they are actually running on.

If there are several containers, each is exposed via the namespace of
their respective application context.

Closes gh-3259
2015-06-17 11:47:05 +02:00
Eddú Meléndez 0682660387 Add documentation for serialization-inclusion
Document `spring.jackson.serialization-inclusion`.

Closes gh-3224
2015-06-15 08:53:26 +02:00
Stephane Nicoll bb4c89592d Merge branch '1.2.x' 2015-06-14 09:36:25 +02:00
Stephane Nicoll 01ba732a73 Consistent use of "=" for property key
Closes gh-3218
2015-06-14 09:36:10 +02:00
Stephane Nicoll b384f0360c Use proper product name for Intellij IDEA 2015-06-12 17:08:50 +02:00
Stephane Nicoll fcb45a4bb7 Polish devtools documentation
See gh-3088
2015-06-11 09:33:09 +02:00
Phillip Webb 992a56957f Document spring-boot-devtools module
Fixes gh-3088
2015-06-10 22:06:19 -07:00
Phillip Webb 312471f996 Polish documentation 2015-06-04 01:09:59 -07:00
Stephane Nicoll f0b203f6da Update doc for schema creation
See gh-446
2015-05-28 09:45:06 +02:00
Stephane Nicoll 51e6eda88a Update documentation for spring.main.sources
Closes gh-2851
2015-05-27 11:11:19 +02:00
Stephane Nicoll e0d34b9402 Fix build 2015-05-26 11:07:24 +02:00
Andy Wilkinson 7e8bad09db Merge branch '1.2.x' 2015-04-30 15:17:18 +01:00
yinheli ef49ced12a Polish Gradle example for using Undertow
Closes gh-2896
2015-04-30 15:17:01 +01:00
Andy Wilkinson 34b986745c Merge branch '1.2.x' 2015-04-21 15:18:14 +01:00
Kamil Szymanski 88d03b76e9 Fix Groovy templates ViewResolver class name and id in How-to docs
Closes gh-2846
2015-04-21 15:17:57 +01:00
Andy Wilkinson 2c3c62d71c Replace basic Gradle dependency management with use of separate plugin
This commit replaces Spring Boot's basic dependency management support
with separate dependency management plugin. This has a number of
benefits including:

1. A Maven bom can be used rather than a custom properties file
2. Dependency management is applied transitively rather than only to
   direct dependencies
3. Exclusions are applied as they would be in Maven
4. Gradle-generated poms are automatically configured with the
   appropriate dependency management

Closes gh-2133
2015-03-19 13:23:40 +00:00
Stephane Nicoll 3ecf512ab3 Fix documentation
Add `create` as a valid values for `spring.jpa.hibernate.ddl-auto`

Fixes gh-2641
2015-03-13 17:30:05 +01:00
izeye 1493da1e03 Improve documentation
Closes gh-2553
2015-02-25 11:32:58 -08:00
Phillip Webb 7943195d51 Rename RepositoryRestMvcBootConfiguration
Rename RepositoryRestMvcBootConfiguration to
SpringBootRepositoryRestMvcConfiguration so that it follows the same
naming pattern as other custom Spring Boot configurations.

See gh-2392
2015-02-23 21:16:35 -08:00
Phillip Webb 56e31a8c6b Polish 2015-02-23 19:21:37 -08:00
Stephane Nicoll a1b20c3745 Fix typo 2015-02-22 09:48:29 +01:00
Dave Syer 1f316a846d AutoConfigurationReport -> ConditionEvaluationReport
Fixes gh-2493
2015-02-18 13:47:20 +00:00
Andy Wilkinson d87bf707a7 Merge branch '1.1.x' 2015-02-17 10:01:39 +00:00
Andy Wilkinson 0ef3de4d82 Document how to disable auto registration of a Servlet or Filter bean
Closes gh-2173
2015-02-11 13:21:49 +00:00
Stephane Nicoll 1035e5b029 Expose RepositoryRestMvcBootConfiguration
If an application defines a custom RepositoryRestMvcConfiguration, all
Spring Boot defaults are lots. While this sounds sensible, it can be
confusing as Spring Boot exposes properties (`spring.data.rest.*`) that
are no longer honored.

RepositoryRestMvcBootConfiguration is now public and can be used as an
extension point for those who need to customize the Spring Data REST
configuration and keep boot's specific defaults.

Fixes gh-2392
2015-02-10 16:00:11 +01:00
Phillip Webb 072f873f34 Polish 2015-02-01 21:37:17 -08:00
Andy Wilkinson c37633d867 Merge branch '1.1.x' 2015-01-29 12:43:39 +00:00
Andy Wilkinson c3020e9eff Add a single how to for creating a deployable war file
This commit updates the documentation to describe the three steps
involved in producing a deployable war file in a single place.

Closes gh-2185
2015-01-29 12:42:41 +00:00
Andy Wilkinson 4802640399 Reference latest version of Tomcat 7 in the documentation 2015-01-26 14:42:55 +00:00
Andy Wilkinson f96adaf3ac Add some documentation about Java 6 compatibility
Document the need to use a different JTA 1.2 API jar and Tomcat 7 or
Jetty 8 if you’re running on Java 6.

Closes gh-2347
2015-01-22 16:45:46 +00:00
Andy Wilkinson ea7b5c6e3c Improve support for alternative Log4j 2 configuration file formats
This commit adds support for configuring Log4j 2 with YAML. It also
improves the existing support for configuring Log4j 2 with JSON.

Previously, Log4J2LoggingSystem returned a hard-coded list of standard
config locations that includes both JSON and XML file suffixes. Log4j 
2’s support for JSON configuration files requires Jackson’s ObjectMapper
to be on the classpath so, in its absence, the standard config locations
were incorrect.

This commit updates Log4J2LoggingSystem to return an array of standard
config locations based on what’s on the classpath. It also updates the
documentation to describe the additional dependencies that are required
to enable YAML or JSON-based configuration.

Closes gh-2239
2015-01-22 15:06:20 +00:00
Andy Wilkinson e19bfd9251 Document how to use Tomcat 7 or Jetty 8 with Gradle
Previously, the documentation only provided examples of the required
configuration for Maven users. This commit adds equivalent configuration
snippets for those using Gradle. It also removes the recommendation to
override the version of the Servlet API as this is unnecessary. The pom
files for the Jetty 8 and Tomcat 7 samples have also been updated
accordingly.

Closes gh-2346
2015-01-19 14:20:30 +00:00
Andy Wilkinson e2f2839d32 Document Tomcat compression and GzipFilter auto-configuration
Closes gh-2031
2015-01-16 12:07:29 +00:00
Andy Wilkinson 735b96dd0f Document how to configure multiple listeners when using Undertow
Closes gh-2191
2015-01-07 18:04:50 +00:00
Phillip Webb be30385e15 Add @WebIntegrationTest annotation
Add `@WebIntegrationTest` which is similar to `@IntegrationTest` and
`@WebAppConfiguration`. The annotation using Spring's `@BootstrapWith`
annotation rather than `@TestExecutionListeners` which allows it to
work when `@TestExecutionListeners` (even ServletTestExecutionListener)
are declared on the test class.

This annotation is particularly useful for TestNG users that extend
Spring's `AbstractTestNGSpringContextTests` class.

Fixes gh-2299
See gh-1956
See gh-2135
2015-01-06 21:03:48 -08:00
pauldub b865539adc Fix typo in howto.adoc 2014-12-19 15:22:28 +01:00
Hendy Irawan ba97090375 Clarify SSL "How-to" documentation
Update the SSL "How-to" documentation to make it clearer that SSL
configuration replaces the usual connector.

Closes gh-2172
See gh-2167
2014-12-17 16:13:28 -08:00
Stephane Nicoll 1b039e78e6 Documentation improvement of DataSource configuration
Closes gh-2126
2014-12-17 14:25:33 +01:00
Phillip Webb e772174019 Update reference documentation for Spring Boot 1.2
Various updates and polish to prepare the reference documentation for
Spring Boot 1.2.

Fixes gh-1903
2014-12-10 00:56:41 -08:00
Phillip Webb 119a5656e2 Update SpringBootServletInitializer ref docs
Add a hint to show that the `configure` method is now optional.

Fixes gh-2074
2014-12-10 00:49:31 -08:00
Phillip Webb b651090fcd Document how-to for Weblogic deployment
Fixes gh-2078
2014-12-07 20:11:48 -08:00
Andy Wilkinson a83f9c6311 Correct markup in documentation of how to configure Undertow 2014-11-26 10:55:33 +00:00
Andy Wilkinson 55fadf1231 Merge branch '1.1.x' 2014-11-25 13:54:06 +00:00
Andy Wilkinson 2b4eee5e53 Add a note explaining that double backslashes are unnecessary in YAML
Closes gh-1989
2014-11-25 13:52:26 +00:00
Sjoerd Mulder cc557833a4 Escape backslashes in .properties examples of setting internal-proxies
In a properties file, a backslash is used as an escape character for
the line terminator sequence to allow values to be split across
multiple lines. When a backslash is used elsewhere they're stripped
out of the property's value.

This commit updates .properties-based examples for configuring
server.tomcat.internal-proxies to escape the backslahes so that they
are retained in the property's value at runtime.

See gh-1989
2014-11-25 13:39:25 +00:00
Andy Wilkinson efe50ebcad Document WebSocket exclusions that are required when using Jetty 8
Closes gh-1969
2014-11-24 16:59:07 +00:00
Phillip Webb 08988fd182 Update docs about Jetty 9 and Tomcat 8
Fixes gh-1951
2014-11-20 17:55:15 -08:00