Select `release/12.2` as default branch and confirm with **Update**
Select `release/12.3` as default branch and confirm with **Update**
*NOTE:* There will be an additional window. Press the button: **I understand, update the default branch.**
@ -76,13 +76,13 @@ Select `release/12.2` as default branch and confirm with **Update**
## Step 8: Sync fork and Update branches (update local repository)
Every time you start editing please make sure you have fetched the latest changes from GitHub.com. First you need to update your forked repository. There you select the branch you are working on, e.g. `release/12.2`. If there are updates in the main repository opf/openproject click on **Sync fork** and **Update branch**.
Every time you start editing please make sure you have fetched the latest changes from GitHub.com. First you need to update your forked repository. There you select the branch you are working on, e.g. `release/12.3`. If there are updates in the main repository opf/openproject click on **Sync fork** and **Update branch**.
@ -104,11 +104,11 @@ In the next screen select **To contribute to the parent project**.
## Step 10: Create a new Git branch for your change
Select the latest release branch e.g. `release/12.2` as the current branch.
Select the latest release branch e.g. `release/12.3` as the current branch.
In the same drop down click on "New branch". In this window **insert a branch name that describes your changes** and **select the latest release branch** e.g. `release/12.2` the created branch is based on.
In the same drop down click on "New branch". In this window **insert a branch name that describes your changes** and **select the latest release branch** e.g. `release/12.3` the created branch is based on.
@ -148,7 +148,7 @@ A pull request is a workflow to ask for a review from the OpenProject team. With
Your Pull Request will be created in the browser **on github.com** Here select the latest release branch e.g. `release/12.2` in the **"base:"** dropdown on the left side. In the **"compare:"** dropdown select the branch you have changed.
Your Pull Request will be created in the browser **on github.com** Here select the latest release branch e.g. `release/12.3` in the **"base:"** dropdown on the left side. In the **"compare:"** dropdown select the branch you have changed.
@ -172,9 +172,9 @@ In the field "Reviewers" select "opf/doc-writers".
## Appendix A: How to import a new release branch into your fork
*(e.g. Release changes from `release/12.0` to `release 12.2`)*
*(e.g. Release changes from `release/12.2` to `release 12.3`)*
If a new release branch is generated on the upstream (opf) repository, the fork will NOT automatically fetch and merge and generate this release branch. With the following 'workaround' we get the new branch from the upstream (opf) repository and push it to our new origin (forked repository).
If a new release branch is generated on the upstream opf/openproject repository, the fork will NOT automatically fetch and merge and generate this release branch. With the following 'workaround' we get the new branch from the upstream (opf) repository and push it to our new origin (forked repository).
#### A) Change Remote Repository to UPSTREAM
@ -184,7 +184,7 @@ In GitHub Desktop choose menu "Repository -> Repository settings". This will ope
#### B) Fetch origin (in this case repository 'opf')
In GitHub Desktop **at Current branch the old branch is visible [1]** . After you press **Fetch origin [2]** you will be able to **select the new branch at Current branch** (e.g. `origin/release/12.2`
In GitHub Desktop **at Current branch the old branch is visible [1]** . After you press **Fetch origin [2]** you will be able to **select the new branch at Current branch** (e.g. `origin/release/12.3`
## Appendix B: How to change the Branch of an open Pull Request
If a new release branch is generated on the upstream opf/openproject repository, **and the steps in Appendix A were done** to get the new branch to the fork. We still might have open Pull Requests on the old, now outdated, release branch. The following steps show how to re-base your open Pull Requests to the new release branch. It is important, because otherwise your changes will not be synchronized with the online documentation on the webpage
#### A) Open the Pull Request in the forked repository
It is possible that conflicts will be shown after you change the release branch, depending on how much time passed between the new release branch being created and the Pull Request being rebased.
If you change the branches, you need to do a rebase to the updated target branch and remove any commits that should not be in there. It's hard to document this as what you need to remove depends on the target branches. You can read up on how this works in general by searching for "rebasing" or "interactive rebase" for the git client of your choice. Reach out to us by mentioning or assigning an OpenProject developer to your PR in github if you still need help in rebasing your branch. Over time you'll learn what is necessary.
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.
## SUSE Linux Enterprise Server (SLES) Installation
@ -366,16 +366,15 @@ After you have successfully installed the OpenProject package, you can now perfo
To start the configuration wizard, please run the following command with `sudo`, or as root:
```bash
sudo openproject configure
sudo openproject reconfigure #interactive - manual choices are stored in /etc/openproject/installer.dat
sudo openproject configure #non-interactive - using values stored in /etc/openproject/installer.dat
```
**Notes:**
* In case you mistype or need to correct a configuration option, you can always safely cancel the configuration wizard by pressing `CTRL+C` and restart it by running `sudo openproject reconfigure`.
* Every time you will run the OpenProject wizard, 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.
* 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 case you want to run through all the wizard options again, you can do so by executing `sudo openproject reconfigure`. This will show all wizard steps, but again keep values you entered before showing in the input fields. You can skip dialogs you do not want to change simply by confirming them with `ENTER`.
* 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
@ -411,6 +410,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
### Use an existing PostgreSQL database
Choose this option if you have a PostgreSQL database server installed either on the same host as the OpenProject package is being installed on, or on another server you can connect to from this machine.
OpenProject comes with an internal ruby application server, but this server only listens on a local interface. To receive connections from the outside world, it needs a web server that will act as a proxy to forward incoming connections to the OpenProject application server.
OpenProject comes with an internal ruby application server, but this server only listens on a local interface, usually on port 6000. To receive connections from the outside world, it needs a web server that will act as a proxy to forward incoming connections to the OpenProject application server.
This wizard step allows you to auto-install an Apache2 web server to function as that proxy.
This wizard step allows you to auto-install an Apache2 web server to function as that reverse proxy.
@ -441,21 +442,25 @@ 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.
In case you select to auto-install Apache2, multiple dialogs will request the parameters for setting it up:
> **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:
**Domain name**
#### Domain name
Enter the fully qualified domain where your OpenProject installation will be reached at. This will become the `ServerName` of your apache VirtualHost and is also used to generate full links from OpenProject, such as in emails.
Enter the fully qualified domain (FQDN) where your OpenProject installation will be reached at. This will become the `ServerName` of your apache VirtualHost and is also used to generate full links from OpenProject, such as in emails.
**Server path prefix**
#### Server path prefix
If you wish to install OpenProject under a server path prefix, such as `yourdomain.example.com/openproject`, please specify that prefix here with a leading slash. For example: `/openproject`. If OpenProject should respond to `http(s)://yourdomain.example.com` as specified in the previous dialog, simply leave this dialog empty and confirm by pressing `ENTER`.
**SSL/TLS configuration**
#### SSL/TLS configuration
> **Note:** With OpenProject version 12.2 **HTTPS confugration** 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**.
@ -469,11 +474,9 @@ In that case, you will be shown three additional dialogs to enter the certificat
Enabling this mode will result in OpenProject only responding to HTTPS requests, and upgrade any non-secured requests to HTTPS. It will also output HTTP Strict Transport Security (HSTS) headers to the client.
Enabling this mode will result in OpenProject only responding to HTTPS requests, and upgrade any non-secured requests to HTTPS. It will also output HTTP Strict Transport Security (HSTS) headers to the client.
**External SSL/TLS termination**
#### 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.
@ -488,9 +491,45 @@ If you have a separate server that is terminating SSL and only forwarding/proxyi
- Finally, to let OpenProject know that it should create links with 'https' when no request is available (for example, when sending emails), you need to set the following setting: `openproject config:set SERVER_PROTOCOL_FORCE_HTTPS="true"` followed by an `openproject configure`. This ensures that OpenProject responds correctly with secure cookies even though it was not configured for https in the server configuration.
Here an example for external SSL/TLS terminaltion with apache (httpd):
> **Note:** There is [another example](../docker/#1-virtual-host-root) for external SSL/TLS termination for **docker-compose** installations
### 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
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.
@ -502,7 +541,7 @@ 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.
> **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.
@ -527,9 +566,9 @@ OpenProject heavily relies on caching, which is why the wizard suggests you to i
## Step 7: Host name and Protocol (only when Apache installation was skipped)
## Step 7: Host name and Protocol (if step 3 was skipped)
This step is only shown if you decided to skip the Apache 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.
@ -537,7 +576,7 @@ First, enter the fully qualified domain where your OpenProject installation will
Next, tell OpenProject whether you have SSL termination enabled somewhere in your stack. Please note that you need to set up protocol forwarding by the means mentioned in the "Skip Apache installation" step above.
Next, tell OpenProject whether you have SSL termination enabled somewhere in your stack. Please note that you need to set up protocol forwarding by the means mentioned in the [Skip Apache2 Installation](#skip-apache2-web-server-install-not-recommended-1) at step 3 above.
ulferts
2 years ago
