{"id":13499898,"url":"https://github.com/kiwix/kiwix-desktop","last_synced_at":"2026-01-02T15:24:09.105Z","repository":{"id":37789808,"uuid":"112927375","full_name":"kiwix/kiwix-desktop","owner":"kiwix","description":"Kiwix for Windows and GNU/Linux desktops","archived":false,"fork":false,"pushed_at":"2025-05-08T12:07:43.000Z","size":8483,"stargazers_count":908,"open_issues_count":89,"forks_count":126,"subscribers_count":18,"default_branch":"main","last_synced_at":"2025-05-08T13:23:36.249Z","etag":null,"topics":["linux","offline","qt5","wikipedia","windows","zim"],"latest_commit_sha":null,"homepage":"https://download.kiwix.org/release/kiwix-desktop/","language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kiwix.png","metadata":{"files":{"readme":"README.md","changelog":"ChangeLog","contributing":null,"funding":".github/FUNDING.yml","license":"COPYING","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,"zenodo":null},"funding":{"github":"kiwix","patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2017-12-03T12:49:23.000Z","updated_at":"2025-05-08T11:31:40.000Z","dependencies_parsed_at":"2023-02-16T07:15:19.772Z","dependency_job_id":"397ce5dc-5b10-4db3-bdfb-45baacb252d4","html_url":"https://github.com/kiwix/kiwix-desktop","commit_stats":{"total_commits":1108,"total_committers":38,"mean_commits":"29.157894736842106","dds":0.7716606498194946,"last_synced_commit":"13bbd77e59a1c59ab706659647ee7fae3051a0ab"},"previous_names":[],"tags_count":29,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kiwix%2Fkiwix-desktop","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kiwix%2Fkiwix-desktop/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kiwix%2Fkiwix-desktop/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kiwix%2Fkiwix-desktop/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kiwix","download_url":"https://codeload.github.com/kiwix/kiwix-desktop/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254227611,"owners_count":22035669,"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":["linux","offline","qt5","wikipedia","windows","zim"],"created_at":"2024-07-31T22:00:46.442Z","updated_at":"2026-01-02T15:24:09.093Z","avatar_url":"https://github.com/kiwix.png","language":"C++","funding_links":["https://github.com/sponsors/kiwix"],"categories":["JavaScript","\u003ca name=\"cpp\"\u003e\u003c/a\u003eC++","C++"],"sub_categories":[],"readme":"\u003ca href=\"https://flathub.org/apps/details/org.kiwix.desktop\"\u003e\n\u003cimg width=\"100\" alt=\"Download on Flathub\" src=\"https://flathub.org/assets/badges/flathub-badge-en.png\" /\u003e\n\u003c/a\u003e\n\nKiwix Desktop\n=============\n\nKiwix is an offline reader for Web content, primarily designed to make [Wikipedia](https://www.wikipedia.org/) available offline. It reads archives in the [ZIM](https://openzim.org) file format, a highly compressed open format with additional metadata. This is the Kiwix Desktop version - a viewer/manager of ZIM files for GNU/Linux (recent versions) and Microsoft Windows 10 \u0026 11 OSes.\n\n[![Release](https://img.shields.io/github/v/tag/kiwix/kiwix-desktop?label=release\u0026sort=semver)](https://download.kiwix.org/release/kiwix-desktop/)\n[![Repositories](https://img.shields.io/repology/repositories/kiwix-desktop?label=repositories)](https://github.com/kiwix/kiwix-desktop/wiki/Repology)\n[![Build Status](https://github.com/kiwix/kiwix-desktop/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/kiwix/kiwix-desktop/actions?query=branch%3Amain)\n[![CodeFactor](https://www.codefactor.io/repository/github/kiwix/kiwix-desktop/badge)](https://www.codefactor.io/repository/github/kiwix/kiwix-desktop)\n[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)\n\nDisclaimer\n----------\n\nThis document assumes you have a little knowledge about software\ncompilation. If you experience difficulties with the dependencies or\nwith the Kiwix library compilation itself, we recommend to have a look\nat [kiwix-build](https://github.com/kiwix/kiwix-build).\n\nDependencies\n------------\n\nThe Kiwix Desktop application relies on many third party software libraries.\nThe following libraries need to be available:\n\n* [libzim](https://github.com/openzim/libzim/)\n* [libkiwix](https://github.com/kiwix/libkiwix/)\n* [Qt](https://www.qt.io/)\n* [aria2](https://aria2.github.io/)\n\nThese dependencies may or may not be packaged by your operating\nsystem. They may also be packaged but only in an older version. The\ncompilation script will tell you if one of them is missing or too old.\nIn the worst case, you will have to download and compile a bleeding edge\nversion by hand.\n\nLibkiwix has to be compiled dynamically, the best way to have it is\nto use [kiwix-build](https://github.com/kiwix/kiwix-build).\n\nInstall needed packages (on Ubuntu 18.04+):\n\n```bash\nsudo apt-get install libqt5gui5 qtbase5-dev qtwebengine5-dev \\\n     libqt5svg5-dev qt5-image-formats-plugins aria2 \\\n     qttools5-dev-tools qtchooser qt5-qmake \\\n     qtbase5-dev-tools\n```\n\nCompilation\n-----------\n\nOnce all dependencies are installed, you can compile Kiwix Desktop:\n\n```bash\nqmake .\nmake\n```\n\n`qmake` will use pkg-config to locate libraries. Depending on where\nyou've installed libkiwix (and other libraries) you may have to\nupdate the env variable `PKG_CONFIG_PATH`. It can be set as follows,\nfor example, for x86-64 native systems:\n\n```bash\nexport PKG_CONFIG_PATH=\"\u003c...\u003e/BUILD_native_dyn/INSTALL/lib/x86_64-linux-gnu/pkgconfig\"\n```\n\nYou may want to simply open the kiwix-desktop project in QtCreator and\nthen compile the project from there (don't forget to update\n`PKG_CONFIG_PATH` if necessary).\n\nCompilation with Qt6\n--------------------\n\nThere is initial support for Qt6. Additional packages are needed:\n\n```bash\nsudo apt install qt6-base-dev qt6-base-dev-tools qt6-webengine-dev libqt6webenginecore6-bin libqt6svg6\n```\n\nAnd `qmake` needs to be configured to use Qt6. First confirm `qmake` is using the right version:\n\n```bash\nqtchooser -install qt6 $(which qmake6)   # run once\nexport QT_SELECT=qt6                     # set in environments where Qt6 builds are desired\nqmake --version\n```\n\nproduces this output:\n\n```bash\n$ qmake --version\nQMake version 3.1\nUsing Qt version 6.2.4 in /usr/lib/aarch64-linux-gnu\n```\n\nthen build as normal:\n\n```bash\nqmake .\nmake\n```\n\nHandling of 'template-id' related compilation errors\n----------------------------------------------------\n\nMany minor versions of Qt, for both Qt5 and Qt6, have difficulties to\ncompile because of 'template-id' related syntax errors. If your\ncompiler (`g++`) supports it, you can get rid of these errors by\ntelling the compiler to ignore them with the following command:\n\n```bash\nqmake QMAKE_CXXFLAGS=\"-Wno-error=template-id-cdtor\" .\nmake\n```\n\nMore info at:\n* https://github.com/kiwix/kiwix-desktop/issues/1406\n* https://bugzilla.redhat.com/show_bug.cgi?id=2280366\n* https://github.com/RfidResearchGroup/proxmark3/issues/2382\n* https://bugreports.qt.io/browse/QTBUG-126989\n\nCompilation on Microsoft Windows\n--------------------------------\n\nHere is the [online\ndocumentation](https://github.com/kiwix/kiwix-build/wiki/Compile-on-Microsoft-Windows).\n\nInstallation\n------------\n\nTo install Kiwix Desktop on the system:\n```bash\nsudo make install\n```\n\nRun\n---\n\nTo run Kiwix Desktop\n```bash\nkiwix-desktop\n```\n\nYou might have to refresh the `ld` database before:\n```bash\nsudo ldconfig\n```\n\nIf you face problems such as `library not found...`, add the following\nenvironment variable:\n\n```bash\nLD_LIBRARY_PATH=\"\u003c...\u003e/BUILD_native_dyn/INSTALL/lib/x86_64-linux-gnu\"\n```\n\nDebug rendering of a ZIM\n------------------------\n\n`kiwix-desktop` uses [Qt\nWebEngine](https://doc.qt.io/qt-6/qtwebengine-overview.html) to render\nZIM content, relying on a custom `zim:` protocol to expose the ZIM\ndata to the Web engine.\n\nTo debug issues related to WebEngine, follow these steps:\n\n1. Launch `kiwix-desktop` with the environment variable `QTWEBENGINE_REMOTE_DEBUGGING=\u003cport\u003e` set (replace `\u003cport\u003e` with an available local port number).\n2. Open the desired ZIM file in the `kiwix-desktop` user interface.\n3. In a Chromium-based browser, go to: `http://localhost:\u003cport\u003e`.\n4. This opens the remote debugging UI. Use it to access Chrome DevTools connected to the ZIM webpage rendered by WebEngine.\n\n## Communication\n\nAvailable communication channels:\n* [Web Public Chat channel](https://chat.kiwix.org)\n* [Email](mailto:contact+android@kiwix.org)\n* [Mailing list](mailto:kiwix-developer@lists.sourceforge.net)\n* [Slack](https://kiwixoffline.slack.com): #android channel [Get an invite](https://join.slack.com/t/kiwixoffline/shared_invite/zt-19s7tsi68-xlgHdmDr5c6MJ7uFmJuBkg)\n* IRC: #kiwix on irc.freenode.net\n\nFor more information, please refer to\n[https://wiki.kiwix.org/wiki/Communication](https://wiki.kiwix.org/wiki/Communication).\n\n## Support\nIf you're enjoying using Kiwix, drop a ⭐️ on the repo!\n\nLicense\n-------\n\n[GPLv3](https://www.gnu.org/licenses/gpl-3.0) or later, see\n[LICENSE](LICENSE) for more details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkiwix%2Fkiwix-desktop","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkiwix%2Fkiwix-desktop","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkiwix%2Fkiwix-desktop/lists"}