From 807e96b9e17ada9758c7930b0536ac68cc460546 Mon Sep 17 00:00:00 2001 From: Maya Berdygylyjova Date: Wed, 18 Dec 2024 14:00:21 +0100 Subject: [PATCH] [#60275] Add clarity on Ubuntu support in the docs https://community.openproject.org/work_packages/60275 [#60275] Add clarity on Ubuntu support in the docs https://community.openproject.org/work_packages/60275 --- .../installation/packaged/README.md | 48 ++++++++++++------- 1 file changed, 32 insertions(+), 16 deletions(-) diff --git a/docs/installation-and-operations/installation/packaged/README.md b/docs/installation-and-operations/installation/packaged/README.md index e7257b7d0531..4666d70404fb 100644 --- a/docs/installation-and-operations/installation/packaged/README.md +++ b/docs/installation-and-operations/installation/packaged/README.md @@ -6,6 +6,11 @@ sidebar_navigation: # Install OpenProject with DEB/RPM packages +> [!IMPORTANT] +> +> We will not build packages for new Linux versions, such as Ubuntu 24.04. We will, however, keep releasing new package versions for the currently supported Linux versions until their EOL (end of life). +> + The packaged installation of OpenProject is the recommended way to install and maintain OpenProject using DEB or RPM packages. The package will: @@ -43,7 +48,8 @@ $ uname -m x86_64 ``` -> **Important note:** Please note that the packaged installation works best when running on a dedicated server or virtual machine, as we cannot ensure that the components installed and configured by the OpenProject installer will work on systems that have been already customized. If you must install OpenProject on a server where other software is running, or with an already configured Apache or NginX server, then you should have a look at the Docker-based installation instead. +> [!IMPORTANT] +> Please note that the packaged installation works best when running on a dedicated server or virtual machine, as we cannot ensure that the components installed and configured by the OpenProject installer will work on systems that have been already customized. If you must install OpenProject on a server where other software is running, or with an already configured Apache or NginX server, then you should have a look at the Docker-based installation instead. ## Ubuntu Installation @@ -207,7 +213,8 @@ sudo yum install openproject Then finish the installation by reading the [*Initial configuration*](#initial-configuration) section. -> **Note:** On this distribution full-text extraction for attachments [*is not supported*](#full-text-extraction-not-supported) by default. +> [!NOTE] +> On this distribution full-text extraction for attachments [*is not supported*](#full-text-extraction-not-supported) by default. > ### CentOS 8 / RHEL 8 @@ -233,7 +240,8 @@ sudo yum install openproject Then finish the installation by reading the [*Initial configuration*](#initial-configuration) section. -> **Note:** On this distribution full-text extraction for attachments [*is not supported*](#full-text-extraction-not-supported) by default. +> [!NOTE] +> On this distribution full-text extraction for attachments [*is not supported*](#full-text-extraction-not-supported) by default. > **Workaround for outdated PostgreSQL library package** @@ -252,7 +260,8 @@ This happens when your local postgresql-libs package is outdated. You'll have to ## SUSE Linux Enterprise Server (SLES) Installation -**Note:** On SLES, full-text extraction for attachments [*is not supported*](#full-text-extraction-not-supported) by default. +> [!NOTE] +> On SLES, full-text extraction for attachments [*is not supported*](#full-text-extraction-not-supported) by default. ### SLES 15 @@ -301,12 +310,10 @@ sudo openproject reconfigure #interactive - manual choices are stored in /etc/op sudo openproject configure #non-interactive - using values stored in /etc/openproject/installer.dat ``` -> **Notes:** -> +> [!NOTE] > * Every time you will run the OpenProject wizard, by using `sudo openproject reconfigure` your choices will be persisted in a configuration file at `/etc/openproject/installer.dat` and subsequent executions of `sudo openproject configure` will re-use these values, only showing you the wizard steps for options you have not yet been asked for. > > * In the interactive way you can skip dialogs you do not want to change simply by confirming them with `ENTER`. -> ## Step 1: Select your OpenProject edition @@ -341,7 +348,8 @@ The dialog allows you to choose from three options: Choose this option if you want OpenProject to set up and configure a local database server manually. This is the best choice if you are unfamiliar with administering databases, or do not have a separate PostgreSQL database server installed that you want to connect to. -> **Note:** If you would like to use the database that was automatically installed by OpenProject at time of installation just choose `install` again +> [!NOTE] +> If you would like to use the database that was automatically installed by OpenProject at time of installation just choose `install` again ### Use an existing PostgreSQL database @@ -373,7 +381,8 @@ The available options are: We recommend that you let OpenProject install and configure the outer web server, in which case we will install an Apache2 web server with a VirtualHost listening to the domain name you specify, optionally providing SSL/TLS termination. -> **Note:** In case you re-run `sudo openproject reconfigure` later it is mandatory to select `install` at the webserver again +> [!NOTE] +> In case you re-run `sudo openproject reconfigure` later it is mandatory to select `install` at the webserver again In case you have selected to install Apache2, multiple dialogs will request the parameters for setting it up: @@ -391,7 +400,8 @@ If you wish to install OpenProject under a server path prefix, such as `yourdoma #### SSL/TLS configuration -> **Note:** With OpenProject version 12.2 **HTTPS configuration** was set to be **default** for every installation. **Now best practice is to proceed by selecting `yes` for using HTTPS (SSL/TLS)** and generating the needed certificates, otherwise you will have to manually deactivate HTTPS on the command line. +> [!NOTE] +> With OpenProject version 12.2 **HTTPS configuration** was set to be **default** for every installation. **Now best practice is to proceed by selecting `yes` for using HTTPS (SSL/TLS)** and generating the needed certificates, otherwise you will have to manually deactivate HTTPS on the command line. OpenProject can configure Apache to support HTTPS (SSL/TLS). If you have SSL certificates and want to use SSL/TLS (recommended), select **Yes**. @@ -407,7 +417,8 @@ Enabling this mode will result in OpenProject only responding to HTTPS requests, #### External SSL/TLS termination -> **Note**: If you terminate SSL externally before the request hits the OpenProject server, you need to follow the following instructions to avoid errors in routing. If you want to use SSL on the server running OpenProject, skip this section. +> [!NOTE] +> If you terminate SSL externally before the request hits the OpenProject server, you need to follow the following instructions to avoid errors in routing. If you want to use SSL on the server running OpenProject, skip this section. If you have a separate server that is terminating SSL and only forwarding/proxying to the OpenProject server, you must select "No" in this dialog. However, there are some parameters you need to put into your outer configuration. @@ -422,7 +433,8 @@ If you have a separate server that is terminating SSL and only forwarding/proxyi Here an example for external SSL/TLS termination with apache (httpd): -> **Note:** There is [another example](../docker/#1-virtual-host-root) for external SSL/TLS termination for **docker-compose** installations +> [!NOTE] +> There is [another example](../docker/#1-virtual-host-root) for external SSL/TLS termination for **docker-compose** installations ```shell @@ -456,7 +468,8 @@ Here an example for external SSL/TLS termination with apache (httpd): ### Skip Apache2 web server install (not recommended) -> **Note:** Skipping step 3 Apache2 web server install will ask later in step 7 for information about the hostname and HTTPS +> [!NOTE] +> Skipping step 3 Apache2 web server install will ask later in step 7 for information about the hostname and HTTPS The installer will not set up an external web server for accessing. You will need to either install and set up a web server such as Apache2 or Nginx to function as the web server forwarding to our internal server listening at `localhost:6000` by proxying. @@ -468,7 +481,8 @@ When installing with an existing Apache2, you can take a look at the source of o [For a minimal nginx config, please see this gist](https://gist.github.com/seLain/375d16ccd4542e3727e97a7478187d3a) as as starting point. -> **Please note:** If you reconfigure the OpenProject application and switch to `skip`, you might run into errors with the Apache configuration file, as that will not be automatically remove. Please double-check you removed references to the `openproject.conf` if you do reconfigure. +> [!IMPORTANT] +> If you reconfigure the OpenProject application and switch to `skip`, you might run into errors with the Apache configuration file, as that will not be automatically remove. Please double-check you removed references to the `openproject.conf` if you do reconfigure. ## Step 4: SVN/Git integration server @@ -492,7 +506,8 @@ OpenProject heavily relies on caching, which is why the wizard suggests you to i ## Step 7: Host name and Protocol (if step 3 was skipped) -> **Note:** This step is only shown if you decided to skip step 3, the Apache2 installation. OpenProject still needs to know what external host name you're running on, as well as if you're using HTTPS or not. +> [!NOTE] +> This step is only shown if you decided to skip step 3, the Apache2 installation. OpenProject still needs to know what external host name you're running on, as well as if you're using HTTPS or not. First, enter the fully qualified domain where your OpenProject installation will be reached at. This will be used to generate full links from OpenProject, such as in emails. @@ -504,7 +519,8 @@ Next, tell OpenProject whether you have SSL termination enabled somewhere in you ## Step 8: Default language -> **Note:** This step is only shown on the very first installation of OpenProject, as it affects only the initial seeding of the basic and demo data. Changing this value after installation will have no effect. +> [!NOTE] +> This step is only shown on the very first installation of OpenProject, as it affects only the initial seeding of the basic and demo data. Changing this value after installation will have no effect. OpenProject can be used with a wide variety of languages. The initial data of the instance (basic data such as status names, types, etc.) as well as data for demonstrational purposes will be created in the language you select in this screen. Move through the list using the arrow keys and select the default language.