Commit Graph

1486 Commits (ccabfe7b8c39e8427aa9935ccaa82dba37002ef1)

Author SHA1 Message Date
dreis2211 355505d236 Fix syntax error in configuration metadata sample in docs
See gh-19028
5 years ago
Stephane Nicoll b842f16848 Polish "Use caps in docker file example for consistency"
See gh-19029
5 years ago
Dave Syer b95e8a4df6 Use caps in docker file example for consistency
See gh-19029
5 years ago
Stephane Nicoll d08b436735 Polish "Improve Deploying to Containers section"
See gh-18932
5 years ago
Guillaume Lours 6cf05aeb50 Improve Deploying to Containers section
See gh-18932
5 years ago
Andy Wilkinson 379ba0dc00 Support Gradle 6.0
Previously, our Gradle plugin was not tested against Gradle 6.0,
a number of deprecation warnings were output when using the plugin
with Gradle 6, and some functionality related to the application
plugin did not work as expected.

This commit tests the plugin against Gradle 6. It also avoids calling
deprecated APIs. The plugin is compatibile against Gradle 4.10 where
the deprecated APIs' replacements are not available so reflection is
used to call the replcaements. Lastly, the way in which the base name
of the boot distribution that is created when the application plugin
is applied has been modified to ensure that it is effective when using
Gradle 6.

Closes gh-18663
5 years ago
Madhura Bhave f9dc81558a Remove samples references from docs
Fixes gh-18904
5 years ago
Andy Wilkinson d8545bdead Merge branch '2.1.x'
Closes gh-18887
5 years ago
Andy Wilkinson 8b62f448ba Improve documentation on using Jersey alongside Spring MVC
Previously, the documentation did not provide any guidance on using
Jersey alongside Spring MVC or any other web framework.

This improves the documentation in two ways:

1. It notes that, in the presence of both Jersey and Spring MVC, the
   Actuator will prefer Spring MVC for exposing HTTP endpoints.
2. It adds a how-to describing how to configure Jersey to forward
   requests for which it has no handler on to the rest of the filter
   chain. When Spring MVC is the other framework, this allows them to
   be handled by its dispatcher servlet.

Closes gh-17523
5 years ago
Andy Wilkinson 571e4640de Merge branch '2.1.x'
Closes gh-18877
5 years ago
Andy Wilkinson bd06a91ac0 Recommend more overrides when using starter parent
This commit is a continuation of the work done in 987a5f81. In
addition to developers and licenses that are covered in the earlier
commit, a number of other settings are still inherited from the
starter parent. This commit updates the documentation to show them
being overridden as well.

Closes gh-18532
5 years ago
Stephane Nicoll d331f28222 Merge branch '2.1.x'
Closes gh-18885
5 years ago
Stephane Nicoll 4d1373c94d Polish "Support amqps:// URIs in spring.rabbitmq.addresses"
See gh-18808
5 years ago
Andy Wilkinson a65374b16b Merge branch '2.1.x'
Closes gh-18880
5 years ago
Andy Wilkinson cb76502a44 Document that JUL is not bridged into SLF4J when deployed to a container
Closes gh-16062
5 years ago
Andy Wilkinson 2c309c5d93 Merge branch '2.1.x'
Closes gh-18879
5 years ago
Andy Wilkinson 1c6f2af475 Clarify how to configure a Filter's order
Closes gh-18266
5 years ago
Andy Wilkinson abeafb325e Merge branch '2.1.x'
Closes gh-18877
5 years ago
Andy Wilkinson 987a5f8103 Recommend overriding licences and developers when using starter parent
Publishing to Maven Central requires spring-boot-starter-parent to
declare its license and developers. When a user then uses
spring-boot-starter-parent as their project's parent, these values
are inherited and this is almost certainly unwanted.

This commit updates the documentation to recommend and demonstrate
overriding the license and developers that are inherited from the
starter parent.

Closes gh-18532
5 years ago
Andy Wilkinson 36b1f65056 Merge branch '2.1.x'
Closes gh-18876
5 years ago
Andy Wilkinson 89e050d722 Document security risks of DevTools' remote support more clearly
Previously, the security risks and our recommendations on how to
mitigate them were not documented as clearly as they could have been.
This commit makes some changes to try to address this:

1. The security risk is now noted at the beginning of the section
2. The recommendation to use SSL is now documented more prominently
   and an alternative recommendation to only use remote support on
   a trusted network has been added.
3. The example secret has been removed to prevent copy and paste
4. A recommendation to use a secret that is unique and strong has been
   added

Closes gh-18825
5 years ago
Stephane Nicoll da24a66ce6 Merge branch '2.1.x'
Closes gh-18875
5 years ago
Stephane Nicoll 5863a75c3c Polish "Document Settings as jooq supported auto-configuration type"
See gh-18870
5 years ago
Jens Teglhus Møller c34516cd9e Document Settings as jooq supported auto-configuration type
See gh-18870
5 years ago
Andy Wilkinson 07ca7747fa Clarify what an endpoint needs to be auto-configured
Previously, the endpoint tables in the documentation include an
"Enabled by default" column that listed whether or not an endpoint
was enabled by default. This resulted in some confusion as an endpoint
could be listed as being enabled by default but not actually be
enabled as the requirements for it being auto-configured has not been
met.

This commit removes the "Enabled by default" column and replaces it,
where needed, with some extra information in the "Description"
column that describes what is needed for the endpoint to be
auto-configured.

Closes gh-18633
5 years ago
Andy Wilkinson e26d5d95a8 Do not enable @ConfigurationPropertiesScan be default
In 2.2.0, @ConfigurationPropertiesScan was enabled by default.
Unfortunately, this had the unexpected side-effect of breaking
conditional enablement of a @ConfigurationProperties class via
@EnableConfigurationProperties if the @ConfigurationProperties class
was in a package covered by scanning.

This commit remove @ConfigurationPropertiesScan from
@SpringBootApplication so that it is no longer enabled by default.
2.1.x users who rely upon such conditional enablement of
@ConfigurationProperties classes can now upgrade to 2.2.x without
having to make any changes. Users who do not have such a need and are
in a position to use configuration properties scanning can now opt-in
by adding @ConfigurationPropertiesScan to their main application class
alongside @SpringBootApplication.

Closes gh-18674
5 years ago
Brian Clozel b7f59eb7cb Add config property for webflux codec maxInMemorySize
This commit creates a new configuration property
`spring.codec.max-in-memory-size` which configures the maximum
amount of data to be buffered in memory by codecs (both client and
server).

This property has no default value - it will let Spring Framework handle
the default behavior, currently enforcing a 256KB for provided codecs.

Fixes gh-18828
5 years ago
Stephane Nicoll 2d0a235c52 Add "Deploying to Containers" dedicated section
Closes gh-18818
5 years ago
Stephane Nicoll a664eadb9a Merge branch '2.1.x'
Closes gh-18756
5 years ago
wwjay9 bd77c170f2 Fix OAuth2 Client redirect-uri references
See gh-18752
5 years ago
Madhura Bhave 25077de0b3 Merge branch '2.1.x'
Closes gh-18735
5 years ago
Madhura Bhave 593eca7998 Emphasize need for quotes around YAML bracket notation
Closes gh-18690
5 years ago
Madhura Bhave bc3c3232c2 Merge branch '2.1.x'
Closes gh-18734
5 years ago
Madhura Bhave e59a643e20 Emphasize the need of @Valid on nested configuration properties
Closes gh-18198
5 years ago
Andy Wilkinson 9b039c491f Merge branch '2.1.x'
Closes gh-18726
5 years ago
Andy Wilkinson d4cd03ebd8 Document need for micrometer-jersey2 dependency to get Jersey metrics
Closes gh-18622
5 years ago
Philippe De Neve 8f990d97ab Polish documentation
* Remove double occurrence of InfluxDbHealthIndicator.
* Fix JUnit 5 `@ExtendWith` references
* Use consistent casing of HtmlUnit.

See gh-18718
5 years ago
Stephane Nicoll 8eecc911fb Merge branch '2.1.x'
Closes gh-18713
5 years ago
nkjackzhang 6ef39d6b91 Fix typos
See gh-18705
5 years ago
Stephane Nicoll 89d903d89a Fix typo in devtools example
Closes gh-18679
5 years ago
Stephane Nicoll fd94608f73 Polish "Restore proxying of @Bean methods in @TestConfiguration"
See gh-18675
5 years ago
Andy Wilkinson 2cdf801e7f Add a note to the docs about combining multiple security components
Previously, the documentation did not describe how to combine
multiple security components when one component's
WebSecurityConfigurerAdapter or SecurityWebFilterChain would cause
the other components' beans of the same type to back off.

This commit adds a note that such cases should be handled by the user
defining their own WebSecurityConfigurerAdapter or
SecurityWebFilterChain that configures the use of all of the
components as required.

Closes gh-18507
5 years ago
Brian Clozel e4fa9ce8c6 Deprecate server.connection-timeout property
Prior to this commit, all supported servers would share the same
configuration property `server.connection-timeout`. Unfortunately, in
many cases the behavior of this timeout changes depending on the server.
From actual connection setup timeout, to detecting and closing idle
connections, this property cannot be properly translated from one server
implementation to another.

This commit deprecates this configuration property and introduces server
specific properties:

* `server.jetty.connection-idle-timeout`
(Time that the connection can be idle before it is closed.)
* `server.netty.connection-timeout`
(Connection timeout of the Netty channel.)
* `server.tomcat.connection-timeout`
(Amount of time the connector will wait, after accepting a connection,
for the request URI line to be presented.)
* `server.undertow.no-request-timeout`
(Amount of time a connection can sit idle without processing a request,
before it is closed by the server.)

`server.connection-timeout` is now deprecated and will be removed in a
future release.

Fixes gh-18473
5 years ago
Stephane Nicoll 4efb4d1dd3 Polish "Add some more notes on running exploded jar files"
See gh-18477
5 years ago
Dave Syer 3f2dd30808 Add some more notes on running exploded jar files
See gh-18477
5 years ago
Stephane Nicoll 22f44917ca Polish "Add metadata entry for spring.main.register-shutdown-hook"
See gh-18581
5 years ago
leoli 9b781449cf Add metadata entry for spring.main.register-shutdown-hook
See gh-18581
5 years ago
Stephane Nicoll 75bd15650f Merge branch '2.1.x'
Closes gh-18587
5 years ago
Stephane Nicoll f05d7902e2 Polish "Clarify formatting recommendations for configuration property javadoc"
See gh-18578
5 years ago
Rafiullah Hamedy 1f9b68707f Clarify formatting recommendations for configuration property javadoc
This commit adds a note to spring-boot-features.adoc to clarify that
using javadoc tags to format configuration property descriptions is not
supported.

See gh-18578
5 years ago
Andy Wilkinson 65818038fe Polish "Update Kotlin-related reference documentation"
See gh-18573
5 years ago
Sebastien Deleuze c6c9818285 Update Kotlin-related reference documentation
See gh-18573
5 years ago
Andy Wilkinson c75b06c76c Remove @ImmutableConfigurationProperties
Closes gh-18563
5 years ago
Stephane Nicoll f7959bcd00 Merge branch '2.1.x'
Closes gh-18567
5 years ago
Ted M. Young f553784ebc Fix incorrect backslash escape in documentation sample
See gh-18546
5 years ago
leoli 2b5f8f36a2 Fix ImmutableConfigurationProperties import statement in ref docs
See gh-18548
5 years ago
Andy Wilkinson 002b2709d9 Document auditevent and httptrace endpoints' need for repositories
Closes gh-18352
5 years ago
Johnny Lim 701bd0dd46 Polish
See gh-18490
5 years ago
Phillip Webb 795303d667 Replace depends-on post processor configurations
Replace `AbstractDependsOnBeanFactoryPostProcessor` `@Configuration`
classes with simple `@Import` component classes.

Closes gh-18382
5 years ago
Phillip Webb 386c0a60a7 Relax @ConstructorBinding member class requirement
Update `@ConfigurationProperties` so that `@ConstructorBinding` classes
no longer need to repeat the annotation for their members.

Closes gh-18481
5 years ago
Madhura Bhave e6bb7a0a6f Add spring security rsocket dependency to docs 5 years ago
Madhura Bhave 5547a8499f Polish 5 years ago
Madhura Bhave fd721575f0 Add spring security saml dependency to docs 5 years ago
Madhura Bhave 22ed56ac52 Add auto-config for Spring Security's SAML support
Closes gh-18260

Co-authored-by: Phillip Webb <pwebb@pivotal.io>
5 years ago
Andy Wilkinson 96f85a40de Support customization of WebTestClient.Builder when using @SpringBootTest
Closes gh-15132
5 years ago
Andy Wilkinson 46c30d6bb0 Merge branch '2.1.x'
Closes gh-18476
5 years ago
Andy Wilkinson 3d4157ad6d Correct SCM URLs in published poms
Previously, Maven's default behaviour was relied up which resulted
in the artifact ID being appended to each URL as it was inherited.
This behaviour can only be disabled in Maven 3.6 and later, a version
that we cannot use due to an incompatibility with the Flatten Plugin.

This commit works around Maven's default behaviour by defining
properties for the SCM URL, connection, and developer connection and
then explicitly defining the settings in each pom using these
properties. The explicit definition of the properties in each pom
prevents them being inherited from the parent, thereby disabling the
unwanted appending of the artifact ID to the URL.

Fixes gh-18328
5 years ago
Phillip Webb e41c5a4327 Require annotation signal for constructor binding
Update `@ConfigurationProperties` constructor binding support to only
apply when a `@ConstructorBinding` annotation is present on either the
type or the specific constructor to use.

Prior to this commit we didn't have a good way to tell when constructor
binding should be used vs regular autowiring.

For convenience, an `@ImmutableConfigurationProperties` meta-annotation
has also been added which is composed of `@ConfigurationProperties` and
`@ConstructorBinding`.

Closes gh-18469
5 years ago
Johnny Lim 3a63179d81 Fix a broken Asciidoctor syntax
Along the way, this commit also fixes a typo.

Closes gh-18325
5 years ago
Andy Wilkinson a6f1619971 Use Asciidoctor extension to verify documented configuration properties
Closes gh-18451
5 years ago
Stephane Nicoll 1066b97113 Merge branch '2.1.x'
Closes gh-18437
5 years ago
dreis2211 208fb8f1ef Add Mustache to 'Customize ViewResolvers' docs section
See gh-18378
5 years ago
dreis2211 37dbe647f2 Polish some external documentation links
See gh-18384
5 years ago
dreis2211 edefbfde42 Mention Java 13 in system requirements docs
See gh-18383
5 years ago
Stephane Nicoll 15eeedb59a Merge branch '2.1.x'
Closes gh-18380
5 years ago
Johnny Lim 7319908b40 Polish
See gh-18347
5 years ago
dreis2211 14d7777138 Add missing appendices to PDF reference documentation
See gh-18371
5 years ago
Phillip Webb a94ab673a3 Add health endpoint 'show-components' support
Add a `show-components` property under `management.endpoint.health` and
`management.endpoint.health.group.<name>` that can be used to change
when components are displayed.

Prior to this commit it was only possible to set `show-details` which
offered an "all or nothing" approach to the resulting JSON. The new
switch allows component information to be displayed whilst still hiding
potentially sensitive details returned from the actual `HealthIndicator`.

Closes gh-15076
5 years ago
Andy Wilkinson 4ab53dc8ce Fix broken and redirected links in the reference documentation
Fixes gh-18332
5 years ago
Brian Clozel eeaa9bc6c1 Fix ref docs code snippet theme
This commit also fixes a link in the reference documentation.

See gh-18293
5 years ago
Stephane Nicoll ddc96c1a62 Merge branch '2.1.x'
Closes gh-18336
5 years ago
leoli 09cf1e6791 Fix property name in "Task Execution and Scheduling" example
See gh-18331
5 years ago
Brian Clozel 60b1bbb8b2 Polish "Reference Spring Framework RSocket section + polish"
See gh-18321
5 years ago
Rossen Stoyanchev 9a70b5d1f5 Reference Spring Framework RSocket section + polish 5 years ago
Andy Wilkinson 4cc7fef728 Deprecate support for Spring Cloud Connectors in favor of Java CFEnv
Closes gh-17877
5 years ago
Andy Wilkinson 79b5fd9d73 Polish "Allow the user that runs the app to be specified via an env var"
See gh-16973
5 years ago
Wagner Macedo b57f35893c Allow the user that runs the app to be specified via an env var
See gh-16973
5 years ago
Andy Wilkinson 451703f321 Merge branch '2.1.x'
Closes gh-18297
5 years ago
Alessandro Falappa b1750defde Fix typo in configuration metadata appendix
See gh-18289

Closes gh-18289
5 years ago
Phillip Webb 838e7eb605 Extract spring-doc-resources URL property
Update the build to use a shared spring-doc-resources URL
rather than repeating it multiple times.

See gh-18293
5 years ago
Madhura Bhave 48960c54d1 Drop . prefix from files in .config directory for devtools
Closes gh-18006
5 years ago
Madhura Bhave d092df43b7 Merge branch '2.1.x'
Closes gh-18296
5 years ago
Madhura Bhave 3c4449bf0e Polish "Fix typo in logback example"
See gh-18295
5 years ago
Harald Brabenetz 0091c04720 Fix typo in logback example
See gh-18295
5 years ago
Brian Clozel 3b0c4b1837 Upgrade Spring Doc Resources and switch to light theme
See gh-18293
5 years ago
Brian Clozel 79e4d1354d Warn about RSocket web server compatibility
This commit warns developers about the fact that plugging RSocket into
an existing web server is only possible with Reactor Netty web servers.
RSocket itself is using Reactor Netty, so this is why we can plug an
RSocket over websocket handler in an existing Reactor Netty handler.

This feature is not possible with other web servers, as existing APIs do
not make that possible.

Fixes gh-17494
5 years ago
Andy Wilkinson 02ac089767 Polish "Support zip64 jars"
See gh-16091
5 years ago
Johnny Lim 0243cfa23e Fix a broken Asciidoctor syntax
Along the way, this commit also fixes a typo.

See gh-18288
5 years ago
Madhura Bhave 02759d65bf Merge branch '2.1.x' 5 years ago
Madhura Bhave f9d94c6ed0 Remove duplicate word in docs 5 years ago
Stephane Nicoll 19115d19f0 Merge branch '2.1.x'
Closes gh-18283
5 years ago
Alessandro Falappa 6dab9bb224 Fix pre-defined logging group documentation
See gh-18270
5 years ago
Johnny Lim b70be97cbf Polish
See gh-18281
5 years ago
Alessandro Falappa 38fb16a79d Fix typos in HealthContributors definition
See gh-18249
5 years ago
Alessandro Falappa 4aa186d6e5 Remove duplicated row from HealthIndicators table
See gh-18248
5 years ago
Andy Wilkinson d5adbbb626 Split appendices into multiple pages and include a ToC in each
Closes gh-16289
5 years ago
Andy Wilkinson cc67213b1f Correct capitalization of GemFire in the reference docs
Closes gh-18001
5 years ago
Andy Wilkinson 6f20ba9550 Remove mention of Spring IO Platform from reference docs
Closes gh-17986
5 years ago
Stephane Nicoll a0d7d52106 Polish "Add ROLLING_FILE_NAME_PATTERN for File Appender"
See gh-18151
5 years ago
Eddú Meléndez 4a3810a0f1 Add ROLLING_FILE_NAME_PATTERN for File Appender
This new property allows to customize `fileNamePattern` if it is set.
Otherwise, a default pattern remains. Also, new property is supported
`logging.pattern.rolling-file-name`.

See gh-18151
5 years ago
Stephane Nicoll b5589f8abe Merge branch '2.1.x'
Closes gh-18222
5 years ago
Peter Sauer dba18ce778 Fix minor typo
The phrase `We have you covered.` is a sentence and so it should start
with a capital `W`.

See gh-18216
5 years ago
Johnny Lim 5b41c3b608 Polish
See gh-18192
5 years ago
Andy Wilkinson f033016364 Allow @Component on mutable @ConfigurationProperties
Update configuration properties support to allow the `@Component`
annotation to be used on `@ConfigurationProperties` beans as long
as they are mutable.

This restores the behavior of Spring Boot 2.1 for mutable beans whilst
still allowing us to enforce the stricter rules for immutable value
object configuration properties.

Closes gh-18138
5 years ago
Andy Wilkinson 0074a7c662 Merge branch '2.1.x' 5 years ago
Andy Wilkinson 4f21b51a2b Polish one sentence per line in the reference docs 5 years ago
dreis2211 0975b5b220 Fix link formatting in custom HealthIndicator section
See gh-18170
5 years ago
dreis2211 09e991ca1c Fix broken links for master snapshot builds
See gh-18172
5 years ago
Andy Wilkinson 715e90437f Merge branch '2.1.x' 5 years ago
Andy Wilkinson 8882c532cd Correct attribute references in reference documentation
Fixes gh-18163
5 years ago
Phillip Webb f70c0b8fbb Merge branch '2.1.x' 5 years ago
Phillip Webb a3cde7fd8d Fix typo 5 years ago
Phillip Webb 877c65c714 Merge branch '2.1.x'
Closes gh-18132
5 years ago
Phillip Webb a0a204ae6a Clarify devtools trigger file documentation
Closes gh-17775
5 years ago
Phillip Webb 1851f7119f Merge branch '2.1.x' 5 years ago
Phillip Webb f1bbb2a017 Fix documentation typos
See gh-16718
5 years ago
Andy Wilkinson 8190b8eafb Merge branch '2.1.x'
Closes gh-18125
5 years ago
Andy Wilkinson 7f62c5a283 Provide a How-To for customizing Reactor Netty's TcpClient
Closes gh-17856
5 years ago
Phillip Webb 5c665ddd55 Merge branch '2.1.x'
Closes gh-18120
5 years ago
Phillip Webb 624c118cdf Polish "Document the pros and cons of MockMvc"
See gh-16718
5 years ago
Tetsuya Hasegawa 8f8a4af001 Document the pros and cons of MockMvc
Update the MockMvc documentation to provide more details about the
pros and cons of such an approach, specifically calling out the
difference with error page handling.

See gh-16718
5 years ago
Phillip Webb b43edf5493 Merge branch '2.1.x'
Closes gh-18118
5 years ago
Phillip Webb 158e25c00f Extend documentation on logback include files
Expand the Logback "How To" to provide further clarifications on
the different include files available.

See gh-16901
5 years ago
michal 1f97a60d16 Clarify documentation on logback include files
Update documentation and comments on Logback to show the correct
use of `default.xml` rather than `base.xml`.

See gh-16901
5 years ago
Stephane Nicoll 5dc133ae9e Merge branch '2.1.x'
Closes gh-18098
5 years ago
dreis2211 087795fb67 Remove duplicated dependency in spring-boot-docs
See gh-18092
5 years ago
dreis2211 b4350a9d96 Remove unnecessary blank lines
See gh-18089
5 years ago
Phillip Webb 58734873dd Merge branch '2.1.x'
Closes gh-18081
5 years ago
Phillip Webb e07889b092 Document that Filter beans are eagerly initialized
Closes gh-17814
5 years ago
Phillip Webb 117a2ecda9 Merge branch '2.1.x'
Closes gh-18080
5 years ago
Phillip Webb 7e60f4b32a Clarify "YAML Shortcomings" documentation
Closes gh-17933
5 years ago
Phillip Webb d655684135 Merge branch '2.1.x'
Closes gh-18079
5 years ago
Phillip Webb ffbd11caba Document logger environment variable restrictions
Update the reference guide with a note about using environment variables
to configure logging.

Closes gh-17958
5 years ago
Phillip Webb 71b99e5c83 Merge branch '2.1.x'
Closes gh-18026
5 years ago
Phillip Webb 6ca92418b5 Document need to exactly JPA property names
Closes gh-17975
5 years ago
Phillip Webb 230506b30c Merge branch '2.1.x' 5 years ago
Phillip Webb e4dfb74629 Polish 5 years ago
Phillip Webb 85784ba6ea Merge branch '2.1.x'
Closes gh-18025
5 years ago
Phillip Webb 1ff784ff54 Remove MBean shutdown warning from documentation
Closes gh-17988
5 years ago
Phillip Webb 51e71f7ff1 Merge branch '2.1.x'
Closes gh-18024
5 years ago