Merge branch 'documentation' of https://github.com/opf/openproject into documentation

help/installation-and-operations/docker/README.md

@@ -1,9 +0,0 @@
----
-sidebar_navigation:
-  title: Docker installation
-  priority: 300
----
-
-# Docker installation
-
-TODO

help/installation-and-operations/installation/README.md

@@ -0,0 +1,14 @@
+---
+sidebar_navigation:
+  title: Installation
+  priority: 400
+---
+
+# Installing OpenProject
+
+OpenProject can be setup in two different ways:
+
+| ----------- | :---------- |
+| [Installation with DEB/RPM packages](./packaged) | This is the recommended way to install OpenProject |
+| [Installation with docker](./docker) | This method of installation will undergo some changes soon and is currently not recommended |
+

help/installation-and-operations/installation/docker.md

@@ -1,6 +1,6 @@
 ---
 sidebar_navigation:
-  title: Installation guide
+  title: Docker
   priority: 300
 ---
 

help/installation-and-operations/installation/packaged.md

@@ -1,12 +1,184 @@
 ---
 sidebar_navigation:
-  title: Initial configuration
-  priority: 100
+  title: Packages
+  priority: 400
 ---
 
-# Initial configuration of your packaged installation
+# Install OpenProject with DEB/RPM packages
 
-After you have successfully installed the OpenProject package ([see the installation guide](../installation)), you can now perform the initial configuration of OpenProject, using the wizard that ships with the OpenProject package.
+The packaged installation of OpenProject is the recommended way to install and maintain OpenProject using DEB or RPM packages.
+
+The package will:
+
+- guide you through all the required steps
+
+- install all the required libraries and dependencies
+
+- install a local PostgreSQL database or allow you to connect to an existing PostgreSQL database
+
+- allow you to install and configure an outer Apache web server (recommended)
+
+- setup SSL/TLS encryption for the Apache server (optional)
+
+- configure repositories (Git/SVN) (optional)
+
+- configure email settings
+
+The package is available for the following Linux distributions:
+
+| Distribution (**64 bits only**) |
+| ------------------------------- |
+| CentOS/RHEL 7.x                 |
+| Debian 9 Stretch                |
+| Debian 10 Stretch               |
+| Suse Linux Enterprise Server 12 |
+| Ubuntu 16.04 Xenial Xerus       |
+| Ubuntu 18.04 Bionic Beaver      |
+
+Please ensure that you are running on a 64bit system before proceeding with the installation. You can check by running the `uname -i` command on the target server and verifying that it outputs `x86_64`:
+
+```bash
+$ uname -i
+x86_64
+```
+
+Also, 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.
+
+## Ubuntu 18.04
+
+Import the PGP key used to sign our packages:
+
+```bash
+wget -qO- https://dl.packager.io/srv/opf/openproject/key | sudo apt-key add -
+```
+
+Add the OpenProject package source:
+
+```bash
+sudo wget -O /etc/apt/sources.list.d/openproject.list \
+  https://dl.packager.io/srv/opf/openproject/stable/10/installer/ubuntu/18.04.repo
+```
+
+Download the OpenProject package:
+
+```bash
+sudo apt-get update
+sudo apt-get install openproject
+```
+
+Then finish the installation by reading the [*Initial configuration*][initial-config] section.
+
+## Ubuntu 16.04
+
+Import the PGP key used to sign our packages:
+
+```bash
+wget -qO- https://dl.packager.io/srv/opf/openproject/key | sudo apt-key add -
+```
+
+Add the OpenProject package source:
+
+```bash
+sudo wget -O /etc/apt/sources.list.d/openproject.list \
+  https://dl.packager.io/srv/opf/openproject/stable/10/installer/ubuntu/16.04.repo
+```
+
+Download the OpenProject package:
+
+```bash
+sudo apt-get update
+sudo apt-get install openproject
+```
+
+Then finish the installation by reading the [*Initial configuration*][initial-config] section.
+
+## Debian 10
+
+Import the PGP key used to sign our packages:
+
+```bash
+wget -qO- https://dl.packager.io/srv/opf/openproject/key | sudo apt-key add -
+```
+
+Add the OpenProject package source:
+
+```bash
+sudo wget -O /etc/apt/sources.list.d/openproject.list \
+  https://dl.packager.io/srv/opf/openproject/stable/10/installer/debian/10.repo
+```
+
+Download the OpenProject package:
+
+```bash
+sudo apt-get update
+sudo apt-get install openproject
+```
+
+Then finish the installation by reading the [*Initial configuration*][initial-config] section.
+
+## Debian 9
+
+Import the PGP key used to sign our packages:
+
+```bash
+wget -qO- https://dl.packager.io/srv/opf/openproject/key | sudo apt-key add -
+```
+
+Add the OpenProject package source:
+
+```bash
+sudo wget -O /etc/apt/sources.list.d/openproject.list \
+  https://dl.packager.io/srv/opf/openproject/stable/10/installer/debian/9.repo
+```
+
+Download the OpenProject package:
+
+```bash
+sudo apt-get update
+sudo apt-get install openproject
+```
+
+Then finish the installation by reading the [*Initial configuration*][initial-config] section.
+
+## CentOS 7 / RHEL 7
+
+Add the OpenProject package source:
+
+```bash
+sudo wget -O /etc/yum.repos.d/openproject.repo \
+  https://dl.packager.io/srv/opf/openproject/stable/10/installer/el/7.repo
+```
+
+Download the OpenProject package:
+
+```bash
+sudo yum install openproject
+```
+
+Then finish the installation by reading the [*Initial configuration*][initial-config] section.
+
+## SLES 12
+
+Add the OpenProject package source:
+
+```bash
+wget -O /etc/zypp/repos.d/openproject.repo \
+  https://dl.packager.io/srv/opf/openproject/stable/10/installer/sles/12.repo
+```
+
+Download the OpenProject package:
+
+```bash
+sudo zypper install openproject
+```
+
+Then finish the installation by reading the [*Initial configuration*][initial-config] section.
+
+[initial-config]: #initial-configuration
+
+# Initial Configuration
+
+After you have successfully installed the OpenProject package, you can now perform the initial configuration of OpenProject, using the wizard that ships with the OpenProject package.
 
 ## Prerequisites
 

help/installation-and-operations/operation/backing-up.md

@@ -24,25 +24,28 @@ of the current OpenProject installation. This tool will create a backup of
 all parts mentioned above. The backup tool is used by executing the following
 command:
 
-```
+```bash
 sudo openproject run backup
 ```
 
 The command will create backup files in the following location on your system:
 
-```
+```bash
 /var/db/openproject/backup
 ```
 
-The content of that directory should look very similar to the following (depending on your database engine, you will see either a `mysql-dump-<date>.sql.gz` or a `postgresql-dump-<pgdump>` file).
-
-```
-root@test-packager-backup:/opt/openproject# ls -l /var/db/openproject/backup/
-total 24
--rw-r----- 1 openproject openproject  117 Apr  8 09:55 attachments-20150408095521.tar.gz
--rw-r----- 1 openproject openproject  667 Apr  8 09:55 conf-20150408095521.tar.gz
--rw-r----- 1 openproject openproject 8298 Apr  8 09:55 postgres-dump-20150408095521.sql.gz
--rw-r----- 1 openproject openproject  116 Apr  8 09:55 svn-repositories-20150408095521.tar.gz
+The content of that directory should look very similar to the following (depending on your database engine, you will see either a `mysql-dump-<date>.sql.gz` or a `postgresql-dump-<date>.pgdump` file).
+
+```bash
+root@ip-10-0-0-228:/home/admin# ls -al /var/db/openproject/backup/
+total 1680
+drwxr-xr-x 2 openproject openproject    4096 Nov 19 21:00 .
+drwxr-xr-x 6 openproject openproject    4096 Nov 19 21:00 ..
+-rw-r----- 1 openproject openproject 1361994 Nov 19 21:00 attachments-20191119210038.tar.gz
+-rw-r----- 1 openproject openproject    1060 Nov 19 21:00 conf-20191119210038.tar.gz
+-rw-r----- 1 openproject openproject     126 Nov 19 21:00 git-repositories-20191119210038.tar.gz
+-rw-r----- 1 openproject openproject  332170 Nov 19 21:00 postgresql-dump-20191119210038.pgdump
+-rw-r----- 1 openproject openproject     112 Nov 19 21:00 svn-repositories-20191119210038.tar.gz
 ```
 
 You should then copy those dump files to a secure location, for instance an S3 bucket or some sort of backup server.

help/installation-and-operations/operation/restoring.md

@@ -12,39 +12,51 @@ Assuming you have a backup of all the OpenProject files at hand (see the [Backin
 
 As a reference, we will assume you have the following dumps on your server, located in `/var/db/openproject/backup`:
 
-```
--rw-r----- 1 openproject openproject  117 Apr  8 09:55 attachments-20150408095521.tar.gz
--rw-r----- 1 openproject openproject  667 Apr  8 09:55 conf-20150408095521.tar.gz
--rw-r----- 1 openproject openproject 8298 Apr  8 09:55 postgres-dump-20150408095521.sql.gz
--rw-r----- 1 openproject openproject  116 Apr  8 09:55 svn-repositories-20150408095521.tar.gz
+```bash
+root@ip-10-0-0-228:/home/admin# ls -al /var/db/openproject/backup/
+total 1680
+drwxr-xr-x 2 openproject openproject    4096 Nov 19 21:00 .
+drwxr-xr-x 6 openproject openproject    4096 Nov 19 21:00 ..
+-rw-r----- 1 openproject openproject 1361994 Nov 19 21:00 attachments-20191119210038.tar.gz
+-rw-r----- 1 openproject openproject    1060 Nov 19 21:00 conf-20191119210038.tar.gz
+-rw-r----- 1 openproject openproject     126 Nov 19 21:00 git-repositories-20191119210038.tar.gz
+-rw-r----- 1 openproject openproject  332170 Nov 19 21:00 postgresql-dump-20191119210038.pgdump
+-rw-r----- 1 openproject openproject     112 Nov 19 21:00 svn-repositories-20191119210038.tar.gz
 ```
 
 ### Stop the processes
 
 First, it is a good idea to stop the OpenProject instance:
 
-```
+```bash
 sudo service openproject stop
 ```
 
 ### Restoring assets
 
-Untar the attachments to their destination:
+Go into the backup directory:
 
-```
-tar xzf /var/db/openproject/backup/attachments-20150408095521.tar.gz -C /var/db/openproject/files/
+```bash
+cd /var/db/openproject/backup
 ```
 
-Untar the configuration to its destination:
+Untar the attachments to their destination:
 
+```bash
+tar xzf attachments-20191119210038.tar.gz -C /var/db/openproject/files
 ```
-tar xzf /var/db/openproject/backup/conf-20150408095521.tar.gz -C /etc/openproject/
+
+Untar the configuration files to their destination:
+
+```bash
+tar xzf conf-20191119210038.tar.gz -C /etc/openproject/conf.d/
 ```
 
 Untar the repositories to their destination:
 
-```
-tar xzf /var/db/openproject/backup/svn-repositories-20150408095521.tar.gz -C /var/db/openproject/repositories
+```bash
+tar xzf git-repositories-20191119210038.tar.gz -C /var/db/openproject/git
+tar xzf svn-repositories-20191119210038.tar.gz -C /var/db/openproject/svn
 ```
 
 ### Restoring the database
@@ -55,15 +67,24 @@ installation. This setting can be seen by running:
 
 First, get the necessary details about your database:
 
-```
+```bash
 openproject config:get DATABASE_URL
-#=> e.g.: postgres://dbusername:dppassword@dbhost:dbport/dbname
+#=> e.g.: postgres://<dbusername>:<dbpassword>@<dbhost>:<dbport>/<dbname>
 ```
 
-Then, to restore the PostgreSQL dump please use the `psql` command utilities:
+Then, to restore the PostgreSQL dump please use the `pg_restore` command utility:
 
 ```
-zcat /var/db/openproject/backup/postgres-dump-20150408095521.sql.gz | psql -h <dbhost> -u <dbusername> -W <dbname>
+pg_restore -h <dbhost> -p <dbport> -U <dbusername> -d <dbname> postgresql-dump-20191119210038.pgdump
+```
+
+Example:
+
+```bash
+$ openproject config:get DATABASE_URL
+postgres://openproject:L0BuQvlagjmxdOl6785kqwsKnfCEx1dv@127.0.0.1:45432/openproject
+
+$ pg_restore -h 127.0.0.1 -p 45432 -U openproject -d openproject postgresql-dump-20191119210038.pgdump
 ```
 
 ### Restart the OpenProject processes

help/installation-and-operations/packaged/README.md

@@ -1,14 +0,0 @@
----
-sidebar_navigation:
-  title: Packages
-  priority: 400
----
-
-# Packaged installation (DEB/RPM)
-
-The packaged installation is the recommended way to install OpenProject. Follow the instructions detailed in the following guides to get OpenProject running on your own server:
-
-| Main Topics | Description |
-| ----------- | :---------- |
-| [Installation](./installation) | How to install OpenProject from DEB/RPM packages |
-| [Initial configuration](./configuration) | How to perform the initial configuration of OpenProject |

help/installation-and-operations/packaged/installation.md

@@ -1,183 +0,0 @@
----
-sidebar_navigation:
-  title: Installation
-  priority: 200
----
-
-# Installation of OpenProject with DEB/RPM packages
-
-The packaged installation of OpenProject is the recommended way to install and maintain OpenProject using DEB or RPM packages.
-
-The package will:
-
-- guide you through all the required steps
-
-- install all the required libraries and dependencies
-
-- install a local PostgreSQL database or allow you to connect to an existing PostgreSQL database
-
-- allow you to install and configure an outer Apache web server (recommended)
-
-- setup SSL/TLS encryption for the Apache server (optional)
-
-- configure repositories (Git/SVN) (optional)
-
-- configure email settings
-
-The package is available for the following Linux distributions:
-
-| Distribution (**64 bits only**)     | Identifier   | init system |
-| ------------------------------- | ------------ | ----------- |
-| CentOS/RHEL 7.x                 | centos-7     | systemd     |
-| Debian 9 Stretch                | debian-9     | systemd     |
-| Debian 10 Stretch               | debian-10    | systemd     |
-| Suse Linux Enterprise Server 12 | sles-12      | sysvinit    |
-| Ubuntu 16.04 Xenial Xerus       | ubuntu-16.04 | upstart     |
-| Ubuntu 18.04 Bionic Beaver      | ubuntu-18.04 | systemd     |
-
-Please ensure that you are running on a 64bit system before proceeding with the installation. You can check by running the `uname -i` command on the target server and verifying that it outputs `x86_64`:
-
-```
-$ uname -i
-x86_64
-```
-
-Also, 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.
-
-## Installation
-
-The first step of the installation is to add the OpenProject package source to the package manager of your distribution (`apt`, `yum`, or `zypper`).
-
-### Ubuntu 18.04
-
-Import the PGP key used to sign our packages:
-
-```
-wget -qO- https://dl.packager.io/srv/opf/openproject/key | sudo apt-key add -
-```
-
-Add the OpenProject package source:
-
-```
-sudo wget -O /etc/apt/sources.list.d/openproject.list \
-  https://dl.packager.io/srv/opf/openproject/stable/10/installer/ubuntu/18.04.repo
-```
-
-Download the OpenProject package:
-
-```
-sudo apt-get update
-sudo apt-get install openproject
-```
-
-Then finish the installation by reading the [*Initial configuration*][initial-config] section.
-
-### Ubuntu 16.04
-
-Import the PGP key used to sign our packages:
-
-```
-wget -qO- https://dl.packager.io/srv/opf/openproject/key | sudo apt-key add -
-```
-
-Add the OpenProject package source:
-
-```
-sudo wget -O /etc/apt/sources.list.d/openproject.list \
-  https://dl.packager.io/srv/opf/openproject/stable/10/installer/ubuntu/16.04.repo
-```
-
-Download the OpenProject package:
-
-```
-sudo apt-get update
-sudo apt-get install openproject
-```
-
-Then finish the installation by reading the [*Initial configuration*][initial-config] section.
-
-### Debian 10
-
-Import the PGP key used to sign our packages:
-
-```
-wget -qO- https://dl.packager.io/srv/opf/openproject/key | sudo apt-key add -
-```
-
-Add the OpenProject package source:
-
-```
-sudo wget -O /etc/apt/sources.list.d/openproject.list \
-  https://dl.packager.io/srv/opf/openproject/stable/10/installer/debian/10.repo
-```
-
-Download the OpenProject package:
-
-```
-sudo apt-get update
-sudo apt-get install openproject
-```
-
-Then finish the installation by reading the [*Initial configuration*][initial-config] section.
-
-### Debian 9
-
-Import the PGP key used to sign our packages:
-
-```
-wget -qO- https://dl.packager.io/srv/opf/openproject/key | sudo apt-key add -
-```
-
-Add the OpenProject package source:
-
-```
-sudo wget -O /etc/apt/sources.list.d/openproject.list \
-  https://dl.packager.io/srv/opf/openproject/stable/10/installer/debian/9.repo
-```
-
-Download the OpenProject package:
-
-```
-sudo apt-get update
-sudo apt-get install openproject
-```
-
-Then finish the installation by reading the [*Initial configuration*][initial-config] section.
-
-### CentOS 7 / RHEL 7
-
-Add the OpenProject package source:
-
-```
-sudo wget -O /etc/yum.repos.d/openproject.repo \
-  https://dl.packager.io/srv/opf/openproject/stable/10/installer/el/7.repo
-```
-
-Download the OpenProject package:
-
-```
-sudo yum install openproject
-```
-
-Then finish the installation by reading the [*Initial configuration*][initial-config] section.
-
-### SLES 12
-
-Add the OpenProject package source:
-
-```
-wget -O /etc/zypp/repos.d/openproject.repo \
-  https://dl.packager.io/srv/opf/openproject/stable/10/installer/sles/12.repo
-```
-
-Download the OpenProject package:
-
-```
-sudo zypper install openproject
-```
-
-Then finish the installation by reading the [*Initial configuration*][initial-config] section.
-
-[initial-config]: ../configuration
-
-

help/installation-and-operations/packaged/upgrade-guide-legacy.md

@@ -1,170 +0,0 @@
-# Upgrade your pre-5.0 OpenProject installation (DEB/RPM Packages)
-
-Starting with OpenProject 4.1 stable releases will have their own branch on github. According to this the OpenProject release 6.0 is tracked via the stable/6 branch. We provide a stable branch `stable/<VERSION>` to contain all minor upgrades to OpenProject <VERSION>.x.
-
-For OpenProject 4.2, two packages existed: The OpenProject Core and Community Edition.
-Starting with OpenProject 5.0, both editions have been integrated into the single OpenProject package, which now contains a standard set of the most-used plugins previously contained in the Community Edition.
-
-This guide contains two guides:
-
-* The upgrade guide for OpenProject Core 4.2. to OpenProject 6.0
-* The migration guide to OpenProject 6.0 from OpenProject Community Edition 4.2.
-
-Please jump directly to the part of this guide depending on your OpenProject version (Core Edition or Community Edition) and operating system.
-
-## Upgrading from OpenProject Core Edition 4.2
-
-### Preliminary step: Remove the sources.list that defines the OpenProject Core Edition 4.2
-
-To avoid trying to update the deprecated 4.2 package, remove the following entry:
-
-    sudo rm -i /etc/apt/sources.list.d/openproject.list
-
-
-### Debian 7.6 Wheezy 64bits server
-
-    echo "deb https://deb.packager.io/gh/opf/openproject wheezy stable/6" | sudo tee /etc/apt/sources.list.d/openproject.list
-    sudo apt-get update
-    sudo apt-get install openproject
-    sudo openproject configure
-
-### Ubuntu 14.04 Trusty 64bits server
-
-    echo "deb https://deb.packager.io/gh/opf/openproject trusty stable/6" | sudo tee /etc/apt/sources.list.d/openproject.list
-    sudo apt-get update
-    sudo apt-get install openproject
-    sudo openproject configure
-
-### Fedora 20 64bits server
-
-    echo "[openproject]
-    name=Repository for opf/openproject application.
-    baseurl=https://rpm.packager.io/gh/opf/openproject/fedora20/stable/6
-    enabled=1" | sudo tee /etc/yum.repos.d/openproject.repo
-    sudo yum install openproject
-    sudo openproject configure
-
-### CentOS / RHEL 6 64 bits server
-
-    echo "[openproject]
-    name=Repository for opf/openproject application.
-    baseurl=https://rpm.packager.io/gh/opf/openproject/centos6/stable/6
-    enabled=1" | sudo tee /etc/yum.repos.d/openproject.repo
-    sudo yum install openproject
-    sudo openproject configure
-
-### SUSE Linux Enterprise Server 12
-
-    sudo zypper addrepo "https://rpm.packager.io/gh/opf/openproject/sles12/stable/6" "openproject"
-    sudo zypper install openproject
-    sudo openproject configure
-
-## Migrating from OpenProject Community Edition 4.2
-
-The `openproject-ce` package no longer exists, but you can migrate to the new OpenProject package, which contains all functionality that was previously contained in the Community Edition.
-
-The following steps were tested on Ubuntu and Debian machines with OpenProject Community Edition 4.2 installed. There may be variations for other distributions, please let us know If you can provide additional information to the migration path.
-
-### Step 1: Backup existing installation
-
-Before performing the migration, please backup your existing installation. While we will continue to use it and database migrations should run smoothly, please keep a backup at hand.
-
-To backup attachments, database and repository, use the following command:
-
-    sudo openproject-ce run backup
-
-### Step 2: Shut down openproject-ce instance
-
-To avoid any further changes to the application, stop the web and worker processes:
-
-    sudo openproject-ce scale web=0 worker=0
-
-### Step 3: Confirm database connection details
-
-If you used autoinstall, the database name and database user name should equal `openproject_ce`. You can confirm this by running:
-
-    sudo openproject-ce config:get DATABASE_URL
-   
-Which should output something of the form
-
-    mysql2://<username>:<password>@127.0.0.1:3306/<dbname>
-
-If the URI contains `openproject_ce` as the username and database name as the example above, we can simply continue.
-Otherwise, note user-, database name and password just to be sure.
-
-### Step 4: Remove the openproject-ce package
-
-Remove the `openproject-ce` package from your system. For Debian/Ubuntu, run:
-
-    sudo apt-get remove openproject-ce
-
-### Step 5: Remove the sources.list that defines the Community Edition package
-
-To avoid installing the deprecated 4.2 package, remove the following entry:
-
-    sudo rm -i /etc/apt/sources.list.d/pkgr-openproject-community.list
-
-
-### Step 6: Move the existing application and configuration files
-
-As the OpenProject 6.0 package is identitical to the core in regards to paths, you'll need to reference the configuration and application (e.g., attachments, SVN repositories) files to the path that is expected from the new package.
-
-    # Move openproject-ce configuration
-    sudo mv /etc/openproject-ce /etc/openproject
-
-For repositories, there are references in the database to the old `/var/db/openproject-ce/svn/<repository>` locations, so we suggest to symlink them instead:
-
-    # Symlink existing attachments and
-    sudo ln -s /var/db/openproject-ce /var/db/openproject
-
-### Step 7: Disable the Community Edition Apache2 configuration
-
-As a final step, disable the `openproject-ce` configuration.
-
-    sudo a2dissite openproject-ce
-    
-Optionally, remove the disabled site. The following path applies to Debian/Ubuntu.
-
-    sudo rm -i /etc/apache2/sites-available/openproject-ce.conf
-
-Note:
-
-* For RedHat, the path should be changed to `/etc/httpd/conf.d/openproject-ce.conf`.
-* For SLES, the path should be changed to `/etc/apache2/vhosts.d/openproject-ce.conf`.
-
-### Step 8: Install the OpenProject 6.0 package and select database
-
-The rest of the installation is mostly identical to the installation guide of the OpenProject 5.0 package:
-https://www.openproject.org/open-source/packaged-installation/packaged-installation-guide/
-
-Add the package source to your package manager, update the sources, and install the `openproject` package. (See the installation guide linked above for the detailed steps for the various distributions).
-
-**Important:** Instead of running `openproject configure`, run `openproject reconfigure`, which will lead you through the complete wizard.
-
-In the first step *mysql/autoinstall*, select the **reuse**  option (Use an existing database).
-
-![](https://dl.dropboxusercontent.com/u/270758/op/mysql-reuse.png)
-
-Press OK for the following steps, which will simply take the existing values from your old configuration
-
- * MySQL IP or hostname
- * MySQL port
- 
-In the dialog `mysql/username`, enter `openproject_ce` if the Database URI from Step 4 contained it. If you chose a different user name in the original CE installation, it should already be set to this value.
-
-![](https://dl.dropboxusercontent.com/u/270758/op/mysql-username.png)
-
-In the dialog `mysql/password`, **leave the password empty**. It will use the value from your original installation. You can optionally enter the password you retrieved from the database URI from Step 4, but that should be identical.
-
-![](https://dl.dropboxusercontent.com/u/270758/op/mysql-password.png)
-
-And again, in the `mysql/db_name` step,  enter `openproject_ce` if the Database URI from Step 4 contained it. If you chose a different database name in the original CE installation, it should already be set to this value.
-
-The other installation steps (mysql/db_source_host, mysql/ssl) may again be skipped by pressing OK, as they should still contain the old values from the Community Edition.
-
-There will be other new steps in the installation wizard for which we will provide additional information in the packager installation guide.
-
-Once the wizard has completed, the OpenProject instance should be updated to 6.0.x while re-using your existing database.
-
-**Note:** This last step is a workaround for the package upgrading process. We are working on making this step optional.
-The workaround is necessary since since the package appname changed from `openproject-ce` to `openproject`, and the installer wizard automatically sets the database to the app name when selecting an automatic installation of MySQL. Instead, the updater should respect an existing database (user-) name in its configuration.

help/installation-and-operations/upgrading-postgresql.md

@@ -1,68 +0,0 @@
-## OpenProject PostgreSQL migration guide to 9.6
-
-This guide will lead you to the steps of upgrading your system PostgreSQL version to 9.6.
-OpenProject 7.4.0 requires PostgreSQL 9.5+, so we're recommending to install to 9.6 directly.
-
-If you're upgrading to 7.4.0 without a 9.5+ database, your upgrade process will be terminated with a 'Database incompatibility warning'. You should not 
-
-Since Ubuntu 14.04 (still supported by OpenProject) is still running on PostgreSQL 9.3., we're showing the 
-upgrade process for this distribution. Debian oldstable also uses PostgreSQL 9.4. as well.
-
-### Preparations for the upgrade
-
-Stop the current OpenProject workers
-
-```bash
-service openproject stop
-```
-
-### Install the newer PostgreSQL version
-
-For Ubuntu 14.04:
-
-```bash
-sudo add-apt-repository "deb http://apt.postgresql.org/pub/repos/apt/ trusty-pgdg main"
-wget --quiet -O - https://www.postgresql.org/media/keys/ACCC4CF8.asc | sudo apt-key add -
-sudo apt-get update
-sudo apt-get install postgresql-9.6
-```
-
-
-For other versions of Ubuntu, see this answer on AskUbuntu:
-https://askubuntu.com/questions/831292
-
-Or check the download for repositories from PostgreSQL:
-https://www.postgresql.org/download/
-
-
-### Upgrade of PostgreSQL
-
-
- Stop the old cluster:
- 
- ```bash
- pg_dropcluster 9.6 main --stop
- ```
- 
- Upgrade the cluster to 9.6
- 
- ```bash 
- pg_upgradecluster -v 9.6 9.3 main
- ```
- 
- Remove the old cluster
- 
- ```bash
- pg_dropcluster 9.3 main
- ```
- 
- Lastly, remove the ubuntu-provided version of 9.3:
- 
- ```bash 
- apt-get remove postgres postgresql-9.3
- ```
- 
- ### Upgrade OpenProject
- 
-You can now continue with the regular upgrading guide as detailed on these pages:
-[https://www.openproject.org/operations/upgrading/](https://www.openproject.org/operations/upgrading/)

help/user-guide/calendar.md

@@ -23,7 +23,7 @@ The calendar shows all of the project’s work packages in calendar form.
 
 To display the calendar in a project, the module **Calendar** needs to be activated in the [project settings](./project-admin-guide/#activate-modules).
 
-When you open the calendar, all work packages within the current project are displayed on the calender, displaying the title of the work package. The colors represent the different [work package types](./system-admin-guide/#work-package-types).
+When you open the calendar, all work packages within the current project are displayed on the calendar, displaying the title of the work package. The colors represent the different [work package types](./system-admin-guide/#work-package-types).
 
 The current month is automatically selected. You can change the  date range between month or week and navigate through the views with the arrows on the left. The **today** button brings you back to the current date.
 
@@ -53,7 +53,7 @@ You can display the calendar in a full screen view to eliminate header and proje
 
 Click the **Activate zen mode** button on the top of the calendar.
 
-Click Excape (Esc) to leave the Zen mode.
+Click Escape (Esc) to leave the Zen mode.
 
 ![zen-calendar](zen-calendar.png)
 
@@ -81,6 +81,6 @@ The calendar automatically displays the start and end dates of work  packages in
 
 To use the calendar in a project, you need to [activate the “Calendar” module in the project settings](./project-admin-guide/#activate-modules). Afterwards you can access the calendar in the project menu, as well as add it in the [project overview](#project-overview). You can also enable the calendar in your [“My page” view](#my-page).
 
-### Is there an option to export or synch the calendar?
+### Is there an option to export or sync the calendar?
 
-It is currently not possible to export or synch the calendar. You can however [export meetings as iCalendar file](#meetings) and import them to your external calendar.
+It is currently not possible to export or sync the calendar. You can however [export meetings as iCalendar file](#meetings) and import them to your external calendar.

help/user-guide/gantt-chart.md

@@ -81,7 +81,7 @@ To export the data from your Gantt chart there are several possibilities:
 
 * [Export via the work package view](./edit-work-package/#export-work-packages)
 * [Print (e.g. to PDF)](#how-to-print-a-gantt-chart)
-* [Synchronize data from OpenProject to Excel](#synchronize-data-from-OpenProject-to-Excel) <-> MSProject
+* [Synchronize data from OpenProject to Excel](#synchronize-data-from-OpenProject-to-Excel) <-> MS Project
 
 ### How to print a Gantt chart?
 
@@ -107,7 +107,7 @@ For other browsers, please simply follow the browser's printing instruction to o
 
 ## Synchronize data from OpenProject to Excel
 
-You can synchronize your work packages data from OpenProject to Excel (and even convert from or to MSProject). You need to download an OpenProject plugin.
+You can synchronize your work packages data from OpenProject to Excel (and even convert from or to MS Project). You need to download an OpenProject plugin.
 
 Follow our [Step by step guide how to synchronize your Excel Sheet with OpenProject](https://www.openproject.org/synchronize-excel-openproject/).
 

help/user-guide/meetings.md

@@ -76,7 +76,7 @@ After creating a meeting, you can set up a **meeting agenda**.
 3. All changes made to the agenda are tracked. You can click the **History** button to get an overview of all the changes including the persons who made the changes.
 4. Click the **Send for review** button to quickly notify participants about the meeting and send them a link to the meeting.
 5. Press the **Send iCalendar** button to send a calendar entry to the participants. The users can then quickly add the meeting to their calendar by accepting the invitation / importing the iCal file attached to the email notification.
-6. At the beginning of the meeting, **Close** the agenda to prevent any additional changes and provide the same basis for all meeting participants. After closing the agenda, the meeting minutes are displayed to capture the results of the meeting.
+6. At the beginning of the meeting, **Close** the agenda to prevent any other changes and provide the same basis for all meeting participants. After closing the agenda, the meeting minutes are displayed to capture the results of the meeting.
 7. ![meeting-agenda](meeting-agenda.png)
 
 ## Create or edit meeting minutes
@@ -99,7 +99,7 @@ You will be directed to the meeting view, where you can
 
 ## Copy a meeting (recurring meetings)
 
-If you have recurring meetings, for example a Jour Fixe, and want to simplify the process of creating meetings and agendas, you can **copy an existing meeting**. To do that select the respective meeting and open the detailed meeting view.
+If you have recurring meetings, such as a Jour Fixe, and want to simplify the process of creating meetings and agendas, you can **copy an existing meeting**. To do that select the meeting and open the detailed meeting view.
 
 Select **Copy** in the top right side.
 
@@ -108,7 +108,8 @@ Select **Copy** in the top right side.
 You can now edit the copied meeting and add the new details. Click the **Save** button to secure your changes.
 
 <div class="alert alert-info" role="alert">
-**Note**: all of the settings will be copied, except for the minutes, participants and meeting history. So if you want to keep the minutes as well, you have to copy it separately.
+**Note**: all the settings will be copied, except for the minutes, participants and meeting history. So if you want to keep the minutes as well, you have to copy it separately.
+
 
 </div>
 

help/user-guide/news.md

@@ -72,7 +72,7 @@ Clicking on the title of a news will bring you to the news details in the corres
 
 ## Latest news section on the project overview page
 
-You can also inlude your latest news from a project on the Project overview page.
+You can also include your latest news from a project on the Project overview page.
 
 Find out how to [configure your Project overview](#project-overview) page.
 

help/user-guide/project-overview.md

@@ -103,7 +103,7 @@ New custom fields for projects can be created in the [system administration](/sy
 
 ### Project status widget
 
-Add your project status as a widget to display at one sight whether your project is on track, off track or at risk.
+Add your project status as a widget to display at a glance whether your project is on track, off track or at risk.
 
 First, select your project status from the drop-down. You can choose between:
 

help/user-guide/roadmap.md

@@ -11,7 +11,7 @@ keywords: roadmap, release planning
 
 Plan and manage your product roadmap in OpenProject. Visualize, and communicate your product roadmap. Share your product roadmap with your stakeholders, get feedback about your ideas and break it down into a detailed release plan.
 
-In the roadmap, you can see at one sight all work packages and their status listed by versions.
+In the roadmap, you can see all work packages and their status listed by versions at a glance.
 
 For each version, the related work package can be assessed from the list displayed in the roadmap view. Subjects which are crossed out represent closed work packages.
 

help/user-guide/wiki/README.md

@@ -15,7 +15,7 @@ In a project wiki you can collaboratively create and document information with y
 | ------------------------------------------------------------ | ------------------------------------------------------------ |
 | [General wiki information](#general-wiki-information)        | How to format a wiki page.                                   |
 | [Image handling](#image-handling)                            | How in insert images in the wiki.                            |
-| [Macros](#macros)                                            | How to add additional information to a wiki page, e.g. work package create button or work package list. |
+| [Macros](#macros)                                            | How to add more information to a wiki page, e.g. work package create button or work package list. |
 | [Links to OpenProject resources](#links-to-openproject-resources) | How to link to OpenProject resources, e.g. work packages, members or projects. |
 
 ## General wiki information
@@ -42,7 +42,7 @@ Create hyperlinks by pressing the toolbar (optionally with some selected text),
 
 ### Widgets and Newlines
 
-CKEditor usese widgets to display block elements such as images, tables, and other elements that are not inline. You can select most widgets by pressing on it - The only exception to that is the table widget, it has a little select knob at the top left to select the entire table.
+CKEditor uses widgets to display block elements such as images, tables, and other elements that are not inline. You can select most widgets by pressing on it - The only exception to that is the table widget, it has a little select knob at the top left to select the entire table.
 
 When you have a widget selected, you can remove or cut it. You can create a newline below it by selecting the widget and pressing ENTER or ↓ (ARROW DOWN), or a newline above it by pressing SHIFT+enter or ↑ (ARROW UP). This is especially needed when the widget is the first or last element on the page to insert a line below or above it.
 
@@ -122,7 +122,7 @@ As with the textile formatting syntax, you can link to other resources within Op
     commit by hash: commit:f30e13e4
     To a source file in the repository: source:"some/file"
 
-To avoid processing these items, preceed them with a bang ! character such as !#12 will prevent linking to a work package with ID 12.
+To avoid processing these items, precede them with a bang ! character such as !#12 will prevent linking to a work package with ID 12.
 
 ### Autocompletion for work packages and users
 

help/user-guide/wiki/create-edit-wiki.md

@@ -9,7 +9,7 @@ keywords: create wiki
 
 # Create and edit a wiki page
 
-In OpenProject you can create and edit wiki pages together with your team to document inportant project information.
+In OpenProject you can create and edit wiki pages together with your team to document important project information.
 
 | Feature                                                      | Documentation for                             |
 | ------------------------------------------------------------ | --------------------------------------------- |
@@ -35,11 +35,11 @@ The editor window will open, allowing you to enter title and content of the new
 
 (2) Enter your wiki content. You can use the editor bar to format your texts.  [Learn here how to format texts in wiki](#wiki) with the editor toolbar.
 
-(3) Insert files. Also, files can be inserted directly via drag and drop or copy and paste to the text input field, or via the image button in the editor toolbar.
+(3) Files can be inserted directly via drag and drop or copy and paste into the text input field, or via the image button in the editor toolbar.
 
 (4) Choose a parent wiki page.
 
-(5) Comment what changes you have made to a wiki page.
+(5) Comment which changes you have made to a wiki page.
 
 (6) Save (or cancel) your changes to the page.
 

help/user-guide/wiki/more-wiki-functions.md

@@ -10,7 +10,7 @@ keywords: wiki settings
 
 # More wiki functions
 
-In the wiki you have more fuctions to edit or configure your wiki page, e.g. to export pages, rename pages, change parent page, view the table of contents and more.
+In the wiki you have more functions to edit or configure your wiki page, e.g. to export pages, rename pages, change parent page, view the table of contents and more.
 
 | Feature                                           | Documentation for                                            |
 | ------------------------------------------------- | ------------------------------------------------------------ |
@@ -38,7 +38,7 @@ Select the item **Lock** in the drop down menu.
 
 The page is now locked and cannot be edited by any other user. 
 
-To unlock a wiki page and make it possible to edit it again for users, select the **Unlock** item under the **More** button on top of a wiki page.
+To unlock a wiki page and make it possible for users to edit it again, select the **Unlock** item under the **More** button on top of a wiki page.
 
 ![unlock-wiki](unlock-wiki.png)
 

help/user-guide/wiki/wiki-menu.md

@@ -9,7 +9,7 @@ keywords: wiki menu
 
 # Wiki project menu
 
-You can add a wiki page directly to the project menu as a separate menu item to have the pages easily accessiblefor all team members.
+You can add a wiki page directly to the project menu as a separate menu item to have the pages easily accessible for all team members.
 
 Wiki menu items are marked with the wiki icon to clearly identify the pages in the project menu.
 
@@ -25,7 +25,7 @@ To add a wiki page as a menu item to the project menu, select the **More** funct
 
 (1) You can give the menu item in the project menu a different name than the wiki page itself by changing the **Name of menu item** in the list.
 
-(2) You can set different **visibilty** options:
+(2) You can set different **visibility** options:
 
 - **Do not show this wikipage in the project navigation** will NOT display a separate menu item in the project navigation. The wiki page is just displayed within the wiki module itself.
 - **Show as menu item in project navigation** will add a separate menu item to the project navigation.

help/user-guide/work-packages/create-work-package.md

@@ -50,7 +50,7 @@ In order to enter detailed information to the work package from the start, you c
 
 ![select-work-package-type](1566303633018.png)
 
-The new work package form will open in the split screen view. Enter all information, such as descsription, assignee, status, priority, due date and more.
+The new work package form will open in the split screen view. Enter all information, such as description, assignee, status, priority, due date and more.
 
 Click the green **Save** button.
 

help/user-guide/work-packages/edit-work-package.md

@@ -29,7 +29,7 @@ Other input fields can be saved with **Enter**.
 
 ![edit-work-package](edit-work-package-1566546727784.png)
 
-The green message on top of the work packaage indicates a successful update.
+The green message on top of the work package indicates a successful update.
 
 ![successful-update](1566546959027.png)
 
@@ -46,7 +46,7 @@ To update the status of a work package, click on the current status in the work
 
 ![update-status](1566375642243.png)
 
-Please note, the status may differ from work package type. They can be configued in the [system administration](./system-admin-guide).
+Please note, the status may differ from work package type. They can be configured in the [system administration](./system-admin-guide).
 
 ### How to add comments to a work package?
 

help/user-guide/work-packages/work-package-table-configuration.md

@@ -14,7 +14,7 @@ keywords: work packages table configuration
 | [Add or remove columns](#add-or-remove-columns-in-the-work-package-table) | How to add or remove columns in the work package table?      |
 | [Filter work packages](#filter-work-packages)                | How to filter in the work package list?                      |
 | [Sort the work package list](#sort-the-work-package-list)    | How to sort within the work package list?                    |
-| [Display settings](#how-to-switch-from-flat-list-to-hierarchy-mode?) | How to switch from flat list to hierarchy mode in the work pacakge list? |
+| [Display settings](#how-to-switch-from-flat-list-to-hierarchy-mode?) | How to switch from flat list to hierarchy mode in the work package list? |
 | [Attribute highlighting (Premium Feature)](#attribute-highlighting-(premium-feature)) | How to highlight certain attributes in the work package list? |
 | [Save work package views](#save-work-package-views)          | How to save a new work package view?                         |
 
@@ -103,19 +103,19 @@ The same filter applied in the hierarchy mode.
 
 You have three different options to display results in the work package list.
 
-* **A flast list** (default), which contains all work packages in a list no matter how their parent-child-relation is.
+* **A flat list** (default), which contains all work packages in a list no matter how their parent-child-relation is.
 * A **Hierarchy**, which will display the filtered results within the parent-child-relation.
 * **Group by** will group the list according to a defined attribute.
 
 You have to choose either option when displaying work packages in the list.
 
-To switch between the different criteria, open the [work packag table configuration](#work-package-table-configuration) and open the tab **Display settings**. Choose how to display the work packages in the list and click the blue **Apply** button.
+To switch between the different criteria, open the [work package table configuration](#work-package-table-configuration) and open the tab **Display settings**. Choose how to display the work packages in the list and click the blue **Apply** button.
 
 ![display-settings](1566397517070.png)
 
 ## Attribute highlighting (Premium Feature)
 
-You can highlight attributes in the work package list to emphasize the importance of certain attributes and have important topics at one sight.
+You can highlight attributes in the work package list to emphasize the importance of certain attributes and have important topics at a glance.
 
 The following attributes can be highlighted in the list:
 
@@ -153,7 +153,7 @@ When you have configured your work package table, you can save the views to acce
 
    **Favored:** Check this Favored checkbox if you want to have this work package as a menu item in your Favorite views.
 
-   Press the bluse **Save** button to save your view.
+   Press the blue **Save** button to save your view.
 
 ![Enter-name for saved view](image-20191118172425655.png)
 
@@ -161,13 +161,13 @@ The view will then be saved in the work packages menu in your **Favorite views**
 
 ![Work-packages-favorite-views](Work-packages-favorite-views.png)
 
-If you check the Public visibilty, the view will be saved under your Public views in the work package menu:
+If you check the Public visibility, the view will be saved under your Public views in the work package menu:
 
 ![Work-packages-public-views](Work-packages-public-views.png)
 
 ### Change saved work package views
 
-If you make changes to a saved view, e.g. change a filter criteria, you have to save the new view once again. In order to apply the change to the actual saved view, click on the disk icon which appears next to the titel of the saved view:
+If you make changes to a saved view, e.g. change a filter criteria, you have to save the new view once again. In order to apply the change to the actual saved view, click on the disk icon which appears next to the title of the saved view:
 
 ![Work-package-change-saved-views](Work-package-change-saved-views.png)