{"id":25839691,"url":"https://github.com/netresearch/jira-export","last_synced_at":"2025-03-01T04:34:06.247Z","repository":{"id":11763148,"uuid":"14297513","full_name":"netresearch/jira-export","owner":"netresearch","description":"Export all issues of a JIRA issue tracker instance into static HTML files","archived":false,"fork":false,"pushed_at":"2025-02-19T13:10:36.000Z","size":41,"stargazers_count":8,"open_issues_count":1,"forks_count":7,"subscribers_count":15,"default_branch":"master","last_synced_at":"2025-02-19T13:41:09.249Z","etag":null,"topics":["jira","php"],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"njdehoog/Witness","license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/netresearch.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2013-11-11T10:09:55.000Z","updated_at":"2025-02-19T13:02:35.000Z","dependencies_parsed_at":"2024-07-17T10:13:42.343Z","dependency_job_id":"874777d3-e7fa-4eaa-a7f7-e306aad40b9c","html_url":"https://github.com/netresearch/jira-export","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/netresearch%2Fjira-export","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/netresearch%2Fjira-export/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/netresearch%2Fjira-export/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/netresearch%2Fjira-export/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/netresearch","download_url":"https://codeload.github.com/netresearch/jira-export/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241317607,"owners_count":19943199,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["jira","php"],"created_at":"2025-03-01T04:34:05.787Z","updated_at":"2025-03-01T04:34:06.236Z","avatar_url":"https://github.com/netresearch.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"************************\nStatic JIRA issue export\n************************\n\nExport all issues of a JIRA issue tracker instance into static\nHTML files.\n\nThis static files can be indexed by an intranet search engine\neasily, without having to setup autologin in JIRA.\n\nThe first export will take quite some time.\nAfter that initial run, only projects with modifications since the last\nexport will get updated, which makes it possible to run the export\nas cronjob every 15 minutes.\n\nNote: If you use jira 4.4, only export once a day.\n``jira-export`` doesn't support partial updates with it.\n\n=============\nSetup classic\n=============\n\n#. Switch to the folder you want to set this all up in, e.g. ``/home/myuser/``\n#. Clone git repository, e.g. ``git clone https://github.com/netresearch/jira-export.git``\n#. ``$ cp ./data/config.php.dist ./data/config.php``\n#. Set up/edit ``./data/config.php``\n#. Install composer (if you don't have it already).. https://getcomposer.org/\n    #. Run composer setup ``php composer-setup.php``\n    #. Check composer is working (esp behind a proxy) using ``php composer.phar diag``\n    #. If you have proxy problems, set up HTTP_PROXY, HTTPS_PROXY env variables\n#. Install dependencies\n    #. Run ``php composer.phar install``\n#. (Optional) Add proxy support to ``export-html.php``. Go to line 191 and add..\n    ``'proxy_host'        =\u003e 'myproxy', 'proxy_port'        =\u003e 8080``\n#. Run the initial import: ``php ./bin/export-html.php``\n#. Setup the web server document root to ``www/``\n#. Setup cron to run the export every 15 minutes.\n\n\n=================\nSetup with docker\n=================\n\n#. Clone git repository\n#. ``$ cp data/config.php.dist /data/config.php``\n#. Adjust ``data/config.php``\n#. Adjust docker-compose.override.yml to your needs\n#. run docker-compose run build build\n#. run docker-compose up -d\n#. Setup cron to run the export every 15 minutes.\n\n\n========================\nAdditional configuration\n========================\n\nExport some projects only\n=========================\nIf you care about only a fraction of the projects in a JIRA instance,\nyou can choose to export those only.\n\nSimply adjust ``$allowedProjectKeys`` in your configuration file::\n\n    $allowedProjectKeys = array('FOO', 'BAR');\n\n\nMultiple JIRA instances\n=======================\nUse the ``-c`` command line option:\n\n   $ ./bin/export-html.php -c data/config-another.customer.php\n\n\n============\nDependencies\n============\n\n* PHP\n* Atlassian JIRA, at least version 4.4 with activated REST API.\n  Version 5.1 or higher recommended.\n* ``Console_CommandLine`` from PEAR\n* ``HTTP_Request2`` from PEAR\n\n=============\nSimilar tools\n=============\n\n* `Gigan`__ - Parse JIRA XML into CouchDB\n\n__ https://github.com/janl/gigan\n\n\n=================\nAbout jira-export\n=================\n\nLicense\n=======\n``jira-export`` is licensed under the `AGPL v3`__ or later.\n\n__ http://www.gnu.org/licenses/agpl\n\n\nAuthor\n======\n`Christian Weiske`__, `Netresearch GmbH \u0026 Co KG`__\n\n__ mailto:christian.weiske@netresearch.de\n__ http://www.netresearch.de/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnetresearch%2Fjira-export","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnetresearch%2Fjira-export","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnetresearch%2Fjira-export/lists"}