Skip to content
Compare
Choose a tag to compare

Portable and installable builds for UWP, PWA, NWJS and Electron

Kiwix-Zimit-montage

This app comes packaged with a small sample ZIM archve containing a collection of summary articles from Wikipedia on the topic of Climate Change (wikipedia_en_climate_change_mini_2022-05.zim, 22-May-2022). For what's new, see the changes listed in the CHANGELOG. Builds are provided for 32bit and 64bit editions of Windows and Linux (tested on Ubuntu, Debian and OpenSUSE - but see instructions below). ARM is supported via the UWP app.

MS Store status: PUBLISHED
Winget status: PUBLISHED

Please choose the correct version (those marked [AUTO-UPDATE] will self-update automatically when there is a new version):

Installation instructions after screenshot

Composition_Clñimate_Change

Installation Instructions - NWJS/Electron

  • For the Windows Portable build, unzip the contents of the kiwix_js_windows-2.0.8-N-win-ia32.zip archive (or the XP version if you're using that) to any folder, or to a flash drive / thumb drive, and double click on Start Kiwix JS Windows or Start Kiwix JS Windows via batch file.bat, or open the kiwix_js_windows-... folder and double click on nw.exe;
  • For the Windows Setup (installable) build, simply download and launch. It will install itself, together with a shortcut in your shortcut menu, and run. It auto-updates, but if you want to update it manually, then just install a new version over it (it will uninstall the old one for you).
  • For the Linux portable builds, download and save the correct AppImage file anywhere (e.g. your Desktop), and double-click it. If it doesn’t work, open Terminal and run chmod a+x Kiwix-JS-Electron*.AppImage and then ./Kiwix-JS-Electron*.AppImage. This version will auto-update. If you have issues running it on Debian, you can try adding the --no-sandbox switch to the command like this ./Kiwix.JS.Electron*.AppImage --no-sandbox (see electron/electron#17972 (comment)). On older versions of OpenSUSE, you may need to use these commandline switches instead: ./Kiwix.JS.Electron*.AppImage --use-gl=disabled --disable-gpu-compositing
  • For the Linux installable builds:
    • Debian/Ubuntu: download the correct .deb package. Open a terminal, cd to the directory containing the package, and type sudo apt install ./kiwix-js-electron*.deb. Once installed, on Debian, you may have to run the app by opening terminal and typing kiwix-js-electron --no-sandbox. On Ubuntu, you should be able to run it from its installed icon. When you want to update, just install the new version, and it will install over the old version.
    • OpenSUSE: download the correct .rpm package. You probably won't be able to install this with the File manager due to a dependency issue. Instead, open a Terminal with superuser privileges, navigate to the directory containing the .rpm package, and type zypper install kiwix-js-electron-*.rpm. You may be informed about a missing dependency libuuid. It is safe to ignore this dependency, the app will still correctly install and run. Choose "Solution 2: break kiwix-js-electron... by ignoring some of its dependencies'. You will also be warned that the app is not signed. You can ignore this, if you trust this repository. On older versions of OpenSUSE, when you run the app, you may need to add the commandline switches --use-gl=disabled --disable-gpu-compositing, but this appears to be resolved recently.¹
  • Windows: If you get a Windows Smartscreen notification on first launch of the portable app, follow instructions to "Run anyway" if you trust this site. If you prefer, use the installable version Kiwix-JS-Electron-Setup-2.0.8-E.exe which is digitally signed.

¹ With many thanks to Jay Midura for documenting the switches needed for OpenSUSE.

Release Notes

  • This app is packaged with a sample archive of summary articles on Climate Change from Wikipedia, wikipedia_en_climate_change_mini_2022-05.zim, dated 22-May-2022. Apart from the landing page, this archive has no images in articles, and only the lede (summary) of each article is included in order to minimize download size. The packaged archive is located in the archives folder (where this is accessible). See the readme in that folder for more information;
  • You can download many different archives in multiple languages from the Configuration page;
  • It supports dark mode, and opening different navigable windows by right-clicking or ctrl-clicking a link (see Configuration);
  • New experimental support for reading Zimit archives;
  • You can print by pressing Ctrl-P or using the print icon. If local printers are not available (after clicking on More options...) then print to PDF and use another app to print;
  • You can open a new browsable window by right-clicking, middle-clicking or ctrl-clicking an article link (not available in every mode, see option in Configuration);
  • In title search, you can use wildcards .* or .+ (this works best if you start the search with a normal alphanumeric string). You can include a more complex regular expression by enclosing it within (?:my_regular_expression). See Configuration -> About for more details and limitations.
  • You can search for any file in a ZIM by prefixing the namespace, e.g. I/isaac.*newton for images of Isaac Newton (or in no-namespace ZIMs C/isaac.*newton.*webp).

Known Issues

  • INCONSISTENCY: When printing in jQuery mode, all sections are opened before printing (if the user had closed any), whereas in SW mode, closed sections are not opened before printing, if they were closed;
  • On the XP build with some recent ZIMs there is a CSS error in rendering the landing page of this ZIM, due to the age of the Chromium build included in the runtime package. However, you can access all articles by pressing a space in the search box;
  • In the Electron and NWJS apps, If you download an archive from within the app (from Configuration), you will be able to pick a download directory, and the download will start, but then there will be no further indication that a download is in progress. You will need to check the chosen download directory to see if the download has completed;
  • Image manipulation (e.g. saving image to disk) does not currently work with the NWJS app;
  • In Service Worker mode, the NWJS app occasionally crashes accessing certain Wikipedia articles (see #236). It is recommended to use JQuery mode for Wikipedia in this version until this issue is resolved;
  • Please see https://github.com/kiwix/kiwix-js-windows/issues for further known issues. If you find a new issue, please open a new issue on that page.

Instructions for sideloading (UWP)

New! You can sideload the app easily by typing winget install kiwix.kiwixjs in a Command Prompt or PowerShell terminal (Windows 10/11).

For Windows Mobile or for sideloading manually, please download KiwixWebApp_2.0.8.0_AnyCPU.appxbundle and the zipped PowerShell script from Assets below. Then follow the detailed instructions at https://github.com/kiwix/kiwix-js-windows/tree/master/AppPackages#readme.

Compare
Choose a tag to compare

Portable and installable builds for UWP and Electron

image

These custom apps are packaged with the 4-June-2022 English-language WikiMed archive mdwiki_en_all-app_maxi_2022-06.zimaa. They will run on 32bit and 64bit editions of Windows or Linux (tested on Ubuntu, Debian and OpenSUSE - but see instructions below). The Windows builds are not compatible with Windows XP or Windows Vista. If you need an app compatible with those old platforms, get Kiwix JS Windows reader and download the latest WikiMed archive from within the app.

MS Store status: PUBLISHED
Winget status: PUBLISHED

Please choose the correct version (only the Store version will self update):

Installation Instructions - Electron

  • For the Windows Portable build, unzip the contents of the WikiMed-by-Kiwix-2.0.4-E.zip archive to any folder, or to a flash drive / thumb drive, and double click on Start WikiMed by Kiwix or Start WikiMed by Kiwix.bat, or open the kiwix-js-windows-win32-ia32 folder and double click on WikiMed by Kiwix.exe.
  • For the Windows Setup (installable) build, simply download and launch. It will install itself, together with a shortcut in your shortcut menu, and run. When you want to update the app, just install a new version over it (it will uninstall the old one for you).
  • For the Linux portable builds, download and save the correct AppImage file anywhere (e.g. your Desktop), and double-click it. If it doesn’t work, open Terminal and run chmod a+x WikiMed-by-Kiwix*.AppImage and then ./WikiMed-by-Kiwix*.AppImage. If you have trouble with Debian, you may need to add the --no-sandbox switch to the command like this ./WikiMed-by-Kiwix*.AppImage --no-sandbox (see electron/electron#17972 (comment)). With OpenSUSE, you may need to use these commandline switches instead: ./WikiMed-by-Kiwix*.AppImage --use-gl=disabled --disable-gpu-compositing
  • For the Linux installable builds, download the correct .deb package. Open a terminal, cd to the directory containing the package, and type sudo apt install ./kiwix-js-wikimed*.deb. Once installed, on Debian, you may have to run the app by opening terminal and typing kiwix-js-wikimed --no-sandbox. On Ubuntu, you should be able to run it from its installed icon. When you want to update, just install the new version, and it will install over the old version. To install on OpenSUSE, it may be easiest to extract the files from the AppImage instead of using the Deb package. The executable is kiwix-js-wikimed and you may need to add the commandline switches --use-gl=disabled --disable-gpu-compositing
  • Windows: Because the portable archive may not be commonly downloaded, you may face Windows SmartScreen issues on first launch. Follow instructions to "Run anyway" if you trust this site. If you prefer, use the installable version WikiMed-by-Kiwix-Setup-2.0.4-E.exe which is digitally signed.

¹ With many thanks to Jay Midura for documenting the switches needed for OpenSUSE.

Release Notes

  • This app is packaged with the 4-June-2022 English-language WikiMed archive mdwiki_en_all-app_maxi_2022-06.zimaa. The packaged archive is located in the archives folder (only accessible in the portable Windows version). See the readme in that folder if you wish to add a different archive as the packaged ZIM;
  • You can download WikiMed in other languages from the Configuration page (see Known Issues below);
  • It supports dark mode, and opening different navigable windows by right-clicking or ctrl-clicking a link (see Configuration);
  • You can print by pressing Ctrl-P or using the print icon. If local printers are not available (after clicking on More options...) then print to PDF and use another app to print;
  • You can open a new browsable window by right-clicking, middle-clicking or ctrl-clicking an article link (for UWP app, this only works in Service Worker mode);
  • In title search, you can use wildcards .* or .+ (this works best if you start the search with a normal alphanumeric string). You can include a more complex regular expression by enclosing it within (?:my_regular_expression). See Configuration -> About for more details and limitations;
  • You can search for any file in a ZIM by prefixing the namespace, e.g. I/isaac.*newton for images of Isaac Newton (or in no-namespace ZIMs C/isaac.*newton.*webp).

Known Issues

  • INCONSISTENCY: When printing in jQuery mode, all sections are opened before printing (if the user had closed any), whereas in SW mode, closed sections are not opened before printing;
  • In the Electron version (not the UWP version): if you download an archive from within the app (from Configuration), you will be able to pick a download directory, and the download will start, but then there will be no further indication that a download is in progress. You will need to check the chosen download directory to see if the download has completed;
  • Please see https://github.com/kiwix/kiwix-js-windows/issues for further known issues. If you find a new issue, please open a new issue on that page.

Instructions for sideloading (UWP)

New! You can sideload the app easily by typing winget install kiwix.wikimed in a Command Prompt or PowerShell terminal (Windows 10 or 11).

For Windows Mobile or for sideloading manually, please download KiwixWebAppWikiMed_2.0.4.0_AnyCPU.appxbundle and the zipped PowerShell script from Assets below. Then follow the detailed instructions at https://github.com/kiwix/kiwix-js-windows/tree/master/AppPackages#readme.

Compare
Choose a tag to compare

Portable and installable builds for UWP and Electron

image

These custom apps are packaged with the 4 June 2022 English-language Wikivoyage archive wikivoyage_en_all_maxi_2022-06. They will run on 32bit and 64bit editions of Windows or Linux (tested on Ubuntu, Debian and OpenSUSE - but see instructions below). The Windows builds are not compatible with Windows XP or Windows Vista. If you need an app compatible with those old platforms, get Kiwix JS Windows reader and download the latest Wikivoyage archive from within the app.

MS Store status: PUBLISHED
Winget status: PUBLISHED

Please choose the correct version (only the Store version will self update):

Installation Instructions - Electron

  • For the Windows Portable build, unzip the contents of the Wikivoyage-by-Kiwix-2.0.2-E.zip archive to any folder, or to a flash drive / thumb drive, and double click on Start Wikivoyage by Kiwix or Start Wikivoyage by Kiwix.bat, or open the kiwix-js-windows-win32-ia32 folder and double click on Wikivoyage by Kiwix.exe.
  • For the Windows Setup (installable) build, simply download and launch. It will install itself, together with a shortcut in your shortcut menu, and run. When you want to update the app, just install a new version over it (it will uninstall the old one for you).
  • For the Linux portable builds, download and save the correct AppImage file anywhere (e.g. your Desktop), and double-click it. If it doesn’t work, open Terminal and run chmod a+x Wikivoyage-by-Kiwix*.AppImage and then ./Wikivoyage-by-Kiwix*.AppImage. On Debian, you will probably need to add the --no-sandbox switch to the command like this ./Wikivoyage-by-Kiwix*.AppImage --no-sandbox (see electron/electron#17972 (comment)). On OpenSUSE, you may need to use these commandline switches instead: ./Wikivoyage-by-Kiwix*.AppImage --use-gl=disabled --disable-gpu-compositing
  • For the Linux installable builds, download the correct .deb package. Open a terminal, cd to the directory containing the package, and type sudo apt install ./kiwix-js-wikivoyage*.deb. Once installed, on Debian, you may have to run the app by opening terminal and typing kiwix-js-wikivoyage --no-sandbox. On Ubuntu, you should be able to run it from its installed icon. When you want to update, just install the new version, and it will install over the old version. To install on OpenSUSE, it may be easiest to extract the files from the AppImage instead of using the Deb package. The executable is kiwix-js-wikivoyage and you may need to add the commandline switches --use-gl=disabled --disable-gpu-compositing
  • Windows portable version: If you get a Windows Smartscreen notification on first launch, follow instructions to "Run anyway" if you trust this site. If you prefer, use the installable version Wikivoyage-by-Kiwix-Setup-2.0.2-E.exe which is digitally signed.

¹ With many thanks to Jay Midura for documenting the switches needed for OpenSUSE.

Release Notes

  • This app is packaged with the 4 June 2022 English-language Wikivoyage archive wikivoyage_en_all_maxi_2022-06. The packaged archive is located in the archives folder (where this is accessible). See the readme in that folder if you wish to add a different archive as the packaged ZIM;
  • You can download Wikivoyage in other languages from the Configuration page (see Known Issues below);
  • It supports dark mode, and opening different navigable windows by right-clicking or ctrl-clicking a link (see Configuration);
  • You can print by pressing Ctrl-P or using the print icon. If local printers are not available (after clicking on More options...) then print to PDF and use another app to print;
  • You can open a new browsable window by right-clicking, middle-clicking or ctrl-clicking an article link (not available in every mode, see option in Configuration);
  • In title search, you can use wildcards .* or .+ (this works best if you start the search with a normal alphanumeric string). You can include a more complex regular expression by enclosing it within (?:my_regular_expression). See Configuration -> About for more details and limitations.

Known Issues

  • INCONSISTENCY: When printing in jQuery mode, all sections are opened before printing (if the user had closed any), whereas in SW mode, closed sections are not opened before printing;
  • In the Electron version (not the UWP version): if you download an archive from within the app (from Configuration), you will be able to pick a download directory, and the download will start, but then there will be no further indication that a download is in progress. You will need to check the chosen download directory to see if the download has completed;
  • Please see https://github.com/kiwix/kiwix-js-windows/issues for further known issues. If you find a new issue, please open a new issue on that page.

Instructions for sideloading (UWP)

New! You can sideload the app easily by typing winget install kiwix.wikivoyage in a Command Prompt or PowerShell terminal (Windows 10 or 11).

For Windows Mobile or for sideloading manually, please see detailed instructions at https://github.com/kiwix/kiwix-js-windows/tree/master/AppPackages#readme.

0ab7c96
Compare
Choose a tag to compare

This build is out of date!

Please go to https://kiwix.github.io/kiwix-js-windows/kiwix-js-uwp.html for the latest release.

Version 2.0.0 is a big milestone for Kiwix JS. Major new features since version 1.0.0 include:

  • Ability to read Zimit ZIM archives that you can create yourself on https://youzim.it/
  • Vastly improved load speed due to integrated block cache, native Promises, WASM decoders, and other enhancements
  • Support for Linux, with Linux packages for Ubuntu, Debian, OpenSUSE and generic AppImage, 32bit and 64bit
  • Support for any Windows from XP to Windows 11, with NWJS, Electron and modern UWP packages
  • A universal, installable, self-updating PWA version, using the File System Access API for a near-native experience
  • Dynamic content supported in the UWP app by enabling Service Worker mode
  • Support for opening new browsable windows or tabs
  • Ability to search for titles with wildcards and regular expressions
  • Search for any asset in a ZIM by prefixing the namespace (or C/ for no-namespace ZIMs)
  • Support saving images to disk / storage
  • Ability to show hidden navigation boxes in Wikipedia ZIMs even in mobile display style
  • Auto-update for some Electron apps (exe and AppImage)
  • Kiwix JS can be installed and upgraded with the native Windows packet manager, winget
  • Support for new no-namespace ZIM archives

KiwixLogoVerticalHero_v3