4. Configuration Format

	Tip
	Check the code for a full list of the available configuration options.

The env element defines environment option that the service uses:

If some of your dependencies require a custom Bill of Materials (BOM) and/or a custom repository, you can add them here and use the id as a reference. For instance, let’s say that you want to integrate with library foo and it requires a foo-bom and a foo-repo. You can configure things as follows:

initializr:
  env:
    boms:
      foo-bom:
        groupId: com.example
        artifactId: foo-bom
        version: 1.2.3
    repositories:
      foo-repo:
        name: foo-release-repo
        url: https://repo.example.com/foo
        snapshotsEnabled: false

You can then use the foo-bom and foo-repo in a "dependency" or "dependency group" section.

	Note
	The spring-milestones and spring-snapshots repositories are available by default. Please note that these are just references and won’t impact the project unless you choose a dependency that explicitly refer to a bom and/or repo by id. Check the example below for more details.

The dependencies section allows you define a list of groups, each group having one more dependency. A group gather dependencies that share a common characteristics (i.e. all web-related dependencies for instance).

A dependency has the following basic characteristics:

	Tip
	Check the code for a full list of the available configuration options.

Here is the most basic dependency entry you could have

initializr:
  dependencies:
    - name: Core
      content:
        - id: security
          name: Security
          description: Secure your application via spring-security

	Tip
	The security dependency is held within a group called "Core".

This adds an option name Security with a tooltip showing the description above. If a project is generated with that dependency, the org.springframework.boot:spring-boot-starter-security dependency will be added to the project.

Let’s now add a custom dependency that is not managed by Spring Boot and that only work from Spring Boot 1.2.0.RELEASE and onwards but should not be used in the 1.3 lines and further for some reason.

initializr:
  dependencies:
    - name: Core
      content:
        - id: my-lib-id
          name: My lib
          description: Secure your application via spring-security
          groupId: com.example.foo
          artifactId: foo-core
          bom: foo-bom
          repository: foo-repo
          versionRange: "[1.2.0.RELEASE,1.3.0.M1)"

If one selects this entry, the com.example.foo:foo-core} dependency will be added and the Bill of Materials and repository for foo will be added automatically to the project as well (see the "Env section" above for a reference to those identifiers). Because the bom provides a dependency management for foo-core there is no need to hard code the version in the configuration.

The versionRange syntax follows some simple rules: a square bracket "[" or "]" denotes an inclusive end of the range and a round bracket "(" or ")" denotes an exclusive end of the range. A range can also be unbounded by defining a a single version. In the example above, the dependency will be available as from 1.2.0.RELEASE up to, not included, 1.3.0.M1 (which is the first milestone of the 1.3 line).

The other section defines the default and the list of available options in the web UI. This also drives how the meta-data for your instance are generated and tooling support is meant to react to that.

For instance, if you want your groupId to default to org.acme and the javaVersions to only be 1.7 and 1.8 you would write the following config:

initializr:
  groupId:
    value: org.acme
  javaVersions:
    - id: 1.8
      default: true
    - id: 1.7
      default: false