TheDude
/
openproject
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
OpenProject is the leading open source project management software.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
35476 Commits
139 Branches
203 Tags
1.2 GiB
Tag: Branch: Tree: 0cc1593a6a
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '0cc1593a6a'
${ noResults }
openproject/docs/installation/packaged/3-customization.md

56 lines
2.1 KiB
Raw Normal View History Unescape

Update linke to plugins [ci skip]
8 years ago
### Installing plugins
Separate actual documentation guides in github from sources From now on, use `doc/` as a source folder for documentation assets to be built (e.g., API documentation or source files included in wordpress). Use `guides/` for self-reliant Markdown documents on topics relevant for developers and administrators, as well as community-contributed guides we do not feature on the website. [ci skip]
8 years ago
Note: this guide only applies if you've installed OpenProject using our DEB/RPM packages.
Update linke to plugins [ci skip]
8 years ago
[A number of plugins](https://www.openproject.org/plugins/) exist
Separate actual documentation guides in github from sources From now on, use `doc/` as a source folder for documentation assets to be built (e.g., API documentation or source files included in wordpress). Use `guides/` for self-reliant Markdown documents on topics relevant for developers and administrators, as well as community-contributed guides we do not feature on the website. [ci skip]
8 years ago
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.
Update 3-customization.md [ci skip]
8 years ago
#### 1. Add a custom Gemfile
Separate actual documentation guides in github from sources From now on, use `doc/` as a source folder for documentation assets to be built (e.g., API documentation or source files included in wordpress). Use `guides/` for self-reliant Markdown documents on topics relevant for developers and administrators, as well as community-contributed guides we do not feature on the website. [ci skip]
8 years ago
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:
```
Clarify that :opf_plugins group is needed in customization [ci skip]
7 years ago
group :opf_plugins do
gem 'openproject-emoji', git: 'https://github.com/tessi/openproject-emoji.git', :branch => 'op-5-stable'
end
Separate actual documentation guides in github from sources From now on, use `doc/` as a source folder for documentation assets to be built (e.g., API documentation or source files included in wordpress). Use `guides/` for self-reliant Markdown documents on topics relevant for developers and administrators, as well as community-contributed guides we do not feature on the website. [ci skip]
8 years ago
```
Clarify that :opf_plugins group is needed in customization [ci skip]
7 years ago
The `group :opf_plugins` is generally recommended, but only required for plugins with custom frontend code that is picked up by webpack and output into their respective bundles.
Separate actual documentation guides in github from sources From now on, use `doc/` as a source folder for documentation assets to be built (e.g., API documentation or source files included in wordpress). Use `guides/` for self-reliant Markdown documents on topics relevant for developers and administrators, as well as community-contributed guides we do not feature on the website. [ci skip]
8 years ago
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.
Update 3-customization.md [ci skip]
8 years ago
#### 2. Propagate the Gemfile to the package
Separate actual documentation guides in github from sources From now on, use `doc/` as a source folder for documentation assets to be built (e.g., API documentation or source files included in wordpress). Use `guides/` for self-reliant Markdown documents on topics relevant for developers and administrators, as well as community-contributed guides we do not feature on the website. [ci skip]
8 years ago
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
```
Update 3-customization.md [ci skip]
8 years ago
#### 3. Re-run the installer
Separate actual documentation guides in github from sources From now on, use `doc/` as a source folder for documentation assets to be built (e.g., API documentation or source files included in wordpress). Use `guides/` for self-reliant Markdown documents on topics relevant for developers and administrators, as well as community-contributed guides we do not feature on the website. [ci skip]
8 years ago
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.