From 0a85ff4b4bc3a34e5d0301d20813375bf6b16a64 Mon Sep 17 00:00:00 2001 From: Damien Coraboeuf Date: Sun, 22 Nov 2020 16:02:02 +0100 Subject: [PATCH] #822 Installation dependencies --- .../asciidoc/installation-dependencies.adoc | 40 +++++++++++++++++++ .../src/docs/asciidoc/installation.adoc | 33 +-------------- 2 files changed, 41 insertions(+), 32 deletions(-) diff --git a/ontrack-docs/src/docs/asciidoc/installation-dependencies.adoc b/ontrack-docs/src/docs/asciidoc/installation-dependencies.adoc index 531ef419a82..984877e884c 100644 --- a/ontrack-docs/src/docs/asciidoc/installation-dependencies.adoc +++ b/ontrack-docs/src/docs/asciidoc/installation-dependencies.adoc @@ -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 +<> 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 +<> 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]. diff --git a/ontrack-docs/src/docs/asciidoc/installation.adoc b/ontrack-docs/src/docs/asciidoc/installation.adoc index c31282b520f..963f6fd7db2 100644 --- a/ontrack-docs/src/docs/asciidoc/installation.adoc +++ b/ontrack-docs/src/docs/asciidoc/installation.adoc @@ -42,35 +42,4 @@ include::installation-dependencies.adoc[] //to see other and better ways to pass //those <> 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 <> for the list of all available properties. +// \ No newline at end of file