docs: updated docs for integrations, fixes #4137

* added docs for jira, hipchat, redmine, jira, webhook integrations
* moved old integrations/rcextensions docs to "hooks & extensions"

docs/extensions/extensions-hooks.rst

@@ -0,0 +1,25 b''
+.. _extensions-hooks-ref:
+
+Extensions & Hooks
+==================
+
+The extensions & hooks section references three concepts regularly,
+so to clarify what is meant each time, read the following definitions:
+
+* **Plugin**: A Plugin is software that adds a specific feature to
+  an existing software application.
+* **Extension**: An extension extends the capabilities of,
+  or the data available to, an existing software application.
+* **Hook**: A hook intercepts function calls, messages, or events passed
+  between software components and can be used to trigger plugins, or their
+  extensions.
+
+.. toctree::
+
+   rcx
+   install-ext
+   config-ext
+   extensions
+   hooks
+   full-blown-example
+   int-slack

docs/integrations/hipchat.rst

@@ -0,0 +1,19 b''
+.. _integrations-hipchat:
+
+Hipchat integration
+===================
+
+In order to set a hipchat integration up it is necessary to obtain the Hipchat
+service url by:
+
+1. Login to Hipchat (https://www.hipchat.com/)
+2. Goto `Integrations` -> `Build your own`
+3. Select a room to post notifications to and save it
+
+Once the integration is setup on hipchat you should have a url of the
+form: `
+which can be used in :ref:`creating-integrations`
+
+Once you have set up a Hipchat webhook integrations url of the form:
+``https://yourapp.hipchat.com/v2/room/123456/notification?auth_token=...``,
+create a ``hipchat`` integration in :ref:`creating-integrations`.

docs/integrations/jira.rst

@@ -0,0 +1,26 b''
+.. _integrations-jira:
+
+JIRA integration
+================
+
+.. important::
+
+    In order to make issue numbers clickable in commit messages see the
+    :ref:`rhodecode-issue-trackers-ref` section. The JIRA integration
+    only deals with altering JIRA issues.
+
+.. important::
+
+    JIRA integration is only available in |RCEE|.
+
+
+The JIRA integration allows you to reference and change issue statuses in
+JIRA directly from commit messages using commit message patterns such as
+``fixes #JIRA-235`` in order to change the status of issue JIRA-235 to
+eg. ``Resolved``.
+
+In order to apply a status to a JIRA issue it is necessary to find out the
+transition status id which can be found in the Workflow section of JIRA.
+
+Once you have the transition status id, create a ``jira`` integration in
+:ref:`creating-integrations`.

docs/integrations/redmine.rst

@@ -0,0 +1,25 b''
+.. _integrations-redmine:
+
+Redmine integration
+===================
+
+.. important::
+
+    In order to make issue numbers clickable in commit messages see the
+    :ref:`rhodecode-issue-trackers-ref` section. The Redmine integration
+    only deals with altering Redmine issues.
+
+.. important::
+
+    Redmine integration is only available in |RCEE|.
+
+The Redmine integration allows you to reference and change issue statuses in
+Redmine directly from commit messages using commit message patterns such as
+``fixes #235`` in order to change the status of issue 235 to eg. ``Resolved``
+
+To set a Redmine integration up it is first necessary to obtain a Redmine api
+key. This can be found in ``My Account`` in the Redmine application.
+If it is not there, you may have to enable API Access in Redmine settings.
+
+Once you have the api key, create a ``redmine`` integration in
+:ref:`creating-integrations`.

docs/integrations/slack.rst

@@ -0,0 +1,13 b''
+.. _integrations-slack:
+
+Slack integration
+=================
+
+To set a Slack integration up it is first necessary to set up a Slack webhook api
+endpoint for your slack channel, this can be done at:
+
+https://my.slack.com/services/new/incoming-webhook/
+
+Once you have set up a Slack webhook integrations url of the
+form: ``https://hooks.slack.com/services/...``, create a ``slack`` integration
+in :ref:`creating-integrations`.

docs/integrations/webhook.rst

@@ -0,0 +1,10 b''
+.. _integrations-webhook:
+
+Webhook integration
+===================
+
+The Webhook integration allows you to POST events such as repository pushes
+or pull requests to a custom http endpoint as a json dict with details of the
+event.
+
+To create a webhook integration select ``webhook`` in :ref:`creating-integrations`.

docs/admin/backup-restore.rst

@@ -1,127 +1,127 b''
 .. _backup-ref:
 
 Backup and Restore
 ==================
 
 *“The condition of any backup is unknown until a restore is attempted.”*
 `Schrödinger's Backup`_
 
 To snapshot an instance of |RCE|, and save its settings, you need to backup the
 following parts of the system at the same time.
 
 * The |repos| managed by the instance.
 * The |RCE| database.
 * Any configuration files or extensions that you've configured.
 
 .. important::
 
    Ideally you should script all of these functions so that it creates a
    backup snapshot of your system at a particular timestamp and then run that
    script regularly.
 
 Backup Details
 --------------
 
 To backup the relevant parts of |RCE| required to restore your system, use
 the information in this section to identify what is important to you.
 
 Repository Backup
 ^^^^^^^^^^^^^^^^^
 
 To back up your |repos|, use the API to get a list of all |repos| managed,
 and then clone them to your backup location.
 
 Use the ``get_repos`` method to list all your managed |repos|,
 and use the ``clone_uri`` information that is returned. See the :ref:`api`
 for more information.
 
 .. important::
 
    This will not work for |svn| |repos|. Currently the only way to back up
    your |svn| |repos| is to make a copy of them.
 
    It is also important to note, that you can only restore the |svn| |repos|
    using the same version as they were saved with.
 
 Database Backup
 ^^^^^^^^^^^^^^^
 
 The instance database contains all the |RCE| permissions settings,
 and user management information. To backup your database,
 export it using the following appropriate example, and then move it to your
 backup location:
 
 .. code-block:: bash
 
    # For MySQL DBs
    $ mysqldump -u <uname> -p <pass> db_name > mysql-db-backup
 
    # For PostgreSQL DBs
    $ pg_dump dbname > postgresql-db-backup
 
    # For SQLlite
    $ sqlite3 rhodecode.db ‘.dump’ > sqlite-db-backup
 
 
 The default |RCE| SQLite database location is
 :file:`/home/{user}/.rccontrol/{instance-id}/rhodecode.db`
 
 If running MySQL or PostgreSQL databases, you will have configured these
 separately, for more information see :ref:`rhodecode-database-ref`
 
 Configuration File Backup
 ^^^^^^^^^^^^^^^^^^^^^^^^^
 
 Depending on your setup, you could have a number of configuration files that
 should be backed up. You may have some, or all of the configuration files
 listed in the :ref:`config-rce-files` section. Ideally you should back these
 up at the same time as the database and |repos|.
 
 Gist Backup
 ^^^^^^^^^^^
 
 To backup the gists on your |RCE| instance you can use the ``get_users`` and
 ``get_gists`` API methods to fetch the gists for each user on the instance.
 
 Extension Backups
 ^^^^^^^^^^^^^^^^^
 
 You should also backup any extensions added in the
 :file:`home/{user}/.rccontrol/{instance-id}/rcextensions` directory.
 
 Full-text Search Backup
 ^^^^^^^^^^^^^^^^^^^^^^^
 
 You may also have full text search set up, but the index can be rebuild from
 re-imported |repos| if necessary. You will most likely want to backup your
 :file:`mapping.ini` file if you've configured that. For more information, see
 the :ref:`indexing-ref` section.
 
 Restoration Steps
 -----------------
 
 To restore an instance of |RCE| from its backed up components, use the
 following steps.
 
 1. Install a new instance of |RCE|.
 2. Once installed, configure the instance to use the backed up
    :file:`rhodecode.ini` file. Ensure this file points to the backed up
    database, see the :ref:`config-database` section.
 3. Restart |RCE| and remap and rescan your |repos|, see the
    :ref:`remap-rescan` section.
 
 Post Restoration Steps
 ^^^^^^^^^^^^^^^^^^^^^^
 
 Once you have restored your |RCE| instance to basic functionality, you can
 then work on restoring any specific setup changes you had made.
 
 * To recreate the |RCE| index, use the backed up :file:`mapping.ini` file if
   you had made changes and rerun the indexer. See the
   :ref:`indexing-ref` section for details.
 * To reconfigure any extensions, copy the backed up extensions into the
   :file:`/home/{user}/.rccontrol/{instance-id}/rcextensions` and also specify
-  any custom hooks if necessary. See the :ref:`integrations-ref` section for
+  any custom hooks if necessary. See the :ref:`extensions-hooks-ref` section for
   details.
 
 .. _Schrödinger's Backup: http://novabackup.novastor.com/blog/schrodingers-backup-good-bad-backup/

docs/admin/repo-extra-fields.rst

@@ -1,68 +1,68 b''
 .. _repo-xtra:
 
 Repository Extra Fields
 =======================
 
 Extra fields attached to a |repo| allow you to configure additional actions for
 |RCX|. To install and read more about |RCX|, see the :ref:`install-rcx` section.
 
 Enabling Extra Fields
 ---------------------
 
 To enable extra fields on |repos|, use the following steps:
 
 1. Go to the :menuselection:`Admin --> Settings --> Visual` page.
 2. Check the :guilabel:`Use repository extra fields` box.
 3. Save your changes.
 
 
 Configuring Extra Fields
 ------------------------
 
 To configure extra fields per repository, use the following steps:
 
 1. Go to :menuselection:`Admin --> Repositories` and select :guilabel:`Edit`
    beside the |repo| to which you wish to add extra fields.
 2. On the |repo| settings page, select the :guilabel:`Extra fields` tab.
 
 .. image:: ../images/extra-repo-fields.png
 
 
 Example Usage
 -------------
 
 To use the extra fields in an extension, see the example below. For more
-information and examples, see the :ref:`integrations-ref` section.
+information and examples, see the :ref:`extensions-hooks-ref` section.
 
 .. code-block:: python
 
     call = load_extension('http_notify.py')
     if call:
         url = 'http://default.url' # <url for post data>
 
         # possibly extract the URL from extra fields
         call = load_extension('extra_fields.py')
         if call:
             repo_extra_fields = call(**kwargs)
             # now update if we have extra fields, they have precedence
             # this way users can store any configuration inside the database per
             # repo
             for key, data in repo_extra_fields.items():
                 kwargs[key] = data['field_value']
 
         # an endpoint url data will be sent to, fetched from extra fields
         # if exists, or fallback to default
         kwargs['URL'] = kwargs.pop('webhook_url', None) or url
 
         # fetch pushed commits, from commit_ids list
         call = load_extension('extract_commits.py')
         extracted_commits = {}
         if call:
             extracted_commits = call(**kwargs)
             # store the commits for the next call chain
         kwargs['COMMITS'] = extracted_commits
 
         # set additional keys and values to be sent via POST to given URL
         kwargs['caller_type'] = 'rhodecode'
         kwargs['date'] = time.time() # import time before
         call(**kwargs)

docs/code-review/code-review.rst

@@ -1,27 +1,27 b''
 .. _code-review-ref:
 
 Code Review
 ===========
 
 |RCM| provides two ways in which you can review code. You can review |prs| or
 commits. To better understand |prs|, see the :ref:`pull-requests-ref`
 and :ref:`collaborate-ref` sections. For more information about why
 code review matters, see these posts on the topic:
 
 * `Code Review - Fix Bugs Early and Often`_
 * `Code Review - How to Convince a Skeptic`_
 * `Code Review - Learn How NASA Codes`_
 
 You can also use the |RCE| API set up continuous integration servers to leave
 comments from a test suite. See the :ref:`api` and
-:ref:`integrations-ref` sections for examples on how to set this up.
+:ref:`extensions-hooks-ref` sections for examples on how to set this up.
 
 .. toctree::
 
    review-diffs
    approve-changes
    reviewing-best-practices
 
 .. _Code Review - Fix Bugs Early and Often: https://rhodecode.com/blog/code-review-fix-bugs-early-often/
 .. _Code Review - How to Convince a Skeptic: https://rhodecode.com/blog/code-review-convince-skeptic/
 .. _Code Review - Learn How NASA Codes: https://rhodecode.com/blog/code-review-learn-nasa-codes/

docs/common.py

@@ -1,34 +1,36 b''
 # Try and keep this list alphabetical
 # ui is for user interface elements and messages
 # button - that's obvious
 
 rst_epilog = '''
 .. |AE| replace:: Appenlight
 .. |authtoken| replace:: Authentication Token
 .. |authtokens| replace:: **Auth Tokens**
+.. |RCCEshort| replace:: Community
+.. |RCEEshort| replace:: Enterprise
 .. |git| replace:: Git
 .. |hg| replace:: Mercurial
 .. |svn| replace:: Subversion
 .. |LDAP| replace:: LDAP / Active Directory
 .. |os| replace:: operating system
 .. |OS| replace:: Operating System
 .. |PY| replace:: Python
 .. |pr| replace:: pull request
 .. |prs| replace:: pull requests
 .. |psf| replace:: Python Software Foundation
 .. |repo| replace:: repository
 .. |repos| replace:: repositories
 .. |RCI| replace:: RhodeCode Control
 .. |RCC| replace:: RhodeCode Control
 .. |RCV| replace:: RhodeCode Enterprise
 .. |RCM| replace:: RhodeCode Enterprise
 .. |RCE| replace:: RhodeCode Enterprise
 .. |RCCE| replace:: RhodeCode Community
 .. |RCEE| replace:: RhodeCode Enterprise
 .. |RCX| replace:: RhodeCode Extensions
 .. |RCT| replace:: RhodeCode Tools
 .. |RCEBOLD| replace:: **RhodeCode Enterprise**
 .. |RCEITALICS| replace:: `RhodeCode Enterprise`
 .. |RC| replace:: RhodeCode
 .. |RNS| replace:: Release Notes
 '''

docs/index.rst

@@ -1,84 +1,85 b''
 |RCM|
 =====
 
 |RCM| is a high-performance source code management and collaboration system.
 It enables you to develop projects securely behind the firewall while
 providing collaboration tools that work with |git|, |hg|,
 and |svn| |repos|. The user interface allows you to create, edit,
 and commit files and |repos| while managing their security permissions.
 
 |RCM| provides the following features:
 
 * Source code management.
 * Extended permissions management.
 * Integrated code collaboration tools.
 * Integrated code review and notifications.
 * Scalability provided by multi-node setup.
 * Fully programmable automation API.
 * Web-based hook management.
 * Native |svn| support.
 * Migration from existing databases.
 * |RCM| SDK.
 * Built-in analytics
 * Pluggable authentication system.
 * Support for |LDAP|, Crowd, CAS, PAM.
 * Debug modes of operation.
 * Private and public gists.
 * Gists with limited lifetimes and within instance only sharing.
 * Fully integrated code search function.
 * Always on SSL connectivity.
 
 .. only:: html
 
    Table of Contents
    -----------------
 
 .. toctree::
    :maxdepth: 1
    :caption: Admin Documentation
 
    install/quick-start
    install/install-database
    install/install-steps
    admin/system-overview
    nix/default-env
    admin/system-admin
    admin/user-admin
    admin/setting-repo-perms
    admin/security-tips
    auth/auth
    issue-trackers/issue-trackers
    admin/lab-settings
 
 .. toctree::
    :maxdepth: 1
    :caption: Feature Documentation
 
    collaboration/collaboration
    collaboration/review-notifications
    collaboration/pull-requests
    code-review/code-review
+   integrations/integrations
 
 .. toctree::
    :maxdepth: 1
    :caption: Developer Documentation
 
    api/api
    tools/rhodecode-tools
-   integrations/integrations
+   extensions/extensions-hooks
    contributing/contributing
 
 .. toctree::
    :maxdepth: 1
    :caption: User Documentation
 
    usage/basic-usage
    tutorials/tutorials
 
 .. toctree::
    :maxdepth: 1
    :caption: About
 
    known-issues/known-issues
    release-notes/release-notes
    admin/glossary

docs/integrations/integrations.rst

@@ -1,25 +1,49 b''
-.. _integrations-ref:
+.. _integrations:
+
+Integrations
+------------
 
-Integrations and Extensions
-===========================
+Rhodecode supports integrations with external services for various events
+such as commit pushes and pull requests. Multiple integrations of the same type
+(eg. slack) can be added at the same time which is useful for example to post
+different events to different slack channels.
 
-The integrations section references three concepts regularly,
-so to clarify what is meant each time, read the following definitions:
+Supported integrations
+^^^^^^^^^^^^^^^^^^^^^^
 
-* **Plugin**: A Plugin is software that adds a specific feature to
-  an existing software application.
-* **Extension**: An extension extends the capabilities of,
-  or the data available to, an existing software application.
-* **Hook**: A hook intercepts function calls, messages, or events passed
-  between software components and can be used to trigger plugins, or their
-  extensions.
+============================    ============    =====================================
+Type/Name                       |RC| Edition    Description
+============================    ============    =====================================
+:ref:`integrations-slack`       |RCCEshort|     https://slack.com/
+:ref:`integrations-hipchat`     |RCCEshort|     https://www.hipchat.com/
+:ref:`integrations-webhook`     |RCCEshort|     POST events as `json` to a custom url
+:ref:`integrations-redmine`     |RCEEshort|     Close/Resolve/Reference redmine issues
+:ref:`integrations-jira`        |RCEEshort|     Close/Resolve/Reference JIRA issues
+============================    ============    =====================================
+
+.. _creating-integrations:
+
+Creating an integration
+^^^^^^^^^^^^^^^^^^^^^^^
+
+Integrations can be added globally via the admin UI:
+
+:menuselection:`Admin --> Integrations`
+
+or per repository in the repository settings:
+
+:menuselection:`Admin --> Repositories --> Edit --> Integrations`
+
+To create an integration, select the type from the list of types in the
+`Create an integration` section.
+
+The `Current integrations` section shows existing integrations that have been
+created along with their type (eg. slack) and enabled status.
 
 .. toctree::
 
-   rcx
-   install-ext
-   config-ext
-   extensions
-   hooks
-   full-blown-example
-   int-slack
+   slack
+   hipchat
+   redmine
+   jira
+   webhook

docs/tools/tools-cli.rst

@@ -1,677 +1,677 b''
 .. _tools-cli:
 
 |RCT| CLI
 ---------
 
 The commands available with |RCT| can be split into three categories:
 
 - Remotely executable commands that can be run from your local machine once you
   have your connection details to |RCE| configured.
 - Locally executable commands the can be run on the server to carry out
   general maintenance.
 - Local configuration commands used to help set up your |RCT| configuration.
 
 
 rhodecode-tools
 ---------------
 
 Use |RCT| to setup automation, run the indexer, and install extensions for
 your |RCM| instances. Options:
 
 .. rst-class:: dl-horizontal
 
     \ - -apihost <api_host>
         Set the API host value.
 
     \ - -apikey <apikey_value>
         Set the API key value.
 
     \-c, - -config <config_file>
         Create a configuration file. The default file is created
         in ``~/.rhoderc``
 
     \ - -save-config
         Save the configuration file.
 
     \ - -show-config
         Show the current configuration values.
 
     \ - -format {json,pretty}
         Set the formatted representation.
 
 Example usage:
 
 .. code-block:: bash
 
    $ rhodecode-tools --apikey=key --apihost=http://rhodecode.server \
        --save-config
 
 rhodecode-api
 -------------
 
 The |RC| API lets you connect to |RCE| and carry out management tasks from a
 remote machine, for more information about the API, see the :ref:`api`. To
 pass arguments on the command-line use the ``method:option`` syntax.
 
 Example usage:
 
 .. code-block:: bash
 
     # Run the get_repos API call and sample output
     $ rhodecode-api --instance-name=enterprise-1 create_repo \
         repo_name:brand-new repo_type:hg description:repo-desc
 
     {
       "error": null,
       "id": 1110,
       "result": {
         "msg": "Created new repository `brand-new`",
         "success": true,
         "task": null
       }
     }
 
 Options:
 
 .. rst-class:: dl-horizontal
 
     \ - -api-cache-only
         Requires a cache to be present when running this call
 
     \ - -api-cache-rebuild
         Replaces existing cached values with new ones from server
 
     \ - -api-cache <PATH>
         Use a special cache dir to read responses from instead of the server
 
     \ - -api-cert-verify
          Verify the endpoint ssl certificate
 
     \ - -api-cert <PATH>
          Path to alternate CA bundle.
 
     \ - -apihost <api_host>
         Set the API host value.
 
     \ - -apikey <apikey_value>
         Set the API key value.
 
     \ - -instance-name <instance-id>
         Set the instance name
 
     \-I, - -install-dir <DIR>
         Location of application instances
 
     \-c, - -config <.rhoderc-file>
         Location of the :file:`.rhoderc`
 
     \-F, - -format {json,pretty}
         Set the formatted representation.
 
     \-h, - -help
         Show help messages.
 
     \-v, - -verbose
         Enable verbose messaging
 
 rhodecode-cleanup-gists
 -----------------------
 
 Use this to delete gists within |RCM|. Options:
 
 .. rst-class:: dl-horizontal
 
     \-c, - -config <config_file>
         Set the file path to the configuration file. The default file is
         :file:`/home/{user}/.rhoderc`
 
     \ - -corrupted
         Remove gists with corrupted metadata.
 
     \ - -dont-ask
         Remove gists without asking for confirmation.
 
     \-h, - -help
         Show help messages. current configuration values.
 
     \ - -instance-name <instance-id>
         Set the instance name.
 
     \-R, - -repo-dir
         Set the repository file path.
 
     \ - -version
         Display your |RCT| version.
 
 Example usage:
 
 .. code-block:: bash
 
     # Clean up gists related to an instance
     $ rhodecode-cleanup-gists --instance-name=enterprise-1
     Scanning for gists in /home/brian/repos/.rc_gist_store...
     preparing to remove [3] found gists
 
     # Clean up corrupted gists in an instance
     $ rhodecode-cleanup-gists --instance-name=enterprise-1 --corrupted
     Scanning for gists in /home/brian/repos/.rc_gist_store...
     preparing to remove [2] found gists
     the following gists will be archived:
       * EXPIRED: BAD METADATA        | /home/brian/repos/.rc_gist_store/5
       * EXPIRED: BAD METADATA        | /home/brian/repos/.rc_gist_store/8FtC
     are you sure you want to archive them? [y/N]: y
     removing gist /home/brian/repos/.rc_gist_store/5
     removing gist /home/brian/repos/.rc_gist_store/8FtCKdcbRKmEvRzTVsEt
 
 rhodecode-cleanup-repos
 -----------------------
 
 Use this to manage |repos| and |repo| groups within |RCM|. Options:
 
 .. rst-class:: dl-horizontal
 
     \-c, - -config <config_file>
         Set the file path to the configuration file. The default file is
         :file:`/home/{user}/.rhoderc`.
 
     \-h, - -help
         Show help messages. current configuration values.
 
     \ - -interactive
         Enable an interactive prompt for each repository when deleting.
 
     \ - -include-groups
         Remove repository groups.
 
     \ - -instance-name <instance-id>
         Set the instance name.
 
     \ - -list-only
         Display repositories selected for deletion.
 
     \ - -older-than <str>
         Delete repositories older that a specified time.
         You can use the following suffixes; d for days, h for hours,
         m for minutes, s for seconds.
 
     \-R, - -repo-dir
         Set the repository file path
 
 Example usage:
 
 .. code-block:: bash
 
     # Cleaning up repos using tools installed with RCE 350 and above
     $ ~/.rccontrol/enterprise-4/profile/bin/rhodecode-cleanup-repos \
         --instance-name=enterprise-4 --older-than=1d
     Scanning for repositories in /home/brian/repos...
     preparing to remove [2] found repositories older than 1 day, 0:00:00 (1d)
 
     the following repositories will be deleted completely:
     * REMOVED: 2015-08-05 00:23:18 | /home/brian/repos/rm__20150805_002318_831
     * REMOVED: 2015-08-04 01:22:10 | /home/brian/repos/rm__20150804_012210_336
     are you sure you want to remove them? [y/N]:
 
     # Clean up repos older than 1 year
     # If using virtualenv and pre RCE 350 tools installation
     (venv)$ rhodecode-cleanup-repos --instance-name=enterprise-1 \
         --older-than=365d
 
     Scanning for repositories in /home/brian/repos...
     preparing to remove [343] found repositories older than 365 days
 
     # clean up repos older than 3 days
     # If using virtualenv and pre RCE 350 tools installation
     (venv)$ rhodecode-cleanup-repos --instance-name=enterprise-1 \
         --older-than=3d
     Scanning for repositories in /home/brian/repos...
     preparing to remove [3] found repositories older than 3 days
 
 .. _tools-config:
 
 rhodecode-config
 ----------------
 
 Use this to create or update a |RCE| configuration file on the local machine.
 
 .. rst-class:: dl-horizontal
 
     \- -filename </path/to/config_file>
         Set the file path to the |RCE| configuration file.
 
     \- -show-defaults
         Display the defaults set in the |RCE| configuration file.
 
     \- -update
         Update the configuration with the new settings passed on the command
         line.
 
 .. code-block:: bash
 
     # Create a new config file
     $ rhodecode-config --filename=dev.ini
     Wrote new config file in /Users/user/dev.ini
 
     # Update config value for given section:
     $ rhodecode-config --update --filename=prod.ini [handler_console]level=INFO
 
     $ rhodecode-config --filename=dev.ini --show-defaults
     lang=en
     cpu_number=4
     uuid=<function <lambda> at 0x10d86ac08>
     license_token=ff1e-aa9c-bb66-11e5
     host=127.0.0.1
     here=/Users/brian
     error_aggregation_service=None
     database_url=sqlite:///%(here)s/rhodecode.db?timeout=30
     git_path=git
     http_server=waitress
     port=5000
 
 .. _tools-rhodecode-extensions:
 
 rhodecode-extensions
 --------------------
 
 |RCT| adds additional mapping for :ref:`indexing-ref`, statistics, and adds
 additional code for push/pull/create/delete |repo| hooks. These hooks can be
 used to send signals to build-bots such as jenkins. Options:
 
 .. rst-class:: dl-horizontal
 
     \-c, - -config <config_file>
         Create a configuration file. The default file is created
         in ``~/.rhoderc``
 
     \-h, - -help
          Show help messages.
 
     \-F, - -format {json,pretty}
         Set the formatted representation.
 
     \-I, - -install-dir <str>
         Set the location of the |RCE| installation. The default location is
         :file:`/home/{user}/.rccontrol/`.
 
     \ - -ini-file <str>
         Path to the :file:`rhodecode.ini` file for that instance.
 
     \ - -instance-name <instance-id>
         Set the instance name.
 
     \ - -plugins
          Add plugins to your |RCE| installation. See the
-         :ref:`integrations-ref` section for more details.
+         :ref:`extensions-hooks-ref` section for more details.
 
     \ - -version
          Display your |RCT| version.
 
 
 Once installed, you will see a :file:`rcextensions` folder in the instance
 directory, for example :file:`home/{user}/.rccontrol/{instance-id}/rcextensions`
 
 To install ``rcextensions``, use the following example:
 
 .. code-block:: bash
 
     # install extensions on the given instance
     # If using virtualenv prior to RCE 350
     (venv)$ rhodecode-extensions --instance-name=enterprise-1 \
         --ini-file=rhodecode.ini
     Writen new extensions file to rcextensions
 
     # install extensions with additional plugins on the given instance
     (venv)$ rhodecode-extensions --instance-name=enterprise-1 \
         --ini-file=rhodecode.ini --plugins
     Writen new extensions file to rcextensions
 
     # installing extensions from 350 onwards
     # as they are packaged with RCE
     $ .rccontrol/enterprise-4/profile/bin/rhodecode-extensions --plugins \
       --instance-name=enterprise-4 --ini-file=rhodecode.ini
 
     Writen new extensions file to rcextensions
 
 See the new extensions inside this directory for more details about the
 additional hooks available, for example see the ``push_post.py`` file.
 
 .. code-block:: python
 
     import urllib
     import urllib2
 
     def run(*args, **kwargs):
         """
         Extra params
 
         :param URL: url to send the data to
         """
 
         url = kwargs.pop('URL', None)
         if url:
             from rhodecode.lib.compat import json
             from rhodecode.model.db import Repository
 
             repo = Repository.get_by_repo_name(kwargs['repository'])
             changesets = []
             vcs_repo = repo.scm_instance_no_cache()
             for r in kwargs['pushed_revs']:
                 cs = vcs_repo.get_changeset(r)
                 changesets.append(json.dumps(cs))
 
             kwargs['pushed_revs'] = changesets
             headers = {
                 'User-Agent': 'RhodeCode-SCM web hook',
                 'Content-type': 'application/x-www-form-urlencoded; charset=UTF-8',
                 'Accept': 'text/javascript, text/html, application/xml, '
                           'text/xml, */*',
                 'Accept-Encoding': 'gzip,deflate,sdch',
             }
 
             data = kwargs
             data = urllib.urlencode(data)
             req = urllib2.Request(url, data, headers)
             response = urllib2.urlopen(req)
             response.read()
             return 0
 
 
 rhodecode-gist
 --------------
 
 Use this to create, list, show, or delete gists within |RCM|. Options:
 
 .. rst-class:: dl-horizontal
 
     \ - -api-cache-only
         Requires a cache to be present when running this call
 
     \ - -api-cache-rebuild
         Replaces existing cached values with new ones from server
 
     \ - -api-cache PATH
         Use a special cache dir to read responses from instead of the server
 
     \ - -api-cert-verify
          Verify the endpoint ssl certificate
 
     \ - -api-cert PATH
          Path to alternate CA bundle.
 
     \ - -apihost <api_host>
         Set the API host value.
 
     \ - -apikey <apikey_value>
         Set the API key value.
 
     \-c, - -config <config_file>
         Create a configuration file.
         The default file is created in :file:`~/.rhoderc`
 
     \ - -create <gistname>
         create the gist
 
     \-d, - -description <str>
         Set gist description
 
     \ - -delete <gistid>
         Delete the gist
 
     \-f, - -file
         Specify the filename The file extension will enable syntax highlighting.
 
     \-F, - -format {json,pretty}
         Set the formatted representation.
 
     \ - -help
         Show help messages.
 
     \-I, - -install-dir <DIR>
         Location of application instances
 
     \ - -instance-name <instance-id>
         Set the instance name.
 
     \ - -list
         Display instance gists.
 
     \-l, --lifetime <minutes>
         Set the gist lifetime. The default value is (-1) forever
 
     \ - -show <gistname>
         Show the content of the gist
 
     \-o, - -open
         After creating Gist open it in browser
 
     \-p, - -private
         Create a private gist
 
     \ - -version
          Display your |RCT| version.
 
 Example usage:
 
 .. code-block:: bash
 
     # List the gists in an instance
     (venv)brian@ubuntu:~$ rhodecode-gist --instance-name=enterprise-1 list
     {
       "error": null,
       "id": 7102,
       "result": [
         {
           "access_id": "2",
           "content": null,
           "created_on": "2015-01-19T12:52:26.494",
           "description": "A public gust",
           "expires": -1.0,
           "gist_id": 2,
           "type": "public",
           "url": "http://127.0.0.1:10003/_admin/gists/2"
         },
         {
           "access_id": "7gs6BsSEC4pKUEPLz5AB",
           "content": null,
           "created_on": "2015-01-19T11:27:40.812",
           "description": "Gist testing API",
           "expires": -1.0,
           "gist_id": 1,
           "type": "private",
           "url": "http://127.0.0.1:10003/_admin/gists/7gs6BsSEC4pKUEPLz5AB"
         }
       ]
     }
 
     # delete a particular gist
     # You use the access_id to specify the gist to delete
     (venv)brian@ubuntu:~$ rhodecode-gist delete 2  --instance-name=enterprise-1
     {
       "error": null,
       "id": 6284,
       "result": {
         "gist": null,
         "msg": "deleted gist ID:2"
       }
     }
 
     # cat a file and pipe to new gist
     # This is if you are using virtualenv
     (venv)$ cat ~/.rhoderc | rhodecode-gist --instance-name=enterprise-1 \
         -d '.rhoderc copy' create
 
     {
       "error": null,
       "id": 5374,
       "result": {
         "gist": {
           "access_id": "7",
           "content": null,
           "created_on": "2015-01-26T11:31:58.774",
           "description": ".rhoderc copy",
           "expires": -1.0,
           "gist_id": 7,
           "type": "public",
           "url": "http://127.0.0.1:10003/_admin/gists/7"
         },
         "msg": "created new gist"
       }
     }
 
     # Cat a file and pipe to gist
     # in RCE 3.5.0 tools and above
     $ cat ~/.rhoderc | ~/.rccontrol/{instance-id}/profile/bin/rhodecode-gist \
        --instance-name=enterprise-4 -d '.rhoderc copy' create
     {
       "error": null,
       "id": 9253,
       "result": {
         "gist": {
           "access_id": "4",
           "acl_level": "acl_public",
           "content": null,
           "created_on": "2015-08-20T05:54:11.250",
           "description": ".rhoderc copy",
           "expires": -1.0,
           "gist_id": 4,
           "modified_at": "2015-08-20T05:54:11.250",
           "type": "public",
           "url": "http://127.0.0.1:10000/_admin/gists/4"
         },
         "msg": "created new gist"
       }
     }
 
 
 rhodecode-index
 ---------------
 
 More detailed information regarding setting up the indexer is available in
 the :ref:`indexing-ref` section. Options:
 
 .. rst-class:: dl-horizontal
 
     \ - -api-cache-only
         Requires a cache to be present when running this call
 
     \ - -api-cache-rebuild
         Replaces existing cached values with new ones from server
 
     \ - -api-cache PATH
         Use a special cache dir to read responses from instead of the server
 
     \ - -api-cert-verify
          Verify the endpoint ssl certificate
 
     \ - -api-cert PATH
          Path to alternate CA bundle.
 
     \ - -apihost <api_host>
         Set the API host value.
 
     \ - -apikey <apikey_value>
         Set the API key value.
 
     \-c, --config <config_file>
         Create a configuration file.
         The default file is created in :file:`~/.rhoderc`
 
     \ - -create-mapping <PATH>
          Creates an example mapping configuration for indexer.
 
     \-F, - -format {json,pretty}
          Set the formatted representation.
 
     \-h, - -help
          Show help messages.
 
     \ - -instance-name <instance-id>
         Set the instance name
 
     \-I, - -install-dir <DIR>
         Location of application instances
 
     \-m, - -mapping <file_name>
          Parse the output to the .ini mapping file.
 
     \ - -optimize
          Optimize index for performance by amalgamating multiple index files
          into one. Greatly increases incremental indexing speed.
 
     \-R, - -repo-dir <DIRECTORY>
          Location of repositories
 
     \ - -source <PATH>
          Use a special source JSON file to feed the indexer
 
     \ - -version
          Display your |RCT| version.
 
 Example usage:
 
 .. code-block:: bash
 
     # Run the indexer
     $ ~/.rccontrol/enterprise-4/profile/bin/rhodecode-index \
         --instance-name=enterprise-4
 
     # Run indexer based on mapping.ini file
     # This is using pre-350 virtualenv
     (venv)$ rhodecode-index --instance-name=enterprise-1
 
     # Index from the command line without creating
     # the .rhoderc file
     $ rhodecode-index --apikey=key --apihost=http://rhodecode.server \
         --instance-name=enterprise-2 --save-config
 
     # Create the indexing mapping file
     $ ~/.rccontrol/enterprise-4/profile/bin/rhodecode-index \
         --create-mapping mapping.ini --instance-name=enterprise-4
 
 .. _tools-rhodecode-list-instance:
 
 rhodecode-list-instances
 ------------------------
 
 Use this command to list the instance details configured in the
 :file:`~/.rhoderc` file.
 
 .. code-block:: bash
 
    $ .rccontrol/enterprise-1/profile/bin/rhodecode-list-instances
    [instance:production] - Config only
    API-HOST: https://some.url.com
    API-KEY:  some.auth.token
 
    [instance:development] - Config only
    API-HOST: http://some.ip.address
    API-KEY:  some.auth.token
 
 
 .. _tools-setup-config:
 
 rhodecode-setup-config
 ----------------------
 
 Use this command to create the ``~.rhoderc`` file required by |RCT| to access
 remote instances.
 
 .. rst-class:: dl-horizontal
 
     \- -instance-name <name>
         Specify the instance name in the :file:`~/.rhoderc`
 
     \api_host <hostname>
         Create a configuration file. The default file is created
         in ``~/.rhoderc``
 
     \api_key <auth-token>
         Create a configuration file. The default file is created
         in ``~/.rhoderc``
 
 
 .. code-block:: bash
 
     (venv)$ rhodecode-setup-config --instance-name=tea api_host=URL api_key=xyz
     Config not found under /Users/username/.rhoderc, creating a new one
     Wrote new configuration into /Users/username/.rhoderc