Skip to content

Commit

Permalink
#822 Installation dependencies
Browse files Browse the repository at this point in the history
  • Loading branch information
dcoraboeuf committed Nov 22, 2020
1 parent 309d84f commit 0a85ff4
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 32 deletions.
40 changes: 40 additions & 0 deletions ontrack-docs/src/docs/asciidoc/installation-dependencies.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,43 @@
[[installation-dependencies]]
=== Installation dependencies

Ontrack relies on the following components to be available:

* Postgres - for storage of information
* Elasticsearch - for search indexation

[[installation-postgres]]
==== Postgres

Versions 9.5.+ and version 10.+ of Ontrack have been tested.

By default, Ontrack will use the following
<<configuration-properties,configuration properties>> and their default
values to connect to Postgres:

|===
| Property | Description | Default value

| spring.datasource.url | JDBC URL to the Postgres Ontrack DB | `jdbc:postgresql://localhost/ontrack`
| spring.datasource.username | Username used to connect to the Postgres Ontrack DB | `ontrack`
| spring.datasource.password | Password used to connect to the Postgres Ontrack DB | `ontrack`
|===

Other properties are available in link:https://docs.spring.io/spring-boot/docs/{spring-boot-version}/reference/html/appendix-application-properties.html#data-properties[Spring Boot].

[[installation-elasticsearch]]
==== Elasticsearch

Version 7.5.+ has been tested.

By default, Ontrack will use the following
<<configuration-properties,configuration properties>> and their default
values to connect to Postgres:

|===
| Property | Description | Default value

| spring.elasticsearch.rest.uris | REST URI of Elasticsearch | `http://localhost:9200`
|===

Other properties are available in link:https://docs.spring.io/spring-boot/docs/{spring-boot-version}/reference/html/appendix-application-properties.html#data-properties[Spring Boot].
33 changes: 1 addition & 32 deletions ontrack-docs/src/docs/asciidoc/installation.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -42,35 +42,4 @@ include::installation-dependencies.adoc[]
//to see other and better ways to pass
//those <<configuration,configuration>> parameters.
//
//
//[[configuration]]
//=== Configuration
//
//As a regular http://projects.spring.io/spring-boot/[Spring Boot application],
//Ontrack can be configured using system properties and/or property files and/or
//YAML files. See the
//http://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#howto-properties-and-configuration[Spring Boot documentation]
//for more details.
//
//NOTE: The way to provide a YAML `application.yml` configuration file or
//command line arguments will vary
//according to the installation (Docker, RPM, etc.). See the corresponding
//section above for more details.
//
//For example, to setup the port Ontrack is running on, you can use the
//`server.port` property. Using a YAML file:
//
//[source,yaml]
//.application.yml
//----
//server.port=9999
//----
//
//or the command line option:
//
//[source,bash]
//----
//--server.port=9999
//----
//
//See <<configuration-properties>> for the list of all available properties.
//

0 comments on commit 0a85ff4

Please sign in to comment.