diff --git a/ontrack-docs/src/docs/asciidoc/installation-package.adoc b/ontrack-docs/src/docs/asciidoc/installation-package.adoc new file mode 100644 index 00000000000..1cde1a66cbe --- /dev/null +++ b/ontrack-docs/src/docs/asciidoc/installation-package.adoc @@ -0,0 +1,129 @@ +[[installation-package]] +=== Package installation + +Ontrack provides installation packages for Debian & CentOS. Both +packages can be downloaded in the release page in GitHub: +https://github.com/nemerosa/ontrack/releases. + +To run Ontrack, you need to make sure that the minimal <> are available: + +* Postgres +* Elasticsearch + +[[installation-rpm]] +==== RPM installation + +To install Ontrack using RPM: + +[source,bash] +---- +rpm -i ontrack.rpm +---- + +The following directories are created: + +|=== +| Directory | Description + +| `/opt/ontrack` | Binaries and scripts +| `/usr/lib/ontrack` | Working and <> directory +| `/var/log/ontrack` | Logging directory +|=== + +You can optionally create an `application.yml` configuration file in +`/usr/lib/ontrack`. For example, to customise the port Ontrack is running on: + +[source,yaml] +---- +server: + port: 9080 +---- + +Ontrack is installed as a service using `/etc/init.d/ontrack`. + +[source,bash] +---- +# Starting Ontrack +sudo service ontrack start +# Status of Ontrack +sudo service ontrack status +# Stopping Ontrack +sudo service ontrack stop +---- + +To upgrade Ontrack: + +[source,bash] +---- +# Stopping Ontrack +sudo service ontrack stop +# Updating +sudo rpm --upgrade ontrack.rpm +# Starting Ontrack +sudo service ontrack start +---- + +The optional `/etc/default/ontrack` file can be used to define +environment variables like +`JAVA_OPTIONS` or `SPRING_DATASOURCE_URL`. + +For example: + +[source] +./etc/default/ontrack +---- +JAVA_OPTIONS=-Xmx2048m +SPRING_DATASOURCE_URL=jdbc:postgres://pg/ontrack +---- + +Other <> can be +passed the same way. + + +[[installation-debian]] +==== Debian installation + +To install Ontrack using Debian: + +[source,bash] +---- +dpkg -i ontrack.deb +---- + +The following directories are created: + +|=== +| Directory | Description + +| `/opt/ontrack` | Binaries and scripts +| `/usr/lib/ontrack` | Working and <> directory +| `/var/log/ontrack` | Logging directory +|=== + +Ontrack is installed as a service using `/etc/init.d/ontrack`. + +[source,bash] +---- +# Starting Ontrack +sudo service ontrack start +# Status of Ontrack +sudo service ontrack status +# Stopping Ontrack +sudo service ontrack stop +---- + +The optional `/etc/default/ontrack` file can be used to define +environment variables like +`JAVA_OPTIONS` or `SPRING_DATASOURCE_URL`. + +For example: + +[source] +./etc/default/ontrack +---- +JAVA_OPTIONS=-Xmx2048m +SPRING_DATASOURCE_URL=jdbc:postgres://pg/ontrack +---- + +Other <> can be +passed the same way. diff --git a/ontrack-docs/src/docs/asciidoc/installation.adoc b/ontrack-docs/src/docs/asciidoc/installation.adoc index bf4253f2c4b..e6ee58f87a8 100644 --- a/ontrack-docs/src/docs/asciidoc/installation.adoc +++ b/ontrack-docs/src/docs/asciidoc/installation.adoc @@ -9,45 +9,9 @@ include::installation-docker.adoc[] include::installation-package.adoc[] -include::installation-dependencies.adoc[] +include::installation-jar.adoc[] -//[[installation-prerequisites]] -//=== Prerequisites -// -//Ontrack has been tested on different Linux variants (Ubuntu, Debian, CentOS) -//and should also work on Windows. -// -//Ontrack relies on at least a JDK 11.0.6. More recent versions of the JDK 11 -//are OK. However, no test has been done yet using JDK 12 and more recent versions. -// -//Ontrack runs fine with 512 Mb of memory. However, think of upgrading to 2 Gb of -//memory if you intend to host a lot of projects. See the different installation -//modes (Docker, RPM, etc.) to know how to setup the memory settings. -// -//Ontrack stores its data in a Postgres database and can optionally -//use ElasticSearch for search indexes. -// -//[[installation-quick-start]] -//=== Quick start -// -//The fastest way to start Ontrack is to use Docker Compose: -// -//[source,bash] -//---- -//curl -fsSLO https://raw.githubusercontent.com/nemerosa/ontrack/master/compose/docker-compose.yml -//docker-compose up -d -//---- -// -//This sets up: -// -//* a Postgres database -//* an ElasticSearch (single node) -//* Ontrack running on port 8080 -// -//Go to http://localhost:8080 and start using Ontrack. The initial -//administrator credentials are `admin` / `admin`. -// -//See <> to start using Ontrack. +include::installation-dependencies.adoc[] // //[[installation-postgres]] //=== Postgres database @@ -78,108 +42,6 @@ include::installation-dependencies.adoc[] //to see other and better ways to pass //those <> parameters. // -//[[installation-docker]] -//=== Installing using Docker -// -//Ontrack is distributed as a Docker image on the https://hub.docker.com[Docker Hub], as `nemerosa/ontrack:{ontrack-version}`. -// -//[[installation-docker-overview]] -//==== Overview -// -//The Ontrack image exposes the port `8080`. -// -//Two volumes are defined: -// -//* `/var/ontrack/data` - contains some working files but also the log files. -//* `/var/ontrack/conf` - contains the <> for Ontrack (see later). -// -//Several modes of database setup can be done: -// -//* <> -//* <> -// -//[[installation-docker-basic]] -//==== Basic deployment -// -//You can start Ontrack as a container and a shared database and configuration on the host using: -// -//[source,bash] -//---- -//docker run --detach \ -// --publish=8080:8080 \ -// --volume=/var/ontrack/data:/var/ontrack/data \ -// --volume=/var/ontrack/conf:/var/ontrack/conf \ -// nemerosa/ontrack -//---- -// -//The <> for Ontrack can be put on the host in -//`/var/ontrack/conf` and the database and working files will be available -//in `/var/ontrack/data`. The application will be available on port `8080` of -//the host. -// -//Java options, like memory settings, can be passed to the Docker container using -//the `JAVA_OPTIONS` environment variable: -// -//[source,bash] -//---- -//docker run \ -// ... -// --env "JAVA_OPTIONS=-Xmx2048m" \ -// ... -//---- -// -//Additional arguments to the Ontrack process, like -//<> -//passed on the command line, can use the `ONTRACK_ARGS` environment variable. -// -//[source,bash] -//---- -//docker run \ -// ... -// --env "ONTRACK_ARGS=..." -// ... -//---- -// -//[[installation-docker-compose]] -//==== Docker Compose deployment -// -//Create the following file: -// -//[source,yaml] -//.docker-compose.yml -//---- -//version: "2.1" -// -//services: -// # Ontrack container -// ontrack: -// image: nemerosa/ontrack:3 -// environment: -// PROFILE: prod -// links: -// - "postgresql:postgresql" -// ports: -// - "8080:8080" -// -// # Postgresql database -// postgresql: -// image: postgres:9.5.2 -// environment: -// POSTGRES_DB : ontrack -// POSTGRES_USER : ontrack -// POSTGRES_PASSWORD: ontrack -// ports: -// - "5432" -//---- -// -//In the same directory, run: -// -//[source,bash] -//---- -//docker-compose up -d -//---- -// -//After some time, Ontrack becomes available at http://localhost:8080 // //[[installation-rpm]] //=== RPM installation @@ -196,113 +58,6 @@ include::installation-dependencies.adoc[] //rpm -i ontrack.rpm //---- // -//The following directories are created: -// -//|=== -//| Directory | Description -// -//| `/opt/ontrack` | Binaries and scripts -//| `/usr/lib/ontrack` | Working and <> directory -//| `/var/log/ontrack` | Logging directory -//|=== -// -//You can optionally create an `application.yml` configuration file in -//`/usr/lib/ontrack`. For example, to customise the port Ontrack is running on: -// -//[source,yaml] -//---- -//server: -// port: 9080 -//---- -// -//Ontrack is installed as a service using `/etc/init.d/ontrack`. -// -//[source,bash] -//---- -//# Starting Ontrack -//service ontrack start -//# Status of Ontrack -//service ontrack status -//# Stopping Ontrack -//service ontrack stop -//---- -// -//To upgrade Ontrack: -// -//[source,bash] -//---- -//# Stopping Ontrack -//sudo service ontrack stop -//# Updating -//sudo rpm --upgrade ontrack.rpm -//# Starting Ontrack -//sudo service ontrack start -//---- -// -//The optional `/etc/default/ontrack` file can be used to define -//environment variables like -//`JAVA_OPTIONS` or `ONTRACK_DB_URL` (to use the H2 server mode). -//For example: -// -//[source] -//./etc/default/ontrack -//---- -//JAVA_OPTIONS=-Xmx2048m -//ONTRACK_DB_URL=jdbc:h2:tcp://h2:9082/ontrack;MODE=MYSQL -//---- -// -//The `ONTRACK_ARGS` environment variable can be use to pass -//additional application parameters. -// -//[[installation-debian]] -//=== Debian installation -// -//You can install Ontrack using a Debian file (`.deb`) you can download from the -//https://github.com/nemerosa/ontrack/releases[releases] page. -// -//To install Ontrack: -// -//[source,bash] -//---- -//dpkg -i ontrack.deb -//---- -// -//The following directories are created: -// -//|=== -//| Directory | Description -// -//| `/opt/ontrack` | Binaries and scripts -//| `/usr/lib/ontrack` | Working and <> directory -//| `/var/log/ontrack` | Logging directory -//|=== -// -//Ontrack is installed as a service using `/etc/init.d/ontrack`. -// -//[source,bash] -//---- -//# Starting Ontrack -//service ontrack start -//# Status of Ontrack -//service ontrack status -//# Stopping Ontrack -//service ontrack stop -//---- -// -//The optional `/etc/default/ontrack` file can be used to define -//environment variables like -//`JAVA_OPTIONS` or `ONTRACK_DB_URL` (to use the H2 server mode). -//For example: -// -//[source] -//./etc/default/ontrack -//---- -//JAVA_OPTIONS=-Xmx2048m -//ONTRACK_DB_URL=jdbc:h2:tcp://h2:9082/ontrack;MODE=MYSQL -//---- -// -//The `ONTRACK_ARGS` environment variable can be use to pass -//additional application parameters. // //[[installation-sa]] //=== Standalone installation