.. _install-plugins:

Plugins installation
====================

Tuleap comes with a lot of plugins, they bring new features and can be easily installed and configured.

Installing new plugins
----------------------

Installation is done in 2 steps

* First, you need to install the corresponding RPM package
* Then you need to install and activate from the site admin interface

When you want to install a new plugin, run (where ``tuleap-plugin-awesomestuff``
is the name of the package of the plugin you want to install):

.. sourcecode:: shell

    # Deploy RPM package
    dnf install tuleap-plugin-awesomestuff

    # Install and activate the plugin for all projects and users
    sudo -u codendiadm tuleap plugin:install awesomestuff

    # Update configurations
    tuleap-cfg site-deploy
    systemctl reload nginx
    systemctl restart tuleap

Once the plugin is installed, go to Tuleap site admin home page and enter the plugin administration page. You can now
install and activate the new plugin from 'Not yet installed' tab.


List of all plugins
-------------------

Project management:

* **tracker**: Tuleap flagship, track anything the way you want
* **graphontrackers**: Display graphs on top of trackers
* **agiledashboard**: Do Scrum Backlog and Kanban
* **cardwall**: Build a board of cards on top of trackers or Backlog
* :ref:`velocity <plugin_velocity>`: Display velocity chart in the Backlog

  * This module is part of :ref:`Tuleap Entreprise <tuleap-enterprise>`.

* :ref:`taskboard <plugin_taskboard>`: Visually keep track of things that need to get done in a task board, used in Backlog.

  * This module is part of :ref:`Tuleap Entreprise <tuleap-enterprise>`.

* :ref:`testmanagement <testmgmt>`: Test campaigns and traceability (aka TTM).

  * This module is part of :ref:`Tuleap Entreprise <tuleap-enterprise>`.

* :ref:`testplan <testmgmt_link_tests_requirements>`: Integration between the Backlog and testmanagement services.

  * This module is part of :ref:`Tuleap Entreprise <tuleap-enterprise>`.

* :ref:`label<label_widget>`: Group and display labels on Project Dashboard (useful to track pull requests)

  * This module is part of :ref:`Tuleap Entreprise <tuleap-enterprise>`.

* :ref:`crosstracker <portfolio>`: Aggregate data across trackers, even in across projects (beta)

  * This module is part of :ref:`Tuleap Entreprise <tuleap-enterprise>`.

* :ref:`timetracking <timetracking>`: Provide an easy way to track your time

  * This module is part of :ref:`Tuleap Entreprise <tuleap-enterprise>`.

* :ref:`projectmilestones <project-milestones>`: Widget to display scrum backlog of a project on user or project dashboard.

  * This module is part of :ref:`Tuleap Entreprise <tuleap-enterprise>`.

* :ref:`roadmap <roadmap>`: Widget to display the roadmap on the project dashboard.

  * This module is part of :ref:`Tuleap Entreprise <tuleap-enterprise>`.

* :ref:`document_generation <plugin_document_generation>`: Export Tuleap tracker reports as documents (docx and xlsx).

  * This module is part of :ref:`Tuleap Entreprise <tuleap-enterprise>`.

* :ref:`program_management <program-management>`: Manage multi project backlog and team synchronisation.

  * This module is part of :ref:`Tuleap Entreprise <tuleap-enterprise>`.

* :ref:`baseline <plugin_baseline>`: Create baseline for releases and compare them (beta).

  * This module is part of :ref:`Tuleap Entreprise <tuleap-enterprise>`.

* :ref:`tracker-functions <tracker-functions>`: Execute custom code after each artifact creation/update.

  * This module is part of :ref:`Tuleap Entreprise <tuleap-enterprise>`.


File deliveries and documentation:

* **document**: Document management
* **frs**: Enhance File Release System with better release view and REST API
* **mediawiki_standalone**: Integration of "Wikipedia" wiki technology
* **webdav**: Access FRS and Documentation like a file system with WebDAV protocol

Source control and continuous integration:

* **svn**: Subversion integration (Core SVN is deprecated)
* **git**: Git integration
* **gitlfs**: Add support of Git Large File Storage (LFS) to the Git integration
* **pullrequest**: Create pull requests on top of Git
* **hudson**: Jenkins integration
* **hudson_git**: Jenkins integration for git
* **hudson_svn**: Jenkins integration for svn

Full-text search:

* :ref:`fts-db <full-text-search-admin>`: Full-text search implementation using the database to index items

  * This module is part of :ref:`Tuleap Entreprise <tuleap-enterprise>`.

* :ref:`fts-meilisearch <full-text-search-admin>`: Full-text search implementation using a Meilisearch server instance to index items

  * This module is part of :ref:`Tuleap Entreprise <tuleap-enterprise>`.

Authentication and permissions:

* **ldap**: Integration with OpenLDAP like or Active Directory
* **openidconnectclient**: Delegate authentication to an OpenId Connect compatible server
* **captcha**: Add a captcha to login page to avoid bots
* :ref:`dynamic credentials <dynamic-credentials>`: Provide a way to generate short-lived credentials

  * This module is part of :ref:`Tuleap Entreprise <tuleap-enterprise>`.

* **project_ownership**: Add additional information to a project such as the notion of project ownership

  * This module is part of :ref:`Tuleap Entreprise <tuleap-enterprise>`.

* :ref:`oauth2-server <openidconnect_provider>`: Delegate authorizations via OAuth 2.0 and authenticate Tuleap users on third-party apps via OpenID Connect

  * This module is part of :ref:`Tuleap Entreprise <tuleap-enterprise>`.

Administration:

* **archivedeleteditems**: When something is deleted, move it into a dedicated place for archiving purpose
* :ref:`securitytxt <securitytxt>`: Deploy a `security.txt <https://securitytxt.org/>`_ (`RFC 9116 <https://www.rfc-editor.org/rfc/rfc9116.html>`_) file
* **statistics**: Compute stats about platform
* :ref:`prometheus_metrics <admin_monitoring_with_prometheus>`: Expose metrics to Prometheus about Tuleap usage

  * This module is part of :ref:`Tuleap Entreprise <tuleap-enterprise>`.

Integrations:

* **bugzilla_reference**: Integration with bugzilla, allow to reference bugzilla bugs (and vice-versa)
* **embed**: Provide a preview of `Figma <https://www.figma.com/>`_ and `Blackfire profiles <https://www.blackfire.io/>`_ inside the artifact view
* **gitlab**: Reference your GitLab commits in Tuleap artifacts and conversely
* **botmattermost**: Integration with mattermost and slack
* **botmattermost-agiledashboard**: Mattermost bot for Backlog
* **botmattermost-git**: Mattermost bot for git
* :ref:`onlyoffice <onlyoffice-integration>`: Integrate `ONLYOFFICE <https://www.onlyoffice.com/>`_ in the document management plugin so you can view your office documents
* :ref:`jira-import <jira-project-importer>`: Import entire Jira project

  * This module is part of :ref:`Tuleap Entreprise <tuleap-enterprise>`.

.. note::

    You might see some other plugins not listed here. It's on purpose, those plugins are no longer actively maintained
    so we don't encourage people to use them.

Deprecated plugins
-------------------

Those plugins should not be installed and only kept for legacy reasons. They will be removed:

* tracker_encryption
* mediawiki