{"id":19713405,"url":"https://github.com/ctsit/redmine_wiki_downloader","last_synced_at":"2025-07-06T13:07:27.340Z","repository":{"id":79003844,"uuid":"385631854","full_name":"ctsit/redmine_wiki_downloader","owner":"ctsit","description":"Utility to download all project wikis from a Redmine forge host","archived":false,"fork":false,"pushed_at":"2021-10-06T18:10:06.000Z","size":23,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-02-27T20:32:47.234Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ctsit.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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":"2021-07-13T14:26:29.000Z","updated_at":"2022-04-05T19:15:12.000Z","dependencies_parsed_at":"2023-03-21T00:29:25.575Z","dependency_job_id":null,"html_url":"https://github.com/ctsit/redmine_wiki_downloader","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/ctsit/redmine_wiki_downloader","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ctsit%2Fredmine_wiki_downloader","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ctsit%2Fredmine_wiki_downloader/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ctsit%2Fredmine_wiki_downloader/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ctsit%2Fredmine_wiki_downloader/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ctsit","download_url":"https://codeload.github.com/ctsit/redmine_wiki_downloader/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ctsit%2Fredmine_wiki_downloader/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263905741,"owners_count":23527972,"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":[],"created_at":"2024-11-11T22:21:55.502Z","updated_at":"2025-07-06T13:07:27.321Z","avatar_url":"https://github.com/ctsit.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Redmine Wiki Downloader\n\nThis utility downloads wiki pages from a Redmine instance via its [REST API](https://www.redmine.org/projects/redmine/wiki/rest_api). Wikis are downloaded into directories by project, with child directories for nested wikis; scripts are provided to allow the wiki to be managed by [MkDocs](https://www.mkdocs.org/).\n\n## Requirements\n\n* Python 3.6 or later\n\nOptional\n* [`pandoc`](https://pandoc.org/installing.html)\n* `mkdocs`\n\n\nThis utility is expected to be used in a UNIX-like environment. It was developed on MacOS.\n\n## Setup\n\n### Configuration\n\nCopy the `example.env` file to `.env`\n\n``` sh\ncp example.env .env\n```\n\nPopulate `.env` with the appropriate values for your Redmine instance, you will likely want to use credentials for an administrator account.\n\n```\nREDMINE_URL=https://example.com/\nREDMINE_USER=admin\nREDMINE_PASSWORD=password\n```\n\n## Use\nOnce your configuration is set, `download_redmine_wikis.py` may be used directly to download wikis for *all* projects from your Redmine instance, including attached files.\n\nBy default, this script will download all projects as siblings of the `download_redmine_wikis.py` script, you may specify an output directory with the optional `--output_dir` flag.\n\n``` sh\npython3 download_redmine_wikis.py --output_dir=\"./redmine_wikis/docs\" | tee redmine_download.log\n```\n\nIt is assumed that the wiki pages are created in the [Textile markup language](https://textile-lang.com/), with [Redmine's wiki specification](https://www.redmine.org/projects/redmine/wiki/RedmineTextFormattingTextile).\n\n### Display with MkDocs\n\nScripts are provided to make the pages suitable for viewing in [MkDocs](https://www.mkdocs.org/), which requires Markdown files.\n\n`convert_all_wiki_pages_to_md.sh` will automatically convert all `.textile` files[^1] to `.md` files and **delete the original `.textile` file**. It is recommended to backup your download prior to running `convert_all_wiki_pages_to_md.sh`, e.g. `tar -zcf redmine_wikis.tgz redmine_wikis`.\n\nAssuming you downloaded your wiki to `redmine_wikis/docs`, the following will create a new MkDocs environment:\n\n``` sh\nbash convert_all_wiki_pages_to_md.sh \u0026\u0026 mkdocs new redmine_wikis\n```\n\nTo launch your site:\n\n``` sh\ncd redmine_wikis\nmkdocs serve\n```\n\nNavigate to [localhost:8000](http://localhost:8000) to view your mkdocs wiki.\n\nConsult the [MkDocs introductory guide](https://www.mkdocs.org/getting-started/) for more information.\n\n[^1]: Redmine's wiki specification differs from default textile format, `convert_wiki_to_md.py` is used by `convert_all_wiki_pages_to_md.sh` to attempt to align the wiki pages with the textile format expected by `pandoc`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fctsit%2Fredmine_wiki_downloader","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fctsit%2Fredmine_wiki_downloader","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fctsit%2Fredmine_wiki_downloader/lists"}