Install OpenProject

https://www.openproject.org/download-and-installation/

1. Add the OpenProject package source

sudo wget -O /etc/yum.repos.d/openproject-ce.repo \
  https://dl.packager.io/srv/opf/openproject-ce/stable/7/installer/el/7.repo

2. Install the OpenProject Community Edition package

Using the following command, yum will install the package and all required dependencies.

sudo yum install openproject

Frequently asked questions – FAQ

How can I install an OpenProject plugin?

Our official installation page has instructions on how to customize your OpenProject installation.

How to backup and restore my OpenProject installation?

Please refer to the documentation at https://www.openproject.org/operations/backup/

How can I install a free SSL certificate using let’s encrypt?

You can get an SSL certificate for free via Let’s Encrypt. Here is how you do it using certbot:

curl https://dl.eff.org/certbot-auto > /usr/local/bin/certbot-auto
chmod a+x /usr/local/bin/certbot-auto

certbot-auto certonly --webroot --webroot-path /opt/openproject/public -d openprojecct.mydomain.com

This requires your OpenProject server to be available from the Internet on port 443 or 80. If this works the certificate (cert.pem) and private key (privkey.pem) will be created under /etc/letsencrypt/live/openproject.mydomain.com/. Configure these for OpenProject to use by running openproject reconfigure and choosing yes when the wizard asks for SSL.

Now this Let’s Encryt certificate is only valid for 90 days. To renew it automatically all you have to do is to add the following entry to your crontab (run crontab -e):

0 1 * * * certbot-auto renew --quiet --post-hook "service apache2 restart"

This will execute certbot renew every day at 1am. The command checks if the certificate is expired and renews it if that is the case. The web server is restarted in a post hook in order for it to pick up the new certificate.


https://www.openproject.org/operations/configuration/

OpenProject configuration

This file describes a part of the OpenProject configuration. You can find general installation instructions here. OpenProject also allows configuring many aspects via its admin interface. The config/settings.yml file should not be used for changing these settings.

OpenProject can be configured either via a configuration.yml file, environment variables or a mix of both. While the latter is probably a bad idea, the environment variable option is often helpful for automatically deploying production systems. Using the configuration file is probably the simplest way of configuration.

You can find a list of options below and an example file in config/configuration.yml.example.

Environment variables

When using environment variables, you can set the options by setting environment variables with the name of the options below in uppercase. So for example, to configure email delivery via an SMTP server, you can set the following environment variables:

EMAIL_DELIVERY_METHOD="smtp"
SMTP_ADDRESS="smtp.example.net"
SMTP_PORT="587"
SMTP_DOMAIN="example.net"
SMTP_AUTHENTICATION="plain"
SMTP_USER_NAME="user"
SMTP_PASSWORD="password"
SMTP_ENABLE_STARTTLS_AUTO="true"

In case you want to use environment variables, but you have no easy way to set them on a specific systme, you can use the dotenv gem. It automatically sets environment variables written to a .env file for a Rails application.

Nested values

You can override nested configuration values as well by joining the respective hash keys with underscores. Underscores within keys have to be escaped by doubling them. For example, given the following configuration:

storage:
  tmp_path: tmp

You can override it by defining the following environment variable:

OPENPROJECT_STORAGE_TMP__PATH=/some/other/path

You can also add new values this way. For instance you could add another field ‘type’ to the storage config above like this:

OPENPROJECT_STORAGE_TYPE=nfs

List of options

Setting session options

Use session_store to define where session information is stored. In order to store sessions in the database and use the following options, set that configuration to :active_record_store.

Delete old sessions for the same user when logging in (Disabled by default)

To enable, set the configuration option drop_old_sessions_on_login to true.

Delete old sessions for the same user when logging out (Enabled by default)

To disable, set the configuration option drop_old_sessions_on_logout to false.

Passing data structures

The configuration uses YAML to parse overrides from ENV. Using YAML inline syntax, you can:

  1. Pass a symbol as an override using OPENPROJECT_SESSION_STORE=":active_record_store"
  2. Pass arrays by wrapping values in brackets (e.g., [val1, val2, val3]).
  3. Pass hashes with {key: foo, key2: bar}.

To pass symbol arrays or hashes with symbol keys, use the YAML !ruby/symbol notiation. Example: {!ruby/symbol key: !ruby/symbol value} will be parsed as { key: :value }.

Please note: The Configuration is a HashWithIndifferentAccess and thus it should be irrelevant for hashes to use symbol keys.

disable password login

default: false

If you enable this option you have to configure at least one omniauth authentication provider to take care of authentication instead of the password login.

All username/password forms will be removed and only a list of omniauth providers presented to the users.

auth source sso

default: nil

Example:

auth_source_sso:
  header: X-Remote-User
  secret: s3cr3t

Can be used to automatically login a user defined through a custom header sent by a load balancer or reverse proxy in front of OpenProject, for instance in a Kerberos Single Sign-On (SSO) setup via apache. The header with the given name has to be passed to OpenProject containing the logged in user and the defined global secret as in $login:$secret.

omniauth direct login provider

default: nil

Example:

omniauth_direct_login_provider: google

Per default the user may choose the usual password login as well as several omniauth providers on the login page and in the login drop down menu. With his configuration option you can set a specific omniauth provider to be used for direct login. Meaning that the login provider selection is skipped and the configured provider is used directly instead.

If this option is active /login will lead directly to the configured omniauth provider and so will a click on ‘Sign in’ (as opposed to opening the drop down menu).

Note that this does not stop a user from manually navigating to any other omniauth provider if additional ones are configured.

attachments storage

default: file

Attachments can be stored using fog as well. You will have to add further configuration through fog, e.g. for Amazon S3:

attachments_storage: fog
fog:
  directory: bucket-name
  credentials:
    provider: 'AWS'
    aws_access_key_id: 'AKIAJ23HC4KNPWHPG3UA'
    aws_secret_access_key: 'PYZO9phvL5IgyjjcI2wJdkiy6UyxPK87wP/yxPxS'
    region: 'eu-west-1'

In order to set these values through ENV variables, use:

<pre>
OPENPROJECT_ATTACHMENTS__STORAGE=fog
OPENPROJECT_FOG_CREDENTIALS_AWS__ACCESS__KEY__ID="AKIAJ23HC4KNPWHPG3UA"
OPENPROJECT_FOG_CREDENTIALS_AWS__SECRET__ACCESS__KEY="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"
OPENPROJECT_FOG_CREDENTIALS_PROVIDER=AWS
OPENPROJECT_FOG_CREDENTIALS_REGION="eu-west-1"
OPENPROJECT_FOG_DIRECTORY=uploads
</pre>

backend migration

You can migrate attachments between the available backends. One example would be that you change the configuration from the file storage to the fog storage. If you want to put all the present file-based attachments into the cloud, you will have to use the following rake task:

rake attachments:copy_to[fog]

It works the other way around too:

rake attachments:copy_to[file]

Note that you have to configure the respective storage (i.e. fog) beforehand as described in the previous section. In the case of fog you only have to configure everything under fog, however. Don’t change attachments_storage to fog just yet. Instead leave it as file. This is because the current attachments storage is used as the source for the migration.

Overriding the help link

You can override the default help menu of OpenProject by specifying a force_help_link option to the configuration. This value is used for the href of the help link, and the default dropdown is removed.

hidden menu items

default: {}

You can disable specific menu items in the menu sidebar for each main menu (such as Administration and Projects). The following example disables all menu items except ‘Users’, ‘Groups’ and ‘Custom fields’ under ‘Administration’:

hidden_menu_items:
  admin_menu:
    - roles
    - types
    - statuses
    - workflows
    - enumerations
    - settings
    - ldap_authentication
    - colors
    - project_types
    - export_card_configurations
    - plugins
    - info

The configuration can be overridden through environment variables. You have to define one variable for each menu. For instance ‘Roles’ and ‘Types’ under ‘Administration’ can be disabled by defining the following variable:

OPENPROJECT_HIDDEN__MENU__ITEMS_ADMIN__MENU='roles types'

blacklisted routes

default: []

You can blacklist specific routes The following example forbid all routes for above disabled menu:

blacklisted_routes:
  - 'admin/info'
  - 'admin/plugins'
  - 'export_card_configurations'
  - 'project_types'
  - 'colors'
  - 'settings'
  - 'admin/enumerations'
  - 'workflows/*'
  - 'statuses'
  - 'types'
  - 'admin/roles'

The configuration can be overridden through environment variables.

OPENPROJECT_BLACKLISTED__ROUTES='admin/info admin/plugins'

disabled modules

default: []

Modules may be disabled through the configuration. Just give a list of the module names either as an array or as a string with values separated by spaces.

Array example:

disabled_modules:
  - backlogs
  - meetings

String example:

disabled_modules: backlogs meetings

The option to use a string is mostly relevant for when you want to override the disabled modules via ENV variables:

OPENPROJECT_DISABLED__MODULES='backlogs meetings'

local checkout path

default: “repositories”

Remote git repositories will be checked out here.

APIv3 basic auth control

default: true

You can enable basic auth access to the APIv3 with the following configuration option:

apiv3_enable_basic_auth: true

global basic auth

default: none

You can define a global set of credentials used to authenticate towards API v3. Example section for configuration.yml:

default:
  authentication:
    global_basic_auth:
      user: admin
      password: admin

Email configuration

  • email_delivery_method: The way emails should be delivered. Possible values: smtp or sendmail

SMTP Options:

  • smtp_address: SMTP server hostname, e.g. smtp.example.net
  • smtp_port: SMTP server port. Common options are 25 and 587.
  • smtp_domain: The domain told to the SMTP server, probably the hostname of your OpenProject instance (sent in the HELO domain command). Example: example.net
  • smtp_authentication: Authentication method, possible values: plainlogincram_md5 (optional, only when authentication is required)
  • smtp_user_name: Username for authentication against the SMTP server (optional, only when authentication is required)
  • smtp_password (optional, only when authentication is required)
  • smtp_enable_starttls_auto: You can disable STARTTLS here in case it doesn’t work. Make sure you don’t login to a SMTP server over a public network when using this. This setting can’t currently be used via environment variables, since setting options to false is only possible via a YAML file. (default: true, optional)
  • smtp_openssl_verify_mode: Define how the SMTP server certificate is validated. Make sure you don’t just disable verification here unless both, OpenProject and SMTP servers are on a private network. Possible values: nonepeerclient_once or fail_if_no_peer_cert

Cache options:

  • rails_cache_storememcache for memcached or memory_store (default: file_store)
  • cache_memcache_server: The memcache server host and IP (default: 127.0.0.1:11211)
  • cache_expires_in: Expiration time for memcache entries (default: 0, no expiry)
  • cache_namespace: Namespace for cache keys, useful when multiple applications use a single memcache server (default: none)

Asset options:

  • rails_asset_host: A custom host to use to serve static assets such as javascript, CSS, images, etc. (default: nil)

Onboarding variables:

  • ‘onboarding_video_url’: An URL for the video displayed on the onboarding modal. This is only shown when the user logs in for the first time.

Edit on GitHub


https://www.openproject.org/plugins/

Plugins

Install plugins

You can install plugins for the following installation methods:

Develop plugins

We encourage you to extend OpenProject yourself by writing a plugin. Please, read the plugin-contributions guide for more information.

If you are a plugin author and want your plugins to be listed here, leave us a note in our forums, via twitter or any other communication channel. We’re looking forward to your contribution.

Please note that the plugin author is responsible to keep his plugin up to date with OpenProject development. In case a plugin causes errors, please contact the plugin author and/or write in our support forums. We will remove plugins from this page if we notice that they are not maintained.

Supported plugins

Supported plugins are compatible with the current OpenProject version. When a plugin has a dependency to another plugin it is necessary that you list both plugins in the Gemfile.plugins.

Backlogs

gem "openproject-backlogs", git: "https://github.com/finnlabs/openproject-backlogs.git", :branch => 'stable/5'
gem "openproject-pdf_export", git: "https://github.com/finnlabs/openproject-pdf_export.git", :branch => 'stable/5'

Cost

gem 'openproject-costs', git: 'https://github.com/finnlabs/openproject-costs.git', :branch => 'stable/5'

Dark-Theme

  • Description: Allows users to switch to the dark theme instead of the OpenProject theme
  • Author: OpenProject GmbH
  • Link: Source
gem 'openproject-themes-dark', git: 'https://github.com/finnlabs/openproject-themes-dark.git', :branch => 'stable/5'

Documents

gem 'openproject-documents', git: 'https://github.com/opf/openproject-documents.git', :branch => 'stable/5'

Global Roles

gem 'openproject-global_roles', git: 'https://github.com/finnlabs/openproject-global_roles.git', :branch => 'stable/5'

Local Avatars

gem 'openproject-local_avatars', git: 'https://github.com/finnlabs/openproject-local_avatars', :branch => 'stable/5'

Meeting

gem 'openproject-meeting', git: 'https://github.com/finnlabs/openproject-meeting.git', :branch => 'stable/5'

My Project Page

gem 'openproject-my_project_page', git: 'https://github.com/finnlabs/openproject-my_project_page.git', :branch => 'stable/5'

OmniAuth OpenID-Connect-Providers

  • Description: Offers a convenient way to configure different OmniAuth OpenIDConnect providers (preconfigured for Google and Heroku).
  • Author: OpenProject GmbH
  • Link: Source
gem 'omniauth-openid_connect-providers', git: 'https://github.com/finnlabs/omniauth-openid_connect-providers.git', :branch => 'dev'

OpenID-Connect

  • Description: Adds support for OmniAuth OpenID Connect strategy providers, most importantly Google.
  • Author: OpenProject GmbH
  • Link: Source
gem 'omniauth-openid-connect', git: 'https://github.com/finnlabs/omniauth-openid-connect.git', :branch => 'dev'

PDF Export

  • Description: Enables story card export for OpenProject Backlogs
  • Author: OpenProject GmbH
  • Link: Source
  • Dependency: Backlogs
gem 'openproject-pdf_export', git: 'https://github.com/finnlabs/openproject-pdf_export.git', :branch => 'stable/5'
gem 'openproject-backlogs', git: 'https://github.com/finnlabs/openproject-backlogs.git', :branch => 'stable/5'

Reporting

  • Description: Customized cost reporting features
  • Author: OpenProject GmbH
  • Link: Source
  • Dependency: Costs, Reporting Engine
gem 'reporting_engine', git: 'https://github.com/finnlabs/reporting_engine.git', :branch => 'dev'
gem 'openproject-costs', git: 'https://github.com/finnlabs/openproject-costs.git', :branch => 'stable/5'
gem 'openproject-reporting', git: 'https://github.com/finnlabs/openproject-reporting.git', :branch => 'stable/5'

XLS-Export

gem 'openproject-xls_export', git: 'https://github.com/finnlabs/openproject-xls_export.git', :branch => 'stable/5'

Community plugins

There are several plugins developed by dedicated community members. We really appreciate their hard work!

Please keep in mind that it can not always be guaranteed that they are compatible with the current OpenProject version. Authors are responsible for maintaining their plugins and are doing the best they can to keep the plugins up to date. Please contact the authors directly if you have any questions or feedback, or even want to help them out.

Auto Project

gem "openproject-auto_project", git: "https://github.com/oliverguenther/openproject-auto_project.git", :branch => 'stable'

Ensure Project Hierarchy

  • Description: Ensures subproject identifiers are prefixed with their parent project’s identifier
  • Author: Oliver Günther
  • Link: Source
gem "openproject-ensure_project_hierarchy", git: "https://github.com/oliverguenther/openproject-ensure_project_hierarchy.git", :branch => 'stable'

Plugins in development (potentially unstable)

OpenProject Git Hosting

  • Description: Provides extensive features for managing Git repositories within OpenProject
  • Author: Oliver Günther
  • Link: Source
gem "openproject-git_hosting", git: "https://github.com/oliverguenther/openproject-git_hosting.git", :branch => "dev"

Note:

You can find the master document in GitHub. You can propose a change to this guide by creating a pull request on GitHub.


https://www.openproject.org/plugins/install-plugins-packaged/

Install plugins – packaged installation

Note: this guide only applies if you’ve installed OpenProject using our DEB/RPM packages.

A number of plugins exist for use with OpenProject. Most plugins that are maintained by us are shipping with OpenProject, however there are several plugins contributed by the community.

Previously, using them in a packaged installation was not possible without losing your changes on every upgrade. With the following steps, you can now use third party plugins.

Note: We cannot guarantee upgrade compatibility for third party plugins nor do we provide support for them. Please carefully check whether the plugins you use are available in newer versions before upgrading your installation.

1. Add a custom Gemfile

If you have a plugin you wish to add to your packaged OpenProject installation, create a separate Gemfile with the Gem dependencies, such as the following:

gem 'openproject-emoji', git: 'https://github.com/tessi/openproject-emoji.git', :branch => 'op-5-stable'

We suggest to store the Gemfile under /etc/openproject/Gemfile.custom, but the choice is up to you, just make sure the openproject user is able to read it.

2. Propagate the Gemfile to the package

You have to tell your installation to use the custom gemfile via a config setting:

openproject config:set CUSTOM_PLUGIN_GEMFILE=/etc/openproject/Gemfile.custom

3. Re-run the installer

To re-bundle the application including the new plugins, as well as running migrations and precompiling their assets, simply re-run the installer while using the same configuration as before.

openproject configure

Using configure will take your previous decisions in the installer and simply re-apply them, which is an idempotent operation. It will detect the Gemfile config option being set and re-bundle the application with the additional plugins.

Note:

You can find the master document in GitHub. You can propose a change to this guide by creating a pull request on GitHub.

WordPress

FOS4US.CA is hosted on our own server and is published using the 2016 theme of WordPress. A few plug-ins (also free and open-source) provide some additional functionality:

  • Askimet: to check readers’ comments against a global spam database to prevent us from publishing garbage or malicious content
  • TinyMCE Advanced: to add, remove or arrange buttons on the Visual Editor toolbar related to 15 TinyMCE plug-ins
  • Footnotation: to add footnotes to our pages and posts

While we’re most familiar with WordPress, you may prefer one of these other free and open-source Content Management Systems:

FYI

WordPress is a free and open-source content management system (CMS) based on PHP and MySQL. To function, WordPress has to be installed on a web server, which would either be part of an Internet hosting service or a network host in its own right. An example of the first scenario may be a service like WordPress.com, for example, and the second case could be a computer running the software package WordPress.org. A local computer may be used for single-user testing and learning purposes. Features include a plugin architecture and a template system. WordPress was used by more than 27.5% of the top 10 million websites as of February 2017. WordPress is reportedly the most popular website management or blogging system in use on the Web, supporting more than 60 million websites. WordPress is released under the GPLv2 (or later) license.