From 2929d33e373a469c6114365ac899932747d28088 Mon Sep 17 00:00:00 2001 From: Phillip Webb Date: Tue, 18 Mar 2014 13:17:37 -0700 Subject: [PATCH] Add links in Appendix B Fixes gh-491 --- .../appendix-application-properties.adoc | 50 +++++++++---------- 1 file changed, 25 insertions(+), 25 deletions(-) diff --git a/spring-boot-docs/src/main/asciidoc/appendix-application-properties.adoc b/spring-boot-docs/src/main/asciidoc/appendix-application-properties.adoc index aeb8a0570c0..706085ee732 100644 --- a/spring-boot-docs/src/main/asciidoc/appendix-application-properties.adoc +++ b/spring-boot-docs/src/main/asciidoc/appendix-application-properties.adoc @@ -13,7 +13,7 @@ your own properties. WARNING: This sample file is meant as a guide only. Do **not** copy/paste the entire content into your application; rather pick only the properties that you need. -[source,properties,indent=0,subs="verbatim,attributes"] +[source,properties,indent=0,subs="verbatim,attributes,macros"] ---- # =================================================================== # COMMON SPRING BOOT PROPERTIES @@ -26,14 +26,14 @@ content into your application; rather pick only the properties that you need. # CORE PROPERTIES # ---------------------------------------- -# SPRING CONFIG (ConfigFileApplicationListner) +# SPRING CONFIG ({sc-spring-boot}/context/config/ConfigFileApplicationListener.{sc-ext}[ConfigFileApplicationListener]) spring.config.name= # config file name (default to 'application') spring.config.location= # location of config file # PROFILES spring.profiles= # comma list of active profiles -# APPLICATION SETTINGS (SpringApplication_ +# APPLICATION SETTINGS ({sc-spring-boot}/SpringApplication.{sc-ext}[SpringApplication]) spring.main.sources= spring.main.web-environment= # detect by default spring.main.show-banner=true @@ -44,11 +44,11 @@ logging.path=/var/logs logging.file=myapp.log logging.config= -# IDENTITY (ContextIdApplicationContextInitializer) +# IDENTITY ({sc-spring-boot}/context/ContextIdApplicationContextInitializer.{sc-ext}[ContextIdApplicationContextInitializer]) spring.application.name= spring.application.index= -# EMBEDDED SERVER CONFIGURATION (ServerProperties) +# EMBEDDED SERVER CONFIGURATION ({sc-spring-boot-autoconfigure}/web/ServerProperties.{sc-ext}[ServerProperties]) server.port=8080 server.address= # bind to a specific NIC server.session-timeout= # session timeout in sections @@ -62,25 +62,25 @@ server.tomcat.basedir=/tmp # base dir (usually not needed, defaults to tmp) server.tomcat.background-processor-delay=30; # in seconds server.tomcat.max-threads = 0 # number of threads in protocol handler -# SPRING MVC (HttpMapperProperties) +# SPRING MVC ({sc-spring-boot-autoconfigure}/web/HttpMapperProperties.{sc-ext}[HttpMapperProperties]) http.mappers.json-pretty-print=false # pretty print JSON http.mappers.json-sort-keys=falose # sort keys spring.view.prefix= # MVC view prefix spring.view.suffix= # ... and suffix spring.resources.cache-period= # cache timeouts in headers sent to browser -# THYMELEAF (ThymeleafAutoConfiguration) +# THYMELEAF ({sc-spring-boot-autoconfigure}/thymeleaf/ThymeleafAutoConfiguration.{sc-ext}[ThymeleafAutoConfiguration]) spring.thymeleaf.prefix=classpath:/templates/ spring.thymeleaf.suffix=.html spring.thymeleaf.mode=HTML5 spring.thymeleaf.encoding=UTF-8 spring.thymeleaf.cache=true # set to false for hot refresh -# INTERNATIONALIZATION (MessageSourceAutoConfiguration) +# INTERNATIONALIZATION ({sc-spring-boot-autoconfigure}/MessageSourceAutoConfiguration.{sc-ext}[MessageSourceAutoConfiguration]) spring.messages.basename=messages spring.messages.encoding=UTF-8 -# SECURITY (SecurityProperties) +# SECURITY ({sc-spring-boot-autoconfigure}/security/SecurityProperties.{sc-ext}[SecurityProperties]) security.user.name=user # login username security.user.password= # login password security.user.role=USER # role assigned to the user @@ -88,7 +88,7 @@ security.require-ssl=false # advanced settings ... security.enable-csrf=false security.basic.enabled=true security.basic.realm=Spring -security.basic.path=/** +security.basic.path= # /** security.headers.xss=false security.headers.cache=false security.headers.frame=false @@ -97,7 +97,7 @@ security.headers.hsts=all # none / domain / all security.sessions=stateless # always / never / if_required / stateless security.ignored=false -# DATASOURCE (DataSourceAutoConfiguration & AbstractDataSourceConfiguration) +# DATASOURCE ({sc-spring-boot-autoconfigure}/jdbc/DataSourceAutoConfiguration.{sc-ext}[DataSourceAutoConfiguration] & {sc-spring-boot-autoconfigure}//jdbc/AbstractDataSourceConfiguration.{sc-ext}[AbstractDataSourceConfiguration]) spring.datasource.name= # name of the data source spring.datasource.intialize=true # populate using data.sql spring.datasource.schema= # a schema resource reference @@ -114,12 +114,12 @@ spring.datasource.validation-query= spring.datasource.test-on-borrow=false spring.datasource.test-on-return=false -# MONGODB (MongoProperties) +# MONGODB ({sc-spring-boot-autoconfigure}/mongo/MongoProperties.{sc-ext}[MongoProperties]) spring.data.mongodb.host= # the db host spring.data.mongodb.port=27017 # the connection port (defaults to 27107) spring.data.mongodb.uri=mongodb://localhost/test # connection URL -# JPA (JpaBaseConfiguration, HibernateJpaAutoConfiguration) +# JPA ({sc-spring-boot-autoconfigure}/orm/jpa/JpaBaseConfiguration.{sc-ext}[JpaBaseConfiguration], {sc-spring-boot-autoconfigure}/orm/jpa/HibernateJpaAutoConfiguration.{sc-ext}[HibernateJpaAutoConfiguration]) spring.jpa.properties.*= # properties to set on the JPA connection spring.jpa.openInView=true spring.jpa.show-sql=true @@ -132,7 +132,7 @@ spring.jpa.hibernate.ddl-auto= # defaults to create-drop for embedded dbs # JMX spring.jmx.enabled=true # Expose MBeans from Spring -# RABBIT (RabbitProperties) +# RABBIT ({sc-spring-boot-autoconfigure}/amqp/RabbitProperties.{sc-ext}[RabbitProperties]) spring.rabbitmq.host= # connection host spring.rabbitmq.port= # connection port spring.rabbitmq.addresses= # connection addresses (e.g. myhost:9999,otherhost:1111) @@ -142,7 +142,7 @@ spring.rabbitmq.virtualhost= spring.rabbitmq.dynamic= -# REDIS (RedisProperties) +# REDIS ({sc-spring-boot-autoconfigure}/redis/RedisProperties.{sc-ext}[RedisProperties]) spring.redis.host=localhost # server host spring.redis.password= # server password spring.redis.port=6379 # connection port @@ -151,15 +151,15 @@ spring.redis.pool.min-idle=0 spring.redis.pool.max-active=8 spring.redis.pool.max-wait=-1 -# ACTIVEMQ (ActiveMQProperties) +# ACTIVEMQ ({sc-spring-boot-autoconfigure}/jms/ActiveMQProperties.{sc-ext}[ActiveMQProperties]) spring.activemq.broker-url=tcp://localhost:61616 # connection URL spring.activemq.in-memory=true spring.activemq.pooled=false -# JMS (JmsTemplateProperties) +# JMS ({sc-spring-boot-autoconfigure}/jms/JmsTemplateProperties.{sc-ext}[JmsTemplateProperties]) spring.jms.pub-sub-domain= -# SPRING BATCH (BatchDatabaseInitializer) +# SPRING BATCH ({sc-spring-boot-autoconfigure}/batch/BatchDatabaseInitializer.{sc-ext}[BatchDatabaseInitializer]) spring.batch.job.names=job1,job2 spring.batch.job.enabled=true spring.batch.initializer.enabled=true @@ -169,19 +169,19 @@ spring.batch.schema= # batch schema to load spring.aop.auto= spring.aop.proxyTargetClass= -# FILE ENCODING (FileEncodingApplicationListener) +# FILE ENCODING ({sc-spring-boot}/context/FileEncodingApplicationListener.{sc-ext}[FileEncodingApplicationListener]) spring.mandatory-file-encoding=false # ---------------------------------------- # ACTUATOR PROPERTIES # ---------------------------------------- -# MANAGEMENT HTTP SERVER (ManagementServerProperties) +# MANAGEMENT HTTP SERVER ({sc-spring-boot-actuator}/autoconfigure/ManagementServerProperties.{sc-ext}[ManagementServerProperties]) management.port= # defaults to 'server.port' management.address= # bind to a specific NIC management.contextPath= # default to '/' -# ENDPOINTS (AbstractEndpoint subclasses) +# ENDPOINTS ({sc-spring-boot-actuator}/endpoint/AbstractEndpoint.{sc-ext}[AbstractEndpoint] subclasses) endpoints.autoconfig.id=autoconfig endpoints.autoconfig.sensitive=true endpoints.autoconfig.enabled=true @@ -220,21 +220,21 @@ endpoints.jolokia.sensitive=true endpoints.jolokia.enabled=true # when using Jolokia endpoints.error.path=/error -# JMX ENDPOINT (EndpointMBeanExportProperties) +# JMX ENDPOINT ({sc-spring-boot-actuator}/autoconfigure/EndpointMBeanExportProperties.{sc-ext}[EndpointMBeanExportProperties]) endpoints.jmx.enabled=true endpoints.jmx.domain= # the JMX domain, defaults to 'org.springboot' endpoints.jmx.unique-names=false endpoints.jmx.enabled=true endpoints.jmx.staticNames= -# JOLOKIA (JolokiaProperties) +# JOLOKIA ({sc-spring-boot-actuator}/autoconfigure/JolokiaProperties.{sc-ext}[JolokiaProperties]) jolokia.config.*= # See Jolokia manual # REMOTE SHELL shell.auth=simple # jaas, key, simple, spring shell.command-refresh-interval=-1 -shell.command-path-pattern=classpath*:/commands/**, classpath*:/crash/commands/** -shell.config-path-patterns=classpath*:/crash/* +shell.command-path-pattern= # classpath*:/commands/**, classpath*:/crash/commands/** +shell.config-path-patterns= # classpath*:/crash/* shell.disabled-plugins=false # don't expose plugins shell.ssh.enabled= # ssh settings ... shell.ssh.keyPath=