Skip to content

Commit

Permalink
Add support for BIM edition selection in packages (#8531)
Browse files Browse the repository at this point in the history
  • Loading branch information
crohr committed Oct 16, 2020
1 parent ceba131 commit 313d216
Show file tree
Hide file tree
Showing 3 changed files with 37 additions and 12 deletions.
5 changes: 4 additions & 1 deletion .pkgr.yml
Expand Up @@ -5,6 +5,7 @@ targets:
build_dependencies:
- libsqlite3-dev
dependencies:
- unzip
- poppler-utils
- unrtf
- tesseract-ocr
Expand All @@ -18,7 +19,8 @@ targets:
ubuntu-20.04:
<<: *debian9
centos-8:
dependencies:
dependencies:
- unzip
- epel-release
centos-7:
dependencies:
Expand All @@ -33,6 +35,7 @@ services:
installer: https://github.com/pkgr/installer.git
wizards:
- https://github.com/pkgr/addon-legacy-installer.git
- https://github.com/opf/addon-openproject-edition.git
- https://github.com/pkgr/addon-postgres
- https://github.com/pkgr/addon-apache2.git
- https://github.com/finnlabs/addon-repositories.git
Expand Down
44 changes: 33 additions & 11 deletions docs/installation-and-operations/installation/packaged/README.md
Expand Up @@ -253,7 +253,7 @@ After you have successfully installed the OpenProject package, you can now perfo

- If you want to enable HTTPS, then you will need to provide the path (on the server) to your certificate file, private key file, and CA bundle file.

## Step 0: start the wizard
## Step 0: Start the wizard

To start the configuration wizard, please run the following command with `sudo`, or as root:

Expand All @@ -263,15 +263,37 @@ sudo openproject configure

**Notes:**

* In case you mistype or need to correct a configuratin option, you can always safely cancel the configuration wizard by pressing `CTRL+C` and restart it by running `sudo openproject reconfigure`.
* 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 wizard steps for options you have not yet selected an option for.
* 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.

* In case you want to run through all 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 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`.

## Step 1: PostgreSQL database configuration
## Step 1: Select your OpenProject Edition

The first dialog in the wizard allows you to choose an option for the PostgreSQL database connection:
OpenProject comes in two editions:

* the default edition, which is targeted at general project management.

* the BIM edition, which is specifically target at the construction industry.

![select-edition](https://github.com/opf/openproject/raw/dev/docs/installation-and-operations/installation/packaged/select-edition.png)

You can find more about the BIM edition on [this page](https://www.openproject.org/bim-project-management/).

<div class="alert alert-info" role="alert">
This wizard step is only available on the following distributions:

* RHEL/CentOS 8
* Ubuntu 20.04
* Debian 10

On older distributions, this wizard step won't be displayed, and the installation will default to the default edition.
</div>

## Step 2: PostgreSQL database configuration

OpenProject requires a PostgreSQL database to store your data. This wizard step allows you to choose an option for the PostgreSQL database connection:

![01-postgres](https://github.com/opf/openproject/raw/dev/docs/installation-and-operations/installation/packaged/01-postgres.png)

Expand All @@ -297,7 +319,7 @@ You can set this `DATABASE_URL` parameter yourself to a PostgreSQL database URL.
sudo openproject config:set DATABASE_URL="postgresql://[user[:password]@][host][:port][/dbname][?param1=value1&...]
```
## Step 2: Apache2 web server
## Step 3: Apache2 web server
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.
Expand Down Expand Up @@ -372,15 +394,15 @@ 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.
## Step 3: SVN/Git integration server
## Step 4: SVN/Git integration server
If you have selected to auto-install an Apache2 web server, you will be asked whether you want to install Git and Subversion repository support. In case you do not need it or when in doubt, choose **Skip** for both options.
For more information, [see our help on repositories](https://www.openproject.org/help/repository/)
![03-repos](https://github.com/opf/openproject/raw/dev/docs/installation-and-operations/installation/packaged/03-repos.png)
## Step 4: Outgoing email configuration
## Step 5: Outgoing email configuration
OpenProject requires a setup for sending outgoing emails for notifications, such as updates on work packages, password resets, or other notifications you and your users receive.
Expand All @@ -402,13 +424,13 @@ Allows you to connect to a SMTP host through authentication types `NONE`, `PLAI
Does not set up mail configuration. You can configure the mail setup in OpenProject by visiting `openproject.example.com/settings?tab=notifications` in your installation. For more information, [visit our help page on this topic](https://www.openproject.org/help/system-settings/email-notification-settings/).
## Step 5: Administrator email
## Step 6: Administrator email
The wizard will ask you for an administrative email address so that it can create the administrator account with that email for the initial login. Enter your email address to have it tied to the admin account.
![05-admin](https://github.com/opf/openproject/raw/dev/docs/installation-and-operations/installation/packaged/05-admin.png)
## Step 6: Memcached server
## Step 7: Memcached server
OpenProject heavily relies on caching, which is why the wizard suggests you to install a local memcached server the OpenProject instances can connect to. You should always set this to `install` unless you have a reason to configure another caching mechanism - for example when configuring multiple shared instances of OpenProject.
Expand Down
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 313d216

Please sign in to comment.