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.
- 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
- Run composer setup
- Install dependencies
- Run
php composer.phar install
- Run
- (Optional) Add proxy support to
export-html.php
. Go to line 191 and add.. 'proxy_host' => 'myproxy', 'proxy_port' => 8080
- (Optional) Add proxy support to
- 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.
- 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.
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');
Use the -c
command line option:
$ ./bin/export-html.php -c data/config-another.customer.php
- PHP
- Atlassian JIRA, at least version 4.4 with activated REST API. Version 5.1 or higher recommended.
Console_CommandLine
from PEARHTTP_Request2
from PEAR
- Gigan - Parse JIRA XML into CouchDB
jira-export
is licensed under the AGPL v3 or later.