https://github.com/netresearch/jira-export
Export all issues of a JIRA issue tracker instance into static HTML files
https://github.com/netresearch/jira-export
jira php
Last synced: over 1 year ago
JSON representation
Export all issues of a JIRA issue tracker instance into static HTML files
- Host: GitHub
- URL: https://github.com/netresearch/jira-export
- Owner: netresearch
- Created: 2013-11-11T10:09:55.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2025-02-19T13:10:36.000Z (over 1 year ago)
- Last Synced: 2025-02-19T13:41:09.249Z (over 1 year ago)
- Topics: jira, php
- Language: PHP
- Size: 40 KB
- Stars: 8
- Watchers: 15
- Forks: 7
- Open Issues: 1
-
Metadata Files:
- Readme: README.rst
Awesome Lists containing this project
README
************************
Static JIRA issue export
************************
Export all issues of a JIRA issue tracker instance into static
HTML files.
This static files can be indexed by an intranet search engine
easily, without having to setup autologin in JIRA.
The first export will take quite some time.
After that initial run, only projects with modifications since the last
export will get updated, which makes it possible to run the export
as cronjob every 15 minutes.
Note: If you use jira 4.4, only export once a day.
``jira-export`` doesn't support partial updates with it.
=============
Setup classic
=============
#. Switch to the folder you want to set this all up in, e.g. ``/home/myuser/``
#. Clone git repository, e.g. ``git clone https://github.com/netresearch/jira-export.git``
#. ``$ cp ./data/config.php.dist ./data/config.php``
#. Set up/edit ``./data/config.php``
#. Install composer (if you don't have it already).. https://getcomposer.org/
#. Run composer setup ``php composer-setup.php``
#. Check composer is working (esp behind a proxy) using ``php composer.phar diag``
#. If you have proxy problems, set up HTTP_PROXY, HTTPS_PROXY env variables
#. Install dependencies
#. Run ``php composer.phar install``
#. (Optional) Add proxy support to ``export-html.php``. Go to line 191 and add..
``'proxy_host' => 'myproxy', 'proxy_port' => 8080``
#. Run the initial import: ``php ./bin/export-html.php``
#. Setup the web server document root to ``www/``
#. Setup cron to run the export every 15 minutes.
=================
Setup with docker
=================
#. Clone git repository
#. ``$ cp data/config.php.dist /data/config.php``
#. Adjust ``data/config.php``
#. Adjust docker-compose.override.yml to your needs
#. run docker-compose run build build
#. run docker-compose up -d
#. Setup cron to run the export every 15 minutes.
========================
Additional configuration
========================
Export some projects only
=========================
If you care about only a fraction of the projects in a JIRA instance,
you can choose to export those only.
Simply adjust ``$allowedProjectKeys`` in your configuration file::
$allowedProjectKeys = array('FOO', 'BAR');
Multiple JIRA instances
=======================
Use the ``-c`` command line option:
$ ./bin/export-html.php -c data/config-another.customer.php
============
Dependencies
============
* PHP
* Atlassian JIRA, at least version 4.4 with activated REST API.
Version 5.1 or higher recommended.
* ``Console_CommandLine`` from PEAR
* ``HTTP_Request2`` from PEAR
=============
Similar tools
=============
* `Gigan`__ - Parse JIRA XML into CouchDB
__ https://github.com/janl/gigan
=================
About jira-export
=================
License
=======
``jira-export`` is licensed under the `AGPL v3`__ or later.
__ http://www.gnu.org/licenses/agpl
Author
======
`Christian Weiske`__, `Netresearch GmbH & Co KG`__
__ mailto:christian.weiske@netresearch.de
__ http://www.netresearch.de/