mirror of
https://github.com/kiwix/kiwix-js-pwa.git
synced 2025-08-03 11:28:21 -04:00
Rename kiwix-js-windows to kiwix-js-pwa (#476)
This commit is contained in:
Jaifroid
GitHub
parent
91ef8e7ab6
commit
f4daca3d7c
6
.github/workflows/publish-docker.yaml
vendored
6
.github/workflows/publish-docker.yaml
vendored
@ -67,7 +67,7 @@ jobs:
|
||||
tag-pattern: /^v?([0-9.]+)$/
|
||||
latest-on-tag: true
|
||||
dockerfile: docker/dockerfile.pwa
|
||||
restrict-to: kiwix/kiwix-js-windows
|
||||
restrict-to: kiwix/kiwix-js-pwa
|
||||
registries: ghcr.io
|
||||
manual-tag: ${{ github.event.inputs.version }}
|
||||
- name: Restart live webapp
|
||||
@ -93,5 +93,5 @@ jobs:
|
||||
fi
|
||||
# Set gh-pages branch on origin to the currently checked-out branch
|
||||
git push origin HEAD:gh-pages --force
|
||||
echo "After deployment, the app will be available at https://kiwix.github.io/kiwix-js-windows/"
|
||||
echo "The production deployment will be available at https://kiwix.github.io/kiwix-js-windows/dist/"
|
||||
echo "After deployment, the app will be available at https://kiwix.github.io/kiwix-js-pwa/"
|
||||
echo "The production deployment will be available at https://kiwix.github.io/kiwix-js-pwa/dist/"
|
||||
|
||||
@ -4,7 +4,7 @@ The easiest way to install the UWP app on Windows 10/11 is from the Microsoft St
|
||||
|
||||
https://www.microsoft.com/en-gb/store/p/kiwix-js/9p8slz4j979j
|
||||
|
||||
There are portable and installable versions for Linux (Ubuntu, Debian, OpenSUSE), and Windows XP/Vista/7/8/10/11 available from https://kiwix.github.io/kiwix-js-windows/kiwix-js-electron.html. The Store and Electron Setup and AppImage versions are self-updating. The `zip`, `deb` and `rpm` versions do not self-update.
|
||||
There are portable and installable versions for Linux (Ubuntu, Debian, OpenSUSE), and Windows XP/Vista/7/8/10/11 available from https://kiwix.github.io/kiwix-js-pwa/kiwix-js-electron.html. The Store and Electron Setup and AppImage versions are self-updating. The `zip`, `deb` and `rpm` versions do not self-update.
|
||||
|
||||
There is a PWA version at https://pwa.kiwix.org/ which can be installed as an offline app in any Chromium browser (Chrome, Edge) -- see Install button in
|
||||
Configuration. In Firefox, the app can be bookmarked, and will work offline, but it cannot be installed.
|
||||
@ -20,7 +20,7 @@ different build, then follow the instructions below. _Uninstall any previous ins
|
||||
Starting in Windows 10 version 2004, **sideloading is enabled by default** and you can install apps by double-clicking signed app packages.
|
||||
On Windows 10 version 1909 and earlier, sideloading requires some additional configuration, as does sideloading unsigned packages.
|
||||
|
||||
* **Simple procedure**: Just try launching your package! The Kiwix JS Windows packages downloadable from [Releases](https://github.com/kiwix/kiwix-js-windows/releases/) are signed. Download the `.appxbundle` from the Assets section of a Release and launch it by double-clicking.
|
||||
* **Simple procedure**: Just try launching your package! The Kiwix JS Windows packages downloadable from [Releases](https://github.com/kiwix/kiwix-js-pwa/releases/) are signed. Download the `.appxbundle` from the Assets section of a Release and launch it by double-clicking.
|
||||
* If you wish to test an unsigned package, find an `.appxbundle` above inside `AppPackages/KiwixWebApp_x.x.x.x_[AnyCPU]_Test/` folders, and try to launch it by double-clicking.
|
||||
* You may be prompted to allow sideloading, or you may need to enable it first on version 1909 or earlier: go to Settings -> Update and security -> For developers. If this doesn't work, follow procedure below.
|
||||
* **You will need a ZIM archive to use the full features of this app** - [see below](#download-a-zim-archive-all-platforms).
|
||||
@ -39,7 +39,7 @@ On Windows 10 version 1909 and earlier, sideloading requires some additional con
|
||||
|
||||
## Windows 10 Mobile
|
||||
|
||||
Download the .appx or .appxbundle from [Releases](https://github.com/kiwix/kiwix-js-windows/releases), or open an `AppPackages/KiwixWebApp_0.x.x.x_[AnyCPU]_Test/` folder above, and save it in your downloads folder, or other accessible folder, on the phone. NB DO NOT DOWNLOAD the .appxupload files you see above, as these are useless for installation.
|
||||
Download the .appx or .appxbundle from [Releases](https://github.com/kiwix/kiwix-js-pwa/releases), or open an `AppPackages/KiwixWebApp_0.x.x.x_[AnyCPU]_Test/` folder above, and save it in your downloads folder, or other accessible folder, on the phone. NB DO NOT DOWNLOAD the .appxupload files you see above, as these are useless for installation.
|
||||
|
||||
Enable Developer mode on your device (Settings / Updates and security / For developers). Open the File Explorer on the phone, navigate to the downloads folder and tap the KiwixWebApp bundle. You will be asked if you wish to install, but it then installs silently in the background. Be patient: it can take a minute or so for the Kiwix icon to appear in the All Apps list. You will also need to download a ZIM file to use with the app (see below).
|
||||
|
||||
|
||||
38
README.md
38
README.md
@ -12,11 +12,11 @@ offline knowledge!**
|
||||
|
||||
The app is available either as an offline-capable, [installable Web App](#universal-progressive-web-app) (PWA), for almost all modern
|
||||
browsers and devices, or else as app packages for various Windows and Linux operating systems: see
|
||||
**[Kiwix JS for Windows and Linux](https://kiwix.github.io/kiwix-js-windows/kiwix-js-uwp.html)**. For **Mac and iOS**, use the offline
|
||||
**[Kiwix JS for Windows and Linux](https://kiwix.github.io/kiwix-js-pwa/kiwix-js-uwp.html)**. For **Mac and iOS**, use the offline
|
||||
web app ([more info below](#universal-progressive-web-app)).
|
||||
|
||||
We also have packaged apps of **[WikiMed by Kiwix](https://kiwix.github.io/kiwix-js-windows/wikimed-uwp.html)** (a complete medical
|
||||
encyclopaedia), and **[Wikivoyage by Kiwix](https://kiwix.github.io/kiwix-js-windows/wikivoyage-uwp.html)** (a complete travel guide) in
|
||||
We also have packaged apps of **[WikiMed by Kiwix](https://kiwix.github.io/kiwix-js-pwa/wikimed-uwp.html)** (a complete medical
|
||||
encyclopaedia), and **[Wikivoyage by Kiwix](https://kiwix.github.io/kiwix-js-pwa/wikivoyage-uwp.html)** (a complete travel guide) in
|
||||
English -- no extra download needed! (You can, however, download other languages in these apps.)
|
||||
|
||||
If you are using **Windows 10 or 11**, then all three apps are conveniently available in the Microsoft Store:
|
||||
@ -24,8 +24,8 @@ If you are using **Windows 10 or 11**, then all three apps are conveniently avai
|
||||
**[WikiMed by Kiwix](https://www.microsoft.com/store/apps/9PHJSNP1CZ8J)**,
|
||||
and **[Wikivoyage by Kiwix](https://www.microsoft.com/store/apps/9N5SB90Q4JBJ)**. They will automatically update when a new package is
|
||||
available. If you are using **Linux**, then the
|
||||
[Electron AppImage package](http://kiwix.github.io/kiwix-js-windows/kiwix-js-electron.html) of Kiwix JS also (optionally) self-updates,
|
||||
as does the installable [Windows Electron package](http://kiwix.github.io/kiwix-js-windows/kiwix-js-electron.html). All other apps can
|
||||
[Electron AppImage package](http://kiwix.github.io/kiwix-js-pwa/kiwix-js-electron.html) of Kiwix JS also (optionally) self-updates,
|
||||
as does the installable [Windows Electron package](http://kiwix.github.io/kiwix-js-pwa/kiwix-js-electron.html). All other apps can
|
||||
(optionally) notify you when a new version is available, and give you a download link.
|
||||
|
||||
## Universal Progressive Web App
|
||||
@ -42,7 +42,7 @@ Once installed, bookmarked or added to your home screen, the PWA works even when
|
||||
|
||||
And when we say "Universal", we mean Universal: Android, iOS, macOS, Linux, Windows...
|
||||
|
||||
<img src="https://github.com/kiwix/kiwix-js-windows/assets/4304337/bbe944b5-ab64-4a24-a826-367e0ded0e33" width=640 />
|
||||
<img src="https://github.com/kiwix/kiwix-js-pwa/assets/4304337/bbe944b5-ab64-4a24-a826-367e0ded0e33" width=640 />
|
||||
|
||||
## How do I get all of Wikipedia offline?
|
||||
|
||||
@ -64,7 +64,7 @@ Try it and see! You don't have to make your own Zimit ZIMs: Kiwix download libra
|
||||
sites in the Zimit file format, such as the Ready.Gov disaster preparedness site, the fascinating Low-Tech magazine, the CIA World Factbook --
|
||||
amongst many others. Just open the Zimit directory in the in-app library.
|
||||
|
||||
|
||||
|
||||
|
||||
## Browser support
|
||||
|
||||
@ -86,10 +86,10 @@ try switching the app to JQuery mode (see Content injection mode in Configuratio
|
||||
|
||||
* As an application implemented with the following frameworks:
|
||||
|
||||
+ <img src="images/electron-color.svg" width="27" /> Electron >= 1.8.0 (Ubuntu, Debian, Fedora, OpenSUSE, AppImage, Windows): [GitHub release](https://kiwix.github.io/kiwix-js-windows/kiwix-js-electron.html)
|
||||
+ <img src="images/microsoftwindows-color.svg" width="20" /> Universal Windows Platform (UWP) >=10.0.10240: [Microsoft Store app](https://www.microsoft.com/store/apps/9P8SLZ4J979J) or [GitHub release](https://kiwix.github.io/kiwix-js-windows/kiwix-js-uwp.html) - Windows 10/11 (Electron), Windows on ARM, Xbox, Windows 10 Mobile
|
||||
+ <img src="images/nwjs-color.svg" width="20" /> NWJS >= 0.23.0 (Windows 7/8/10/11): [GitHub release](https://kiwix.github.io/kiwix-js-windows/kiwix-js-nwjs.html)
|
||||
+ NWJS 0.14.7 (Windows XP/Vista only): [GitHub release](https://kiwix.github.io/kiwix-js-windows/kiwix-js-nwjs.html)
|
||||
+ <img src="images/electron-color.svg" width="27" /> Electron >= 1.8.0 (Ubuntu, Debian, Fedora, OpenSUSE, AppImage, Windows): [GitHub release](https://kiwix.github.io/kiwix-js-pwa/kiwix-js-electron.html)
|
||||
+ <img src="images/microsoftwindows-color.svg" width="20" /> Universal Windows Platform (UWP) >=10.0.10240: [Microsoft Store app](https://www.microsoft.com/store/apps/9P8SLZ4J979J) or [GitHub release](https://kiwix.github.io/kiwix-js-pwa/kiwix-js-uwp.html) - Windows 10/11 (Electron), Windows on ARM, Xbox, Windows 10 Mobile
|
||||
+ <img src="images/nwjs-color.svg" width="20" /> NWJS >= 0.23.0 (Windows 7/8/10/11): [GitHub release](https://kiwix.github.io/kiwix-js-pwa/kiwix-js-nwjs.html)
|
||||
+ NWJS 0.14.7 (Windows XP/Vista only): [GitHub release](https://kiwix.github.io/kiwix-js-pwa/kiwix-js-nwjs.html)
|
||||
|
||||
`*` With **Firefox on Android**, the app is only useable with files stored in the Origin Private File System. There is a Firefox bug whereby the browser
|
||||
attempts to read the entire ZIM archive into memory if opening it from the user-visible file system.
|
||||
@ -108,8 +108,8 @@ Although deprecated, we will keep support for as long as is practical:
|
||||
This repository is for development of the Kiwix JS app for PWA, Electron, NWJS and Windows 10/11 Universal Windows Platform (UWP).
|
||||
The latest code is usually on the main branch, but this is used for active development and may be several commits ahead of releases.
|
||||
Installable and portable versions for Windows (XP/Vista/7/8/10/11) and Linux (32bit and 64bit) are available from
|
||||
[releases](https://github.com/kiwix/kiwix-js-windows/releases/). Unstable [nightly builds](https://download.kiwix.org/nightly/) of the
|
||||
Electron and NWJS apps are available together with a [development deployment](https://kiwix.github.io/kiwix-js-windows/), but code may be
|
||||
[releases](https://github.com/kiwix/kiwix-js-pwa/releases/). Unstable [nightly builds](https://download.kiwix.org/nightly/) of the
|
||||
Electron and NWJS apps are available together with a [development deployment](https://kiwix.github.io/kiwix-js-pwa/), but code may be
|
||||
buggy and change rapidly.
|
||||
|
||||
The code is based on [Kiwix JS](https://github.com/kiwix/kiwix-js), a lightweight HTML/JavaScript port of the Kiwix Offline reader.
|
||||
@ -122,9 +122,9 @@ APIs, see the bottom of this page:
|
||||
All three apps are available in the WinGet Package Manager. You can sideload the UWP version (in Windows 10/11) by opening a Command
|
||||
Prompt or PowerShell terminal and typing `winget install kiwix.kiwixjs` (this version will not auto-update, but it will let you know when
|
||||
a new update is ready to install). Alternative sideloading instructions are available in the
|
||||
[release notes](https://kiwix.github.io/kiwix-js-windows/kiwix-js-uwp.html). The Electron version can be installed with
|
||||
[release notes](https://kiwix.github.io/kiwix-js-pwa/kiwix-js-uwp.html). The Electron version can be installed with
|
||||
`winget install kiwix.kiwixjs.electron`, or else by downloading a package from
|
||||
[Releases](https://github.com/kiwix/kiwix-js-windows/releases/). For testing, the Store, Electron and NWJS versions come packaged with a
|
||||
[Releases](https://github.com/kiwix/kiwix-js-pwa/releases/). For testing, the Store, Electron and NWJS versions come packaged with a
|
||||
mini archive of the top 100 Wikipedia articles (without images and with only the lede paragraph).
|
||||
|
||||
This app is regularly tested fully on Wikimedia ZIM files, though many other ZIM file types work. There is experimental support for most
|
||||
@ -132,7 +132,7 @@ Zimit ZIMs from version 1.9.8 onwards, and Type 1 Zimit ZIMs are supported from
|
||||
most storage types (including microSD cards) that are formatted as exFAT or NTFS, you can store even these very large files in the storage
|
||||
with no problem. However, if you plan to store your ZIM file on an SD card formatted as **FAT32**, and you wish to use an archive larger
|
||||
than 4GB, then you will need to split the ZIM: see
|
||||
[file splitting instructions](https://github.com/kiwix/kiwix-js-windows/tree/main/AppPackages#download-a-zim-archive-all-platforms).
|
||||
[file splitting instructions](https://github.com/kiwix/kiwix-js-pwa/tree/main/AppPackages#download-a-zim-archive-all-platforms).
|
||||
|
||||
A lot of development for this app happens upstream in the [Kiwix JS repository](https://kiwix.github.io/kiwix-js/) to which I ontribute
|
||||
actively. Without Kiwix JS, this app would be impossible, and huge thanks goes to the original developers of first the Evopedia app and
|
||||
@ -142,7 +142,7 @@ Kantaris. I can be contacted by email: egk10 at cam ac uk.
|
||||
|
||||
## Reporting bugs
|
||||
|
||||
Please use this repository's [issue tracker](https://github.com/kiwix/kiwix-js-windows/issues) to report any bugs you have found with the software. Open a new
|
||||
Please use this repository's [issue tracker](https://github.com/kiwix/kiwix-js-pwa/issues) to report any bugs you have found with the software. Open a new
|
||||
issue (after checking that the issue you identified doesn't have an issue already). In all cases, please state clearly the version number you are using (see
|
||||
the About page in the app), and which browser or platform you are using. Please read the
|
||||
[Kiwix JS bug reporting guidelines](https://github.com/kiwix/kiwix-js/blob/main/REPORT_BUG.md) before opening your issue.
|
||||
@ -219,6 +219,6 @@ for further information.
|
||||
|
||||
**Builds of this app are available that do not use a Store or an online Service Worker.** Please see:
|
||||
|
||||
* [Releases](https://github.com/kiwix/kiwix-js-windows/releases/)
|
||||
* [NWJS version](https://kiwix.github.io/kiwix-js-windows/kiwix-js-nwjs.html) - this version is completely standalone
|
||||
* [Releases](https://github.com/kiwix/kiwix-js-pwa/releases/)
|
||||
* [NWJS version](https://kiwix.github.io/kiwix-js-pwa/kiwix-js-nwjs.html) - this version is completely standalone
|
||||
and will never access servers unless you allow it to.
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
|
||||
Due to GitHub filesize restrictions, it is not possible to upload ZIMs that are larger than 100Mb to this directory. If you wish to build the source code yourself,
|
||||
you will need to add the appropriate packaged ZIM file to your local repository before building, or else commit a
|
||||
[split ZIM archive](https://github.com/kiwix/kiwix-js-windows/tree/main/AppPackages#download-a-zim-archive-all-platforms) in chunks ideally below 50MB each chunk.
|
||||
[split ZIM archive](https://github.com/kiwix/kiwix-js-pwa/tree/main/AppPackages#download-a-zim-archive-all-platforms) in chunks ideally below 50MB each chunk.
|
||||
|
||||
## How to change the packaged archive
|
||||
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
owner: kiwix
|
||||
repo: kiwix-js-windows
|
||||
repo: kiwix-js-pwa
|
||||
provider: github
|
||||
updaterCacheDirName: kiwix-js-electron-updater
|
||||
publisherName:
|
||||
|
||||
@ -4,14 +4,14 @@
|
||||
<meta charset="utf-8">
|
||||
<title>Redirecting to latest Kiwix JS Electron and NWJS release</title>
|
||||
<meta http-equiv="refresh"
|
||||
content="2; URL=https://github.com/kiwix/kiwix-js-windows/releases/tag/v2.7.2">
|
||||
content="2; URL=https://github.com/kiwix/kiwix-js-pwa/releases/tag/v2.7.2">
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<div style="max-width: 1240px; margin: 3em auto">
|
||||
<h1>Redirecting to latest Kiwix JS Electron and NWJS release...</h1>
|
||||
<p>If your browser does not automatically redirect, please click on:</p>
|
||||
<p><a href="https://github.com/kiwix/kiwix-js-windows/releases/tag/v2.7.2">
|
||||
<p><a href="https://github.com/kiwix/kiwix-js-pwa/releases/tag/v2.7.2">
|
||||
Kiwix JS Electron/NWJS: releases
|
||||
</a>
|
||||
</p>
|
||||
|
||||
@ -4,14 +4,14 @@
|
||||
<meta charset="utf-8">
|
||||
<title>Redirecting to latest Kiwix JS NWJS and Electron release</title>
|
||||
<meta http-equiv="refresh"
|
||||
content="2; URL=https://github.com/kiwix/kiwix-js-windows/releases/tag/v2.7.2">
|
||||
content="2; URL=https://github.com/kiwix/kiwix-js-pwa/releases/tag/v2.7.2">
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<div style="max-width: 1240px; margin: 3em auto">
|
||||
<h1>Redirecting to latest Kiwix JS NWJS and Electron release...</h1>
|
||||
<p>If your browser does not automatically redirect, please click on:</p>
|
||||
<p><a href="https://github.com/kiwix/kiwix-js-windows/releases/tag/v2.7.2">
|
||||
<p><a href="https://github.com/kiwix/kiwix-js-pwa/releases/tag/v2.7.2">
|
||||
Kiwix JS NWJS/Electron: releases
|
||||
</a>
|
||||
</p>
|
||||
|
||||
@ -4,14 +4,14 @@
|
||||
<meta charset="utf-8">
|
||||
<title>Redirecting to latest Kiwix JS Windows UWP release</title>
|
||||
<meta http-equiv="refresh"
|
||||
content="2; URL=https://github.com/kiwix/kiwix-js-windows/releases/tag/v2.7.2">
|
||||
content="2; URL=https://github.com/kiwix/kiwix-js-pwa/releases/tag/v2.7.2">
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<div style="max-width: 1240px; margin: 3em auto">
|
||||
<h1>Redirecting to latest Kiwix JS Windows UWP release...</h1>
|
||||
<p>If your browser does not automatically redirect, please click on:</p>
|
||||
<p><a href="https://github.com/kiwix/kiwix-js-windows/releases/tag/v2.7.2">
|
||||
<p><a href="https://github.com/kiwix/kiwix-js-pwa/releases/tag/v2.7.2">
|
||||
Kiwix JS Windows: releases
|
||||
</a>
|
||||
</p>
|
||||
|
||||
@ -18,7 +18,7 @@
|
||||
<uap:ApplicationContentUriRules>
|
||||
<uap:Rule Match="ms-appx-web:///www/index.html" Type="include" uap5:ServiceWorker="true" WindowsRuntimeAccess="all" />
|
||||
<uap:Rule Match="https://pwa.kiwix.org/" Type="include" uap5:ServiceWorker="true" WindowsRuntimeAccess="all" />
|
||||
<uap:Rule Match="https://kiwix.github.io/kiwix-js-windows/dist/" Type="include" uap5:ServiceWorker="true" WindowsRuntimeAccess="all" />
|
||||
<uap:Rule Match="https://kiwix.github.io/kiwix-js-pwa/dist/" Type="include" uap5:ServiceWorker="true" WindowsRuntimeAccess="all" />
|
||||
</uap:ApplicationContentUriRules>
|
||||
<uap:VisualElements DisplayName="Kiwix JS" Description="Kiwix Offline Wikipedia and ZIM File Reader" BackgroundColor="transparent" Square150x150Logo="images\Square150x150Logo.png" Square44x44Logo="images\Square44x44Logo.png">
|
||||
<uap:DefaultTile ShortName="Kiwix JS" Square310x310Logo="images\LargeTile.png" Wide310x150Logo="images\Wide310x150Logo.png" Square71x71Logo="images\SmallTile.png">
|
||||
|
||||
@ -18,7 +18,7 @@
|
||||
<uap:ApplicationContentUriRules>
|
||||
<uap:Rule Match="ms-appx-web:///www/index.html" Type="include" uap5:ServiceWorker="true" WindowsRuntimeAccess="all" />
|
||||
<uap:Rule Match="https://pwa.kiwix.org/" Type="include" uap5:ServiceWorker="true" WindowsRuntimeAccess="all" />
|
||||
<uap:Rule Match="https://kiwix.github.io/kiwix-js-windows/dist/" Type="include" uap5:ServiceWorker="true" WindowsRuntimeAccess="all" />
|
||||
<uap:Rule Match="https://kiwix.github.io/kiwix-js-pwa/dist/" Type="include" uap5:ServiceWorker="true" WindowsRuntimeAccess="all" />
|
||||
</uap:ApplicationContentUriRules>
|
||||
<uap:VisualElements DisplayName="Kiwix JS" Description="Kiwix Offline Wikipedia and ZIM File Reader" BackgroundColor="transparent" Square150x150Logo="images\Square150x150Logo.png" Square44x44Logo="images\Square44x44Logo.png">
|
||||
<uap:DefaultTile ShortName="Kiwix JS" Square310x310Logo="images\LargeTile.png" Wide310x150Logo="images\Wide310x150Logo.png" Square71x71Logo="images\SmallTile.png">
|
||||
|
||||
@ -133,10 +133,10 @@
|
||||
"dist-linux": "electron-builder build --linux --projectDir dist",
|
||||
"dist-linux-appimage": "electron-builder build --linux AppImage:x64 --projectDir dist",
|
||||
"publish": "electron-builder --projectDir dist",
|
||||
"postpackage-win": "(robocopy archives bld\\Electron\\kiwix-js-windows-win32-ia32\\resources\\app\\archives\\ > null) ^& IF %ERRORLEVEL% LSS 8 SET ERRORLEVEL = 0",
|
||||
"postpackage-linux": "(robocopy archives bld\\Electron\\kiwix-js-windows-linux-x64\\archives\\ > null) ^& IF %ERRORLEVEL% LSS 8 SET ERRORLEVEL = 0"
|
||||
"postpackage-win": "(robocopy archives bld\\Electron\\kiwix-js-pwa-win32-ia32\\resources\\app\\archives\\ > null) ^& IF %ERRORLEVEL% LSS 8 SET ERRORLEVEL = 0",
|
||||
"postpackage-linux": "(robocopy archives bld\\Electron\\kiwix-js-pwa-linux-x64\\archives\\ > null) ^& IF %ERRORLEVEL% LSS 8 SET ERRORLEVEL = 0"
|
||||
},
|
||||
"repository": "https://github.com/kiwix/kiwix-js-windows",
|
||||
"repository": "https://github.com/kiwix/kiwix-js-pwa",
|
||||
"keywords": [
|
||||
"Kiwix",
|
||||
"offline",
|
||||
|
||||
@ -72,7 +72,7 @@
|
||||
"icon": "www/img/icons/kiwix-64.ico"
|
||||
}
|
||||
},
|
||||
"repository": "https://github.com/kiwix/kiwix-js-windows",
|
||||
"repository": "https://github.com/kiwix/kiwix-js-pwa",
|
||||
"keywords": [
|
||||
"Kiwix",
|
||||
"offline",
|
||||
|
||||
@ -38,7 +38,7 @@ if ($original_release_tag_name) {
|
||||
if ($electronbuild -eq "cloud") {
|
||||
$branch_name = &{ git branch --show-current }
|
||||
"Setting the build branch to: $branch_name"
|
||||
$release_uri = 'https://api.github.com/repos/kiwix/kiwix-js-windows/actions/workflows/build-electron.yml/dispatches'
|
||||
$release_uri = 'https://api.github.com/repos/kiwix/kiwix-js-pwa/actions/workflows/build-electron.yml/dispatches'
|
||||
# Set up dispatch_params object - for API see https://docs.github.com/en/rest/reference/actions#create-a-workflow-dispatch-event
|
||||
$dispatch_params = @{
|
||||
Uri = $release_uri
|
||||
@ -169,7 +169,7 @@ if (-Not (($electronbuild -eq 'cloud') -or $old_windows_support -or (Test-Path $
|
||||
# Package portable electron app for Windows
|
||||
"`nBuilding portable Electron app for Windows"
|
||||
"Compressing release package for Electron..."
|
||||
$foldername = "kiwix-js-windows-win32-ia32"
|
||||
$foldername = "kiwix-js-pwa-win32-ia32"
|
||||
$compressed_assets_dir = $base_dir + $foldername
|
||||
# Find the executable filename in the folder
|
||||
$executable = (ls "$unpacked_folder/*.exe") -replace '^.*[/\\]([^/\\]+)$', '$1'
|
||||
|
||||
@ -17,7 +17,7 @@ param (
|
||||
[switch]$help = $false # If invoked with -help, will display help on valid switches
|
||||
)
|
||||
# DEV: To build new icons, install electron-icon-builder, then
|
||||
# electron-icon-builder --input=C:\Repos\kiwix-js-windows\bld\icon.png --output=./build_resources/
|
||||
# electron-icon-builder --input=C:\Repos\kiwix-js-pwa\bld\icon.png --output=./build_resources/
|
||||
# then move icons in png into /build_resources/icons/
|
||||
|
||||
function Get-ReleaseHelp {
|
||||
@ -81,7 +81,7 @@ if ($help -or $tag_name -eq '?') {
|
||||
}
|
||||
|
||||
# Provide parameters
|
||||
$release_uri = 'https://api.github.com/repos/kiwix/kiwix-js-windows/releases'
|
||||
$release_uri = 'https://api.github.com/repos/kiwix/kiwix-js-pwa/releases'
|
||||
if ($GITHUB_TOKEN) {
|
||||
$github_token = $GITHUB_TOKEN
|
||||
} else {
|
||||
|
||||
@ -1,23 +1,23 @@
|
||||
## Portable and installable builds of Kiwix JS WikiMed Electron Edition for Windows 7/8/10/11 and Linux
|
||||
|
||||
This is **not** the UWP/Microsoft Store build. If you are using Windows 10 or 11, we strongly recommend [the WikiMed release for the Microsoft Store](https://kiwix.github.io/kiwix-js-windows/wikimed-uwp.html), which will keep itself up-to-date automatically. These portable and installable versions run on the included [Electron platform](https://www.electronjs.org/) version 10.4.0.
|
||||
This is **not** the UWP/Microsoft Store build. If you are using Windows 10 or 11, we strongly recommend [the WikiMed release for the Microsoft Store](https://kiwix.github.io/kiwix-js-pwa/wikimed-uwp.html), which will keep itself up-to-date automatically. These portable and installable versions run on the included [Electron platform](https://www.electronjs.org/) version 10.4.0.
|
||||
|
||||
These builds are packaged with the <<date>> English-language WikiMed archive `<<zim>>`. They will run on 32bit and 64bit editions of Windows or Linux (tested on Ubuntu, Debian and OpenSUSE - but see instructions below). The Windows build is **not compatible with Windows XP or Windows Vista**. If you need an app compatible with those old platforms, get [Kiwix JS Windows reader](https://kiwix.github.io/kiwix-js-windows/kiwix-js-nwjs.html) and download the latest WikiMed archive from within the app.
|
||||
These builds are packaged with the <<date>> English-language WikiMed archive `<<zim>>`. They will run on 32bit and 64bit editions of Windows or Linux (tested on Ubuntu, Debian and OpenSUSE - but see instructions below). The Windows build is **not compatible with Windows XP or Windows Vista**. If you need an app compatible with those old platforms, get [Kiwix JS Windows reader](https://kiwix.github.io/kiwix-js-pwa/kiwix-js-nwjs.html) and download the latest WikiMed archive from within the app.
|
||||
|
||||
Choose the correct build (**warning: the download is at least 1.2GB**):
|
||||
|
||||
* **Windows**:
|
||||
- **Portable** (just unzip, no install needed)
|
||||
+ Windows 7/8/10/11 - [Kiwix JS WikiMed <<base_tag>>.zip](https://github.com/kiwix/kiwix-js-windows/releases/download/v<<base_tag>>-WikiMed/Kiwix.JS.WikiMed.<<base_tag>>.zip)
|
||||
+ Windows 7/8/10/11 - [Kiwix JS WikiMed <<base_tag>>.zip](https://github.com/kiwix/kiwix-js-pwa/releases/download/v<<base_tag>>-WikiMed/Kiwix.JS.WikiMed.<<base_tag>>.zip)
|
||||
- **Installable**
|
||||
+ Windows 7/8/10/11 - [Kiwix JS WikiMed Setup <<numeric_tag>>-E.exe](https://github.com/kiwix/kiwix-js-windows/releases/download/v<<base_tag>>-WikiMed/Kiwix.JS.WikiMed.Setup.<<numeric_tag>>-E.exe)
|
||||
+ Windows 7/8/10/11 - [Kiwix JS WikiMed Setup <<numeric_tag>>-E.exe](https://github.com/kiwix/kiwix-js-pwa/releases/download/v<<base_tag>>-WikiMed/Kiwix.JS.WikiMed.Setup.<<numeric_tag>>-E.exe)
|
||||
* **Linux**:
|
||||
- **Portable**
|
||||
+ AppImage 64bit (Ubuntu, Debian, OpenSUSE) - [Kiwix JS WikiMed-<<numeric_tag>>-E.AppImage](https://github.com/kiwix/kiwix-js-windows/releases/download/v<<base_tag>>-WikiMed/Kiwix.JS.WikiMed-<<numeric_tag>>-E.AppImage)
|
||||
+ AppImage 32bit (Ubuntu, Debian, OpenSUSE) - [Kiwix JS WikiMed-<<numeric_tag>>-E-i386.AppImage](https://github.com/kiwix/kiwix-js-windows/releases/download/v<<base_tag>>-WikiMed/Kiwix.JS.WikiMed-<<numeric_tag>>-E-i386.AppImage)
|
||||
+ AppImage 64bit (Ubuntu, Debian, OpenSUSE) - [Kiwix JS WikiMed-<<numeric_tag>>-E.AppImage](https://github.com/kiwix/kiwix-js-pwa/releases/download/v<<base_tag>>-WikiMed/Kiwix.JS.WikiMed-<<numeric_tag>>-E.AppImage)
|
||||
+ AppImage 32bit (Ubuntu, Debian, OpenSUSE) - [Kiwix JS WikiMed-<<numeric_tag>>-E-i386.AppImage](https://github.com/kiwix/kiwix-js-pwa/releases/download/v<<base_tag>>-WikiMed/Kiwix.JS.WikiMed-<<numeric_tag>>-E-i386.AppImage)
|
||||
- **Installable**
|
||||
+ Deb package 64bit (Ubuntu, Debian) - [kiwix-js-wikimed_<<numeric_tag>>-E_amd64.deb](https://github.com/kiwix/kiwix-js-windows/releases/download/v<<base_tag>>-WikiMed/kiwix-js-wikimed_<<numeric_tag>>-E_amd64.deb)
|
||||
+ Deb package 32bit (Ubuntu, Debian) - [kiwix-js-wikimed_<<numeric_tag>>-E_i386.deb](https://github.com/kiwix/kiwix-js-windows/releases/download/v<<base_tag>>-WikiMed/kiwix-js-wikimed_<<numeric_tag>>-E_i386.deb)
|
||||
+ Deb package 64bit (Ubuntu, Debian) - [kiwix-js-wikimed_<<numeric_tag>>-E_amd64.deb](https://github.com/kiwix/kiwix-js-pwa/releases/download/v<<base_tag>>-WikiMed/kiwix-js-wikimed_<<numeric_tag>>-E_amd64.deb)
|
||||
+ Deb package 32bit (Ubuntu, Debian) - [kiwix-js-wikimed_<<numeric_tag>>-E_i386.deb](https://github.com/kiwix/kiwix-js-pwa/releases/download/v<<base_tag>>-WikiMed/kiwix-js-wikimed_<<numeric_tag>>-E_i386.deb)
|
||||
|
||||
There is no installation required for the Portable versions. NONE of these builds auto-update (yet). Installation instructions are after the screenshot.
|
||||
|
||||
@ -25,11 +25,11 @@ There is no installation required for the Portable versions. NONE of these build
|
||||
|
||||
### Instructions:
|
||||
|
||||
* For the Windows Portable build, unzip the contents of the [Kiwix JS WikiMed <<base_tag>>.zip archive](https://github.com/kiwix/kiwix-js-windows/releases/download/v<<base_tag>>-WikiMed/Kiwix.JS.WikiMed.<<base_tag>>.zip) archive to any folder, or to a flash drive / thumb drive, and double click on `Start Kiwix JS WikiMed` or `Start Kiwix JS WikiMed.bat`, or open the `kiwix-js-windows-win32-ia32` folder and double click on `Kiwix JS WikiMed.exe`.
|
||||
* For the Windows Portable build, unzip the contents of the [Kiwix JS WikiMed <<base_tag>>.zip archive](https://github.com/kiwix/kiwix-js-pwa/releases/download/v<<base_tag>>-WikiMed/Kiwix.JS.WikiMed.<<base_tag>>.zip) archive to any folder, or to a flash drive / thumb drive, and double click on `Start Kiwix JS WikiMed` or `Start Kiwix JS WikiMed.bat`, or open the `kiwix-js-pwa-win32-ia32` folder and double click on `Kiwix JS WikiMed.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 Kiwix.JS.WikiMed*.AppImage` and then `./Kiwix.JS.WikiMed*.AppImage`. On **Debian**, you will probably need to add the `--no-sandbox` switch to the command like this `./Kiwix.JS.WikiMed*.AppImage --no-sandbox` (see https://github.com/electron/electron/issues/17972#issuecomment-516957971). On **OpenSUSE**, you may need to use these commandline switches instead: `./Kiwix.JS.WikiMed*.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 [Kiwix JS WikiMed Setup <<numeric_tag>>-E.exe](https://github.com/kiwix/kiwix-js-windows/releases/download/v<<base_tag>>-WikiMed/Kiwix.JS.WikiMed.Setup.<<numeric_tag>>-E.exe) which is digitally signed.
|
||||
* 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 [Kiwix JS WikiMed Setup <<numeric_tag>>-E.exe](https://github.com/kiwix/kiwix-js-pwa/releases/download/v<<base_tag>>-WikiMed/Kiwix.JS.WikiMed.Setup.<<numeric_tag>>-E.exe) which is digitally signed.
|
||||
|
||||
¹ With many thanks to Jay Midura for documenting the switches needed for OpenSUSE.
|
||||
|
||||
@ -46,4 +46,4 @@ There is no installation required for the Portable versions. NONE of these build
|
||||
|
||||
* 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 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.
|
||||
* Please see https://github.com/kiwix/kiwix-js-pwa/issues for further known issues. If you find a new issue, please open a new issue on that page.
|
||||
|
||||
@ -4,7 +4,7 @@ WikiMed by Kiwix is an offline medical encyclopaedia with content curated by [MD
|
||||
|
||||
|
||||
|
||||
These custom apps are packaged with the <<date>> English-language WikiMed archive `<<zim>>`. They will run on 32bit and 64bit editions of Windows or Linux (tested on Ubuntu, Debian, Fedora and OpenSUSE). 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](https://kiwix.github.io/kiwix-js-windows/kiwix-js-nwjs.html) and download the latest WikiMed archive from within the app.
|
||||
These custom apps are packaged with the <<date>> English-language WikiMed archive `<<zim>>`. They will run on 32bit and 64bit editions of Windows or Linux (tested on Ubuntu, Debian, Fedora and OpenSUSE). 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](https://kiwix.github.io/kiwix-js-pwa/kiwix-js-nwjs.html) and download the latest WikiMed archive from within the app.
|
||||
|
||||
**MS Store status: IN CERTIFICATION**
|
||||
**Winget status: IN CERTIFICATION**
|
||||
@ -13,11 +13,11 @@ Please choose the correct version:
|
||||
|
||||
* **Linux** (installation instructions below):
|
||||
- **Portable (Electron)**
|
||||
+ AppImage 64bit (Ubuntu, Debian, Fedora, OpenSUSE) - [WikiMed-by-Kiwix-<<numeric_tag>>-E.AppImage](https://github.com/kiwix/kiwix-js-windows/releases/download/v<<base_tag>>-WikiMed/WikiMed-by-Kiwix-<<numeric_tag>>-E.AppImage)
|
||||
+ AppImage 32bit (Ubuntu, Debian, Fedora, OpenSUSE) - [WikiMed-by-Kiwix-<<numeric_tag>>-E-i386.AppImage](https://github.com/kiwix/kiwix-js-windows/releases/download/v<<base_tag>>-WikiMed/WikiMed-by-Kiwix-<<numeric_tag>>-E-i386.AppImage)
|
||||
+ AppImage 64bit (Ubuntu, Debian, Fedora, OpenSUSE) - [WikiMed-by-Kiwix-<<numeric_tag>>-E.AppImage](https://github.com/kiwix/kiwix-js-pwa/releases/download/v<<base_tag>>-WikiMed/WikiMed-by-Kiwix-<<numeric_tag>>-E.AppImage)
|
||||
+ AppImage 32bit (Ubuntu, Debian, Fedora, OpenSUSE) - [WikiMed-by-Kiwix-<<numeric_tag>>-E-i386.AppImage](https://github.com/kiwix/kiwix-js-pwa/releases/download/v<<base_tag>>-WikiMed/WikiMed-by-Kiwix-<<numeric_tag>>-E-i386.AppImage)
|
||||
- **Installable (Electron)**
|
||||
+ Deb package 64bit (Ubuntu, Debian) - [kiwix-js-wikimed_<<numeric_tag>>-E_amd64.deb](https://github.com/kiwix/kiwix-js-windows/releases/download/v<<base_tag>>-WikiMed/kiwix-js-wikimed_<<numeric_tag>>-E_amd64.deb)
|
||||
+ Deb package 32bit (Ubuntu, Debian) - [kiwix-js-wikimed_<<numeric_tag>>-E_i386.deb](https://github.com/kiwix/kiwix-js-windows/releases/download/v<<base_tag>>-WikiMed/kiwix-js-wikimed_<<numeric_tag>>-E_i386.deb)
|
||||
+ Deb package 64bit (Ubuntu, Debian) - [kiwix-js-wikimed_<<numeric_tag>>-E_amd64.deb](https://github.com/kiwix/kiwix-js-pwa/releases/download/v<<base_tag>>-WikiMed/kiwix-js-wikimed_<<numeric_tag>>-E_amd64.deb)
|
||||
+ Deb package 32bit (Ubuntu, Debian) - [kiwix-js-wikimed_<<numeric_tag>>-E_i386.deb](https://github.com/kiwix/kiwix-js-pwa/releases/download/v<<base_tag>>-WikiMed/kiwix-js-wikimed_<<numeric_tag>>-E_i386.deb)
|
||||
|
||||
* **Windows**:
|
||||
- **Store app for Windows 10/11 (UWP)** - _recommended_ (self-updates)
|
||||
@ -25,16 +25,16 @@ Please choose the correct version:
|
||||
+ Or, on a PC, open a command prompt and run `winget install wikimed -s msstore`
|
||||
+ Or, if you cannot use the Store, sideload a signed package with `winget install kiwix.wikimed` - upgrade easily by running `winget upgrade kiwix.wikimed`
|
||||
- **Installable (Electron)**
|
||||
+ Windows 10/11 64bit - [WikiMed-by-Kiwix-<<numeric_tag>>-E.appx](https://github.com/kiwix/kiwix-js-windows/releases/download/v<<base_tag>>-WikiMed/WikiMed-by-Kiwix-<<numeric_tag>>-E.appx) - new, modern install / uninstall
|
||||
+ Windows 7/8/10/11 32bit (also runs on 64bit) - [WikiMed-by-Kiwix-Setup-<<numeric_tag>>-E.exe](https://github.com/kiwix/kiwix-js-windows/releases/download/v<<base_tag>>-WikiMed/WikiMed-by-Kiwix-Setup-<<numeric_tag>>-E.exe) - traditional executable
|
||||
+ Windows 10/11 64bit - [WikiMed-by-Kiwix-<<numeric_tag>>-E.appx](https://github.com/kiwix/kiwix-js-pwa/releases/download/v<<base_tag>>-WikiMed/WikiMed-by-Kiwix-<<numeric_tag>>-E.appx) - new, modern install / uninstall
|
||||
+ Windows 7/8/10/11 32bit (also runs on 64bit) - [WikiMed-by-Kiwix-Setup-<<numeric_tag>>-E.exe](https://github.com/kiwix/kiwix-js-pwa/releases/download/v<<base_tag>>-WikiMed/WikiMed-by-Kiwix-Setup-<<numeric_tag>>-E.exe) - traditional executable
|
||||
+ Alternatively, run `winget install kiwix.wikimed.electron` in a Windows 10/11 Terminal
|
||||
- **Portable (Electron) - just unzip, no install needed**
|
||||
+ Windows 7/8/10/11 - [WikiMed-by-Kiwix-<<base_tag>>-E.zip](https://github.com/kiwix/kiwix-js-windows/releases/download/v<<base_tag>>-WikiMed/WikiMed-by-Kiwix-<<base_tag>>-E.zip)
|
||||
+ Windows 7/8/10/11 - [WikiMed-by-Kiwix-<<base_tag>>-E.zip](https://github.com/kiwix/kiwix-js-pwa/releases/download/v<<base_tag>>-WikiMed/WikiMed-by-Kiwix-<<base_tag>>-E.zip)
|
||||
|
||||
## Installation Instructions - Electron
|
||||
|
||||
* For the Windows 64bit or 32bit installable builds, 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 Windows Portable build, unzip the contents of the [WikiMed-by-Kiwix-<<base_tag>>-E.zip](https://github.com/kiwix/kiwix-js-windows/releases/download/v<<base_tag>>-WikiMed/WikiMed-by-Kiwix-<<base_tag>>-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 Portable build, unzip the contents of the [WikiMed-by-Kiwix-<<base_tag>>-E.zip](https://github.com/kiwix/kiwix-js-pwa/releases/download/v<<base_tag>>-WikiMed/WikiMed-by-Kiwix-<<base_tag>>-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-pwa-win32-ia32` folder and double click on `WikiMed by Kiwix.exe`.
|
||||
* **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 a terminal and run `chmod a+x WikiMed-by-Kiwix*.AppImage` and then `./WikiMed-by-Kiwix*.AppImage`.
|
||||
+ On **_Debian_**, if you you have issues running the AppImage on older versions of the OS, you can try adding the `--no-sandbox` switch to the command (see https://github.com/electron/electron/issues/17972#issuecomment-516957971). This is not necessary on recent versions.
|
||||
+ On **OpenSUSE** you may need to install Chrome in order to get the dependencies necessary to run the AppImage (because Electron apps run Chrome internally). With **_older_** versions of OpenSUSE, you may additionally need to use these commandline switches: `./WikiMed-by-Kiwix*.AppImage --use-gl=disabled --disable-gpu-compositing`,¹ but this is no longer necessary in recent versions.
|
||||
@ -60,10 +60,10 @@ Please choose the correct version:
|
||||
### Known Issues
|
||||
|
||||
* **Printing**: In Electron apps, no preview is available prior to printing: we recommend you print to PDF first and then print the PDF, or use the PWA instead for printing (which has print preview). Before printing, ensure all sections you want to print are open (if you closed them).
|
||||
* 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.
|
||||
* Please see https://github.com/kiwix/kiwix-js-pwa/issues for further known issues. If you find a new issue, please open a new issue on that page.
|
||||
|
||||
## Instructions for sideloading (UWP)
|
||||
|
||||
You can sideload the app easily by typing `winget install kiwix.wikimed` in a Command Prompt or PowerShell terminal (Windows 10 or 11). This will download and install the Electron-based appx. If you want to install the legacy UWP appxbundle based on EdgeHTML, then simply download the appxbundle (see below) and double click it. The app installer should launch and will let you install it.
|
||||
|
||||
For Windows Mobile or for sideloading manually, please download [KiwixWebAppWikiMed_<<base_tag>>.0_AnyCPU.appxbundle](https://github.com/kiwix/kiwix-js-windows/releases/download/v<<base_tag>>-WikiMed/KiwixWebAppWikiMed_<<base_tag>>.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/main/AppPackages#readme.
|
||||
For Windows Mobile or for sideloading manually, please download [KiwixWebAppWikiMed_<<base_tag>>.0_AnyCPU.appxbundle](https://github.com/kiwix/kiwix-js-pwa/releases/download/v<<base_tag>>-WikiMed/KiwixWebAppWikiMed_<<base_tag>>.0_AnyCPU.appxbundle) and the zipped PowerShell script from Assets below. Then follow the detailed instructions at https://github.com/kiwix/kiwix-js-pwa/tree/main/AppPackages#readme.
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
|
||||
|
||||
|
||||
These custom apps are packaged with the <<date>> English-language Wikivoyage archive `<<zim>>`. 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](https://kiwix.github.io/kiwix-js-windows/kiwix-js-nwjs.html) and download the latest Wikivoyage archive from within the app.
|
||||
These custom apps are packaged with the <<date>> English-language Wikivoyage archive `<<zim>>`. 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](https://kiwix.github.io/kiwix-js-pwa/kiwix-js-nwjs.html) and download the latest Wikivoyage archive from within the app.
|
||||
|
||||
**MS Store status: IN CERTIFICATION**
|
||||
**Winget status: IN CERTIFICATION**
|
||||
@ -15,25 +15,25 @@ Please choose the correct version (only the Store version will self update):
|
||||
+ Or, on a PC, open a command prompt and run `winget install wikivoyage -s msstore` (self-updates)
|
||||
+ Or, if you cannot use the Store, sideload a signed package with `winget install kiwix.wikivoyage` - this doesn't auto-update, but you can upgrade easily by running `winget upgrade` or `winget upgrade --all`
|
||||
- **Portable (Electron) - just unzip, no install needed**
|
||||
+ Windows 7/8/10/11: [Wikivoyage-by-Kiwix-<<base_tag>>-E.zip](https://github.com/kiwix/kiwix-js-windows/releases/download/v<<base_tag>>-Wikivoyage/Wikivoyage-by-Kiwix-<<base_tag>>-E.zip)
|
||||
+ Windows 7/8/10/11: [Wikivoyage-by-Kiwix-<<base_tag>>-E.zip](https://github.com/kiwix/kiwix-js-pwa/releases/download/v<<base_tag>>-Wikivoyage/Wikivoyage-by-Kiwix-<<base_tag>>-E.zip)
|
||||
- **Installable (Electron)**
|
||||
+ Windows 7/8/10/11 - [Wikivoyage-by-Kiwix-Setup-<<numeric_tag>>-E.exe](https://github.com/kiwix/kiwix-js-windows/releases/download/v<<base_tag>>-Wikivoyage/Wikivoyage-by-Kiwix-Setup-<<numeric_tag>>-E.exe)
|
||||
+ Windows 7/8/10/11 - [Wikivoyage-by-Kiwix-Setup-<<numeric_tag>>-E.exe](https://github.com/kiwix/kiwix-js-pwa/releases/download/v<<base_tag>>-Wikivoyage/Wikivoyage-by-Kiwix-Setup-<<numeric_tag>>-E.exe)
|
||||
+ Alternatively, run `winget install kiwix.wikivoyage.electron` in a Windows 10/11 Terminal
|
||||
* **Linux** (read important instructions below screenshot):
|
||||
- **Portable (Electron)**
|
||||
+ AppImage 64bit (Ubuntu, Debian, OpenSUSE) - [Wikivoyage-by-Kiwix-<<numeric_tag>>-E.AppImage](https://github.com/kiwix/kiwix-js-windows/releases/download/v<<base_tag>>-Wikivoyage/Wikivoyage-by-Kiwix-<<numeric_tag>>-E.AppImage)
|
||||
+ AppImage 32bit (Ubuntu, Debian, OpenSUSE) - [Wikivoyage-by-Kiwix-<<numeric_tag>>-E-i386.AppImage](https://github.com/kiwix/kiwix-js-windows/releases/download/v<<base_tag>>-Wikivoyage/Wikivoyage-by-Kiwix-<<numeric_tag>>-E-i386.AppImage)
|
||||
+ AppImage 64bit (Ubuntu, Debian, OpenSUSE) - [Wikivoyage-by-Kiwix-<<numeric_tag>>-E.AppImage](https://github.com/kiwix/kiwix-js-pwa/releases/download/v<<base_tag>>-Wikivoyage/Wikivoyage-by-Kiwix-<<numeric_tag>>-E.AppImage)
|
||||
+ AppImage 32bit (Ubuntu, Debian, OpenSUSE) - [Wikivoyage-by-Kiwix-<<numeric_tag>>-E-i386.AppImage](https://github.com/kiwix/kiwix-js-pwa/releases/download/v<<base_tag>>-Wikivoyage/Wikivoyage-by-Kiwix-<<numeric_tag>>-E-i386.AppImage)
|
||||
- **Installable (Electron)**
|
||||
+ Deb package 64bit (Ubuntu, Debian) - [kiwix-js-wikivoyage_<<numeric_tag>>-E_amd64.deb](https://github.com/kiwix/kiwix-js-windows/releases/download/v<<base_tag>>-Wikivoyage/kiwix-js-wikivoyage_<<numeric_tag>>-E_amd64.deb)
|
||||
+ Deb package 32bit (Ubuntu, Debian) - [kiwix-js-wikivoyage_<<numeric_tag>>-E_i386.deb](https://github.com/kiwix/kiwix-js-windows/releases/download/v<<base_tag>>-Wikivoyage/kiwix-js-wikivoyage_<<numeric_tag>>-E_i386.deb)
|
||||
+ Deb package 64bit (Ubuntu, Debian) - [kiwix-js-wikivoyage_<<numeric_tag>>-E_amd64.deb](https://github.com/kiwix/kiwix-js-pwa/releases/download/v<<base_tag>>-Wikivoyage/kiwix-js-wikivoyage_<<numeric_tag>>-E_amd64.deb)
|
||||
+ Deb package 32bit (Ubuntu, Debian) - [kiwix-js-wikivoyage_<<numeric_tag>>-E_i386.deb](https://github.com/kiwix/kiwix-js-pwa/releases/download/v<<base_tag>>-Wikivoyage/kiwix-js-wikivoyage_<<numeric_tag>>-E_i386.deb)
|
||||
|
||||
## Installation Instructions - Electron
|
||||
|
||||
* For the Windows Portable build, unzip the contents of the [Wikivoyage-by-Kiwix-<<base_tag>>-E.zip](https://github.com/kiwix/kiwix-js-windows/releases/download/v<<base_tag>>-Wikivoyage/Wikivoyage-by-Kiwix-<<base_tag>>-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 Portable build, unzip the contents of the [Wikivoyage-by-Kiwix-<<base_tag>>-E.zip](https://github.com/kiwix/kiwix-js-pwa/releases/download/v<<base_tag>>-Wikivoyage/Wikivoyage-by-Kiwix-<<base_tag>>-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-pwa-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 https://github.com/electron/electron/issues/17972#issuecomment-516957971). 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-<<numeric_tag>>-E.exe](https://github.com/kiwix/kiwix-js-windows/releases/download/v<<base_tag>>-Wikivoyage/Wikivoyage-by-Kiwix-Setup-<<numeric_tag>>-E.exe) which is digitally signed.
|
||||
* 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-<<numeric_tag>>-E.exe](https://github.com/kiwix/kiwix-js-pwa/releases/download/v<<base_tag>>-Wikivoyage/Wikivoyage-by-Kiwix-Setup-<<numeric_tag>>-E.exe) which is digitally signed.
|
||||
|
||||
¹ With many thanks to Jay Midura for documenting the switches needed for OpenSUSE.
|
||||
|
||||
@ -51,10 +51,10 @@ Please choose the correct version (only the Store version will self update):
|
||||
|
||||
* 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.
|
||||
* Please see https://github.com/kiwix/kiwix-js-pwa/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 download [KiwixWebAppWikivoyage_<<base_tag>>.0_AnyCPU.appxbundle](https://github.com/kiwix/kiwix-js-windows/releases/download/v<<base_tag>>-Wikivoyage/KiwixWebAppWikivoyage_<<base_tag>>.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/main/AppPackages#readme.
|
||||
For Windows Mobile or for sideloading manually, please download [KiwixWebAppWikivoyage_<<base_tag>>.0_AnyCPU.appxbundle](https://github.com/kiwix/kiwix-js-pwa/releases/download/v<<base_tag>>-Wikivoyage/KiwixWebAppWikivoyage_<<base_tag>>.0_AnyCPU.appxbundle) and the zipped PowerShell script from Assets below. Then follow the detailed instructions at https://github.com/kiwix/kiwix-js-pwa/tree/main/AppPackages#readme.
|
||||
|
||||
@ -4,7 +4,7 @@ Wikiovyage by Kiwix is an offline travel guide featuring more than 31,000 destin
|
||||
|
||||
|
||||
|
||||
These custom apps are packaged with the <<date>> English-language Wikivoyage archive `<<zim>>`. They will run on 32bit and 64bit editions of Windows or Linux (tested on Ubuntu, Debian, Fedora and OpenSUSE). 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](https://kiwix.github.io/kiwix-js-windows/kiwix-js-nwjs.html) and download the latest Wikivoyage archive from within the app.
|
||||
These custom apps are packaged with the <<date>> English-language Wikivoyage archive `<<zim>>`. They will run on 32bit and 64bit editions of Windows or Linux (tested on Ubuntu, Debian, Fedora and OpenSUSE). 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](https://kiwix.github.io/kiwix-js-pwa/kiwix-js-nwjs.html) and download the latest Wikivoyage archive from within the app.
|
||||
|
||||
**MS Store status: IN CERTIFICATION**
|
||||
**Winget status: IN CERTIFICATION**
|
||||
@ -13,11 +13,11 @@ Please choose the correct version:
|
||||
|
||||
* **Linux** (installation instructions below):
|
||||
- **Portable (Electron)**
|
||||
+ AppImage 64bit (Ubuntu, Debian, Fedora, OpenSUSE) - [Wikivoyage-by-Kiwix-<<numeric_tag>>-E.AppImage](https://github.com/kiwix/kiwix-js-windows/releases/download/v<<base_tag>>-Wikivoyage/Wikivoyage-by-Kiwix-<<numeric_tag>>-E.AppImage)
|
||||
+ AppImage 32bit (Ubuntu, Debian, Fedora, OpenSUSE) - [Wikivoyage-by-Kiwix-<<numeric_tag>>-E-i386.AppImage](https://github.com/kiwix/kiwix-js-windows/releases/download/v<<base_tag>>-Wikivoyage/Wikivoyage-by-Kiwix-<<numeric_tag>>-E-i386.AppImage)
|
||||
+ AppImage 64bit (Ubuntu, Debian, Fedora, OpenSUSE) - [Wikivoyage-by-Kiwix-<<numeric_tag>>-E.AppImage](https://github.com/kiwix/kiwix-js-pwa/releases/download/v<<base_tag>>-Wikivoyage/Wikivoyage-by-Kiwix-<<numeric_tag>>-E.AppImage)
|
||||
+ AppImage 32bit (Ubuntu, Debian, Fedora, OpenSUSE) - [Wikivoyage-by-Kiwix-<<numeric_tag>>-E-i386.AppImage](https://github.com/kiwix/kiwix-js-pwa/releases/download/v<<base_tag>>-Wikivoyage/Wikivoyage-by-Kiwix-<<numeric_tag>>-E-i386.AppImage)
|
||||
- **Installable (Electron)**
|
||||
+ Deb package 64bit (Ubuntu, Debian) - [kiwix-js-wikivoyage_<<numeric_tag>>-E_amd64.deb](https://github.com/kiwix/kiwix-js-windows/releases/download/v<<base_tag>>-Wikivoyage/kiwix-js-wikivoyage_<<numeric_tag>>-E_amd64.deb)
|
||||
+ Deb package 32bit (Ubuntu, Debian) - [kiwix-js-wikivoyage_<<numeric_tag>>-E_i386.deb](https://github.com/kiwix/kiwix-js-windows/releases/download/v<<base_tag>>-Wikivoyage/kiwix-js-wikivoyage_<<numeric_tag>>-E_i386.deb)
|
||||
+ Deb package 64bit (Ubuntu, Debian) - [kiwix-js-wikivoyage_<<numeric_tag>>-E_amd64.deb](https://github.com/kiwix/kiwix-js-pwa/releases/download/v<<base_tag>>-Wikivoyage/kiwix-js-wikivoyage_<<numeric_tag>>-E_amd64.deb)
|
||||
+ Deb package 32bit (Ubuntu, Debian) - [kiwix-js-wikivoyage_<<numeric_tag>>-E_i386.deb](https://github.com/kiwix/kiwix-js-pwa/releases/download/v<<base_tag>>-Wikivoyage/kiwix-js-wikivoyage_<<numeric_tag>>-E_i386.deb)
|
||||
|
||||
* **Windows**:
|
||||
- **Store app for Windows 10/11** - _recommended_ (self-updates)
|
||||
@ -25,23 +25,23 @@ Please choose the correct version:
|
||||
+ Or, on a PC, open a command prompt and run `winget install wikivoyage -s msstore`
|
||||
+ Or, if you cannot use the Store, sideload a signed package with `winget install kiwix.wikivoyage` - upgrade easily by running `winget upgrade wikivoyage`
|
||||
- **Installable (Electron)**
|
||||
+ Windows 10/11 64bit - [Wikivoyage-by-Kiwix-<<numeric_tag>>-E.appx](https://github.com/kiwix/kiwix-js-windows/releases/download/v<<base_tag>>-Wikivoyage/Wikivoyage-by-Kiwix-<<numeric_tag>>-E.appx) - new, modern install / uninstall
|
||||
+ Windows 7/8/10/11 32bit (also runs on 64bit) - [Wikivoyage-by-Kiwix-Setup-<<numeric_tag>>-E.exe](https://github.com/kiwix/kiwix-js-windows/releases/download/v<<base_tag>>-Wikivoyage/Wikivoyage-by-Kiwix-Setup-<<numeric_tag>>-E.exe) - traditional executable
|
||||
+ Windows 10/11 64bit - [Wikivoyage-by-Kiwix-<<numeric_tag>>-E.appx](https://github.com/kiwix/kiwix-js-pwa/releases/download/v<<base_tag>>-Wikivoyage/Wikivoyage-by-Kiwix-<<numeric_tag>>-E.appx) - new, modern install / uninstall
|
||||
+ Windows 7/8/10/11 32bit (also runs on 64bit) - [Wikivoyage-by-Kiwix-Setup-<<numeric_tag>>-E.exe](https://github.com/kiwix/kiwix-js-pwa/releases/download/v<<base_tag>>-Wikivoyage/Wikivoyage-by-Kiwix-Setup-<<numeric_tag>>-E.exe) - traditional executable
|
||||
+ Alternatively, run `winget install kiwix.wikivoyage.electron` in a Windows 10/11 Terminal
|
||||
- **Portable (Electron) - just unzip, no install needed**
|
||||
+ Windows 7/8/10/11: [Wikivoyage-by-Kiwix-<<base_tag>>-E.zip](https://github.com/kiwix/kiwix-js-windows/releases/download/v<<base_tag>>-Wikivoyage/Wikivoyage-by-Kiwix-<<base_tag>>-E.zip)
|
||||
+ Windows 7/8/10/11: [Wikivoyage-by-Kiwix-<<base_tag>>-E.zip](https://github.com/kiwix/kiwix-js-pwa/releases/download/v<<base_tag>>-Wikivoyage/Wikivoyage-by-Kiwix-<<base_tag>>-E.zip)
|
||||
|
||||
## Installation Instructions - Electron
|
||||
|
||||
* For the Windows 64bit or 32bit installable builds, 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 Windows Portable build, unzip the contents of the [Wikivoyage-by-Kiwix-<<base_tag>>-E.zip](https://github.com/kiwix/kiwix-js-windows/releases/download/v<<base_tag>>-Wikivoyage/Wikivoyage-by-Kiwix-<<base_tag>>-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 Portable build, unzip the contents of the [Wikivoyage-by-Kiwix-<<base_tag>>-E.zip](https://github.com/kiwix/kiwix-js-pwa/releases/download/v<<base_tag>>-Wikivoyage/Wikivoyage-by-Kiwix-<<base_tag>>-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-pwa-win32-ia32` folder and double click on `Wikivoyage by Kiwix.exe`.
|
||||
* **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 a terminal and run `chmod a+x Wikivoyage-by-Kiwix*.AppImage` and then `./Wikivoyage-by-Kiwix*.AppImage`.
|
||||
+ On **_Debian_**, if you have issues running the AppImage on older versions of the OS, you can try adding the `--no-sandbox` switch to the command (see https://github.com/electron/electron/issues/17972#issuecomment-516957971). This is not necessary on recent versions.
|
||||
+ On **_OpenSUSE_**, you may need to install Chrome in order to get the dependencies necessary to run the AppImage (because Electron apps run Chrome internally). With **_older_** versions of OpenSUSE, you may additionally need to use these commandline switches: `./Wikivoyage-by-Kiwix*.AppImage --use-gl=disabled --disable-gpu-compositing`,¹ but this is no longer necessary in recent versions.
|
||||
* **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-get update` followed by `chmod a+x ./kiwix-js-wikivoyage*.deb`, then `sudo apt install ./kiwix-js-wikivoyage*.deb`. To run the app from the command line, rather than from its installed icon, simply type `kiwix-js-wikivoyage` in terminal. On **Debian**, if you receive the error `libgbm.so.1: cannot open shared object file`, please run `sudo apt install libgbm-dev`. On older versions of Debian, you may have to add `--no-sandbox` to the command line when running the app, i.e. `kiwix-js-wikivoyage --no-sandbox`. When you want to update, just install the new version, and it will install over the old version.
|
||||
+ For **OpenSUSE** and **Fedora**, it may be easiest to extract the files from the AppImage instead of using the Deb package. The executable is `kiwix-js-wikivoyage` and on older versions of OpenSUSE 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-<<numeric_tag>>-E.exe](https://github.com/kiwix/kiwix-js-windows/releases/download/v<<base_tag>>-Wikivoyage/Wikivoyage-by-Kiwix-Setup-<<numeric_tag>>-E.exe) which is digitally signed.
|
||||
* 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-<<numeric_tag>>-E.exe](https://github.com/kiwix/kiwix-js-pwa/releases/download/v<<base_tag>>-Wikivoyage/Wikivoyage-by-Kiwix-Setup-<<numeric_tag>>-E.exe) which is digitally signed.
|
||||
|
||||
¹ With many thanks to Jay Midura for documenting the switches needed for OpenSUSE.
|
||||
|
||||
@ -60,10 +60,10 @@ Please choose the correct version:
|
||||
### Known Issues
|
||||
|
||||
* **Printing**: In Electron apps, no preview is available prior to printing: we recommend you print to PDF first and then print the PDF, or use the PWA instead for printing (which has print preview). Before printing, ensure all sections you want to print are open (if you closed them).
|
||||
* 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.
|
||||
* Please see https://github.com/kiwix/kiwix-js-pwa/issues for further known issues. If you find a new issue, please open a new issue on that page.
|
||||
|
||||
## Instructions for sideloading (UWP)
|
||||
|
||||
You can sideload the app easily by typing `winget install kiwix.wikivoyage` in a Command Prompt or PowerShell terminal (Windows 10 or 11). This will download and install the Electron-based appx. If you want to install the legacy UWP appxbundle based on EdgeHTML, then simply download the appxbundle (see below) and double click it. The app installer should launch and will let you install it.
|
||||
|
||||
For Windows Mobile or for sideloading manually, please download [KiwixWebAppWikivoyage_<<base_tag>>.0_AnyCPU.appxbundle](https://github.com/kiwix/kiwix-js-windows/releases/download/v<<base_tag>>-Wikivoyage/KiwixWebAppWikivoyage_<<base_tag>>.0_AnyCPU.appxbundle) and (for desktop systems) the zipped PowerShell script from Assets below. Then follow the detailed instructions at https://github.com/kiwix/kiwix-js-windows/tree/main/AppPackages#readme.
|
||||
For Windows Mobile or for sideloading manually, please download [KiwixWebAppWikivoyage_<<base_tag>>.0_AnyCPU.appxbundle](https://github.com/kiwix/kiwix-js-pwa/releases/download/v<<base_tag>>-Wikivoyage/KiwixWebAppWikivoyage_<<base_tag>>.0_AnyCPU.appxbundle) and (for desktop systems) the zipped PowerShell script from Assets below. Then follow the detailed instructions at https://github.com/kiwix/kiwix-js-pwa/tree/main/AppPackages#readme.
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
## Portable and installable builds of Kiwix JS for Windows XP/Vista/7/8/10/11 and Linux
|
||||
|
||||
This is **not** the UWP/Microsoft Store build. If you are using Windows 10 or 11, we strongly recommend [the Kiwix JS UWP release](https://kiwix.github.io/kiwix-js-windows/kiwix-js-uwp.html), which will keep itself up-to-date automatically. These portable and installable versions run on the included [Electron platform](https://www.electronjs.org/) version 16.0.2 and [NWJS](https://nwjs.io/) 0.59.1 (Win7/8/10/11) or 0.14.7 (XP/Vista).
|
||||
This is **not** the UWP/Microsoft Store build. If you are using Windows 10 or 11, we strongly recommend [the Kiwix JS UWP release](https://kiwix.github.io/kiwix-js-pwa/kiwix-js-uwp.html), which will keep itself up-to-date automatically. These portable and installable versions run on the included [Electron platform](https://www.electronjs.org/) version 16.0.2 and [NWJS](https://nwjs.io/) 0.59.1 (Win7/8/10/11) or 0.14.7 (XP/Vista).
|
||||
|
||||
These builds are packaged with the <<date>> sample ZIM of the top 100 Wikipedia articles in English, `<<zim>>`. They will run on 32bit and 64bit editions of Windows or Linux (tested on Ubuntu, Debian and OpenSUSE - but see instructions below).
|
||||
|
||||
@ -8,18 +8,18 @@ Choose the correct build:
|
||||
|
||||
* **Windows**:
|
||||
- **Portable** (just unzip, no install needed)
|
||||
+ Windows 7/8/10/11 - [kiwix_js_windows-<<numeric_tag>>N-win-ia32.zip](https://github.com/kiwix/kiwix-js-windows/releases/download/v<<base_tag>>/kiwix_js_windows-<<numeric_tag>>N-win-ia32.zip) (NWJS)
|
||||
+ Windows XP/Vista - [kiwix_js_windows-XP-<<numeric_tag>>N-win-ia32.zip](https://github.com/kiwix/kiwix-js-windows/releases/download/v<<base_tag>>/kiwix_js_windows-XP-<<numeric_tag>>N-win-ia32.zip) (NWJS)
|
||||
+ Windows 7/8/10/11 - [kiwix_js_windows-<<numeric_tag>>N-win-ia32.zip](https://github.com/kiwix/kiwix-js-pwa/releases/download/v<<base_tag>>/kiwix_js_windows-<<numeric_tag>>N-win-ia32.zip) (NWJS)
|
||||
+ Windows XP/Vista - [kiwix_js_windows-XP-<<numeric_tag>>N-win-ia32.zip](https://github.com/kiwix/kiwix-js-pwa/releases/download/v<<base_tag>>/kiwix_js_windows-XP-<<numeric_tag>>N-win-ia32.zip) (NWJS)
|
||||
- **Installable** (signed NSIS installer)
|
||||
+ Windows 7/8/10/11 - [Kiwix JS Electron Setup <<numeric_tag>>-E.exe](https://github.com/kiwix/kiwix-js-windows/releases/download/v<<base_tag>>/Kiwix.JS.Electron.Setup.<<numeric_tag>>-E.exe) (Electron)
|
||||
+ Windows 7/8/10/11 - [Kiwix JS Electron Setup <<numeric_tag>>-E.exe](https://github.com/kiwix/kiwix-js-pwa/releases/download/v<<base_tag>>/Kiwix.JS.Electron.Setup.<<numeric_tag>>-E.exe) (Electron)
|
||||
+ Alternatively, run `winget install kiwix.kiwixjs.electron` in a Windows 10/11 Terminal
|
||||
* **Linux** (please read instructions below screenshot):
|
||||
- **Portable**
|
||||
+ AppImage 64bit (Ubuntu, Debian, OpenSUSE) - [Kiwix JS Electron-<<numeric_tag>>-E.AppImage](https://github.com/kiwix/kiwix-js-windows/releases/download/v<<base_tag>>/Kiwix.JS.Electron-<<numeric_tag>>-E.AppImage) (Electron)
|
||||
+ AppImage 32bit (Ubuntu, Debian, OpenSUSE) - [Kiwix JS Electron-<<numeric_tag>>-E-i386.AppImage](https://github.com/kiwix/kiwix-js-windows/releases/download/v<<base_tag>>/Kiwix.JS.Electron-<<numeric_tag>>-E-i386.AppImage) (Electron)
|
||||
+ AppImage 64bit (Ubuntu, Debian, OpenSUSE) - [Kiwix JS Electron-<<numeric_tag>>-E.AppImage](https://github.com/kiwix/kiwix-js-pwa/releases/download/v<<base_tag>>/Kiwix.JS.Electron-<<numeric_tag>>-E.AppImage) (Electron)
|
||||
+ AppImage 32bit (Ubuntu, Debian, OpenSUSE) - [Kiwix JS Electron-<<numeric_tag>>-E-i386.AppImage](https://github.com/kiwix/kiwix-js-pwa/releases/download/v<<base_tag>>/Kiwix.JS.Electron-<<numeric_tag>>-E-i386.AppImage) (Electron)
|
||||
- **Installable**
|
||||
+ Deb package 64bit (Ubuntu, Debian) - [kiwix-js-electron_<<numeric_tag>>-E_amd64.deb](https://github.com/kiwix/kiwix-js-windows/releases/download/v<<base_tag>>/kiwix-js-electron_<<numeric_tag>>-E_amd64.deb) (Electron)
|
||||
+ Deb package 32bit (Ubuntu, Debian) - [kiwix-js-electron_<<numeric_tag>>-E_i386.deb](https://github.com/kiwix/kiwix-js-windows/releases/download/v<<base_tag>>/kiwix-js-electron_<<numeric_tag>>-E_i386.deb) (Electron)
|
||||
+ Deb package 64bit (Ubuntu, Debian) - [kiwix-js-electron_<<numeric_tag>>-E_amd64.deb](https://github.com/kiwix/kiwix-js-pwa/releases/download/v<<base_tag>>/kiwix-js-electron_<<numeric_tag>>-E_amd64.deb) (Electron)
|
||||
+ Deb package 32bit (Ubuntu, Debian) - [kiwix-js-electron_<<numeric_tag>>-E_i386.deb](https://github.com/kiwix/kiwix-js-pwa/releases/download/v<<base_tag>>/kiwix-js-electron_<<numeric_tag>>-E_i386.deb) (Electron)
|
||||
|
||||
There is no installation required for the Portable versions. NONE of these builds auto-update (yet). Installation instructions are after the screenshot.
|
||||
|
||||
@ -27,11 +27,11 @@ There is no installation required for the Portable versions. NONE of these build
|
||||
|
||||
### Instructions:
|
||||
|
||||
* For the Windows Portable build, unzip the contents of the [kiwix_js_windows-<<base_tag>>-win-ia32.zip](https://github.com/kiwix/kiwix-js-windows/releases/download/v<<base_tag>>/kiwix_js_windows-<<numeric_tag>>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 Portable build, unzip the contents of the [kiwix_js_windows-<<base_tag>>-win-ia32.zip](https://github.com/kiwix/kiwix-js-pwa/releases/download/v<<base_tag>>/kiwix_js_windows-<<numeric_tag>>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. 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 Kiwix.JS.Electron*.AppImage` and then `./Kiwix.JS.Electron*.AppImage`. On **Debian**, you will probably need to add the `--no-sandbox` switch to the command like this `./Kiwix.JS.Electron*.AppImage --no-sandbox` (see https://github.com/electron/electron/issues/17972#issuecomment-516957971). On **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, 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. 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-electron` 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 [Kiwix JS Electron Setup <<numeric_tag>>-E.exe](https://github.com/kiwix/kiwix-js-windows/releases/download/v<<base_tag>>/Kiwix.JS.Electron.Setup.<<numeric_tag>>-E.exe) which is digitally signed.
|
||||
* 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 [Kiwix JS Electron Setup <<numeric_tag>>-E.exe](https://github.com/kiwix/kiwix-js-pwa/releases/download/v<<base_tag>>/Kiwix.JS.Electron.Setup.<<numeric_tag>>-E.exe) which is digitally signed.
|
||||
|
||||
¹ With many thanks to Jay Midura for documenting the switches needed for OpenSUSE.
|
||||
|
||||
@ -50,4 +50,4 @@ There is no installation required for the Portable versions. NONE of these build
|
||||
* On the XP build with some recent ZIMs (not the packaged one), __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__;
|
||||
* 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;
|
||||
* 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.
|
||||
* Please see https://github.com/kiwix/kiwix-js-pwa/issues for further known issues. If you find a new issue, please open a new issue on that page.
|
||||
|
||||
@ -1,10 +1,10 @@
|
||||
## This is a portable build of Kiwix JS NWJS for any 32bit or 64bit edition of Windows
|
||||
|
||||
This is **not** the UWP/Microsoft Store build. If you are using **Windows 10**, you may prefer to use [the release for the Microsoft Store](https://kiwix.github.io/kiwix-js-windows/kiwix-js-uwp.html), which is smaller and faster to load. This version runs on the [NWJS platform](https://nwjs.io/) (which is very similar to ElectronJS, but supports older versions of Windows). The package does **not** auto-update (whereas the Store version does). Please choose the correct build as follows:
|
||||
This is **not** the UWP/Microsoft Store build. If you are using **Windows 10**, you may prefer to use [the release for the Microsoft Store](https://kiwix.github.io/kiwix-js-pwa/kiwix-js-uwp.html), which is smaller and faster to load. This version runs on the [NWJS platform](https://nwjs.io/) (which is very similar to ElectronJS, but supports older versions of Windows). The package does **not** auto-update (whereas the Store version does). Please choose the correct build as follows:
|
||||
|
||||
For Windows XP or Windows Vista: [`kiwix_js_windows-XP-<<base_tag>>-win-ia32.zip`](https://github.com/kiwix/kiwix-js-windows/releases/download/v<<base_tag>>/kiwix_js_windows-XP-<<base_tag>>-win-ia32.zip)
|
||||
For Windows 7,8,10 32bit: [`kiwix_js_windows-<<base_tag>>-win-ia32.zip`](https://github.com/kiwix/kiwix-js-windows/releases/download/v<<base_tag>>/kiwix_js_windows-<<base_tag>>-win-ia32.zip)
|
||||
For Windows 7,8,10 64bit: [`kiwix_js_windows-<<base_tag>>-win-x64.zip`](https://github.com/kiwix/kiwix-js-windows/releases/download/v<<base_tag>>/kiwix_js_windows-<<base_tag>>-win-x64.zip)
|
||||
For Windows XP or Windows Vista: [`kiwix_js_windows-XP-<<base_tag>>-win-ia32.zip`](https://github.com/kiwix/kiwix-js-pwa/releases/download/v<<base_tag>>/kiwix_js_windows-XP-<<base_tag>>-win-ia32.zip)
|
||||
For Windows 7,8,10 32bit: [`kiwix_js_windows-<<base_tag>>-win-ia32.zip`](https://github.com/kiwix/kiwix-js-pwa/releases/download/v<<base_tag>>/kiwix_js_windows-<<base_tag>>-win-ia32.zip)
|
||||
For Windows 7,8,10 64bit: [`kiwix_js_windows-<<base_tag>>-win-x64.zip`](https://github.com/kiwix/kiwix-js-pwa/releases/download/v<<base_tag>>/kiwix_js_windows-<<base_tag>>-win-x64.zip)
|
||||
|
||||
If you have a modern Windows and do not know if your system is 64bit or 32bit, choose the 32bit (ia32) build.
|
||||
|
||||
|
||||
@ -4,7 +4,7 @@ Kiwix is an offline browser of archival content from Wikipedia, Project Gutenber
|
||||
|
||||
|
||||
|
||||
To use this app, download your choice of free content in-app from the Download Library on the Configuration page. There is only a small **sample** archive provided in the UWP, Electron and NWJS versions (`<<zim>>`, <<date>>). For what's new, see the changes listed in the [CHANGELOG](https://github.com/kiwix/kiwix-js-windows/blob/main/CHANGELOG.md). Builds are provided for 32bit and 64bit editions of Windows and Linux (tested on Ubuntu, Debian, Fedora and OpenSUSE).
|
||||
To use this app, download your choice of free content in-app from the Download Library on the Configuration page. There is only a small **sample** archive provided in the UWP, Electron and NWJS versions (`<<zim>>`, <<date>>). For what's new, see the changes listed in the [CHANGELOG](https://github.com/kiwix/kiwix-js-pwa/blob/main/CHANGELOG.md). Builds are provided for 32bit and 64bit editions of Windows and Linux (tested on Ubuntu, Debian, Fedora and OpenSUSE).
|
||||
|
||||
**MS Store status: IN CERTIFICATION**
|
||||
**Winget status: IN CERTIFICATION**
|
||||
@ -16,13 +16,13 @@ Please choose the correct version (those marked [**AUTO**] will self-update auto
|
||||
|
||||
* **Linux** (see installation instructions below screenshot):
|
||||
- **Portable (Electron)** - *recommended*
|
||||
+ AppImage 64bit (Ubuntu, Debian, Fedora, OpenSUSE): [Kiwix-JS-Electron-<<numeric_tag>>-E.AppImage](https://github.com/kiwix/kiwix-js-windows/releases/download/v<<base_tag>>/Kiwix-JS-Electron-<<numeric_tag>>-E.AppImage) [**AUTO**]
|
||||
+ AppImage 32bit (Ubuntu, Debian, Fedora, OpenSUSE): [Kiwix-JS-Electron-<<numeric_tag>>-E-i386.AppImage](https://github.com/kiwix/kiwix-js-windows/releases/download/v<<base_tag>>/Kiwix-JS-Electron-<<numeric_tag>>-E-i386.AppImage) [**AUTO**]
|
||||
+ AppImage 64bit (Ubuntu, Debian, Fedora, OpenSUSE): [Kiwix-JS-Electron-<<numeric_tag>>-E.AppImage](https://github.com/kiwix/kiwix-js-pwa/releases/download/v<<base_tag>>/Kiwix-JS-Electron-<<numeric_tag>>-E.AppImage) [**AUTO**]
|
||||
+ AppImage 32bit (Ubuntu, Debian, Fedora, OpenSUSE): [Kiwix-JS-Electron-<<numeric_tag>>-E-i386.AppImage](https://github.com/kiwix/kiwix-js-pwa/releases/download/v<<base_tag>>/Kiwix-JS-Electron-<<numeric_tag>>-E-i386.AppImage) [**AUTO**]
|
||||
- **Installable (Electron)**
|
||||
+ Deb package 64bit (Ubuntu, Debian): [kiwix-js-electron_<<numeric_tag>>-E_amd64.deb](https://github.com/kiwix/kiwix-js-windows/releases/download/v<<base_tag>>/kiwix-js-electron_<<numeric_tag>>-E_amd64.deb)
|
||||
+ Deb package 32bit (Ubuntu, Debian): [kiwix-js-electron_<<numeric_tag>>-E_i386.deb](https://github.com/kiwix/kiwix-js-windows/releases/download/v<<base_tag>>/kiwix-js-electron_<<numeric_tag>>-E_i386.deb)
|
||||
+ RPM package 64bit (Fedora, OpenSUSE): [kiwix-js-electron-<<numeric_tag>>-E.x86_64.rpm](https://github.com/kiwix/kiwix-js-windows/releases/download/v<<base_tag>>/kiwix-js-electron-<<numeric_tag>>-E.x86_64.rpm)
|
||||
+ RPM package 32bit (Fedora, OpenSUSE): [kiwix-js-electron-<<numeric_tag>>-E.i686.rpm](https://github.com/kiwix/kiwix-js-windows/releases/download/v<<base_tag>>/kiwix-js-electron-<<numeric_tag>>-E.i686.rpm)
|
||||
+ Deb package 64bit (Ubuntu, Debian): [kiwix-js-electron_<<numeric_tag>>-E_amd64.deb](https://github.com/kiwix/kiwix-js-pwa/releases/download/v<<base_tag>>/kiwix-js-electron_<<numeric_tag>>-E_amd64.deb)
|
||||
+ Deb package 32bit (Ubuntu, Debian): [kiwix-js-electron_<<numeric_tag>>-E_i386.deb](https://github.com/kiwix/kiwix-js-pwa/releases/download/v<<base_tag>>/kiwix-js-electron_<<numeric_tag>>-E_i386.deb)
|
||||
+ RPM package 64bit (Fedora, OpenSUSE): [kiwix-js-electron-<<numeric_tag>>-E.x86_64.rpm](https://github.com/kiwix/kiwix-js-pwa/releases/download/v<<base_tag>>/kiwix-js-electron-<<numeric_tag>>-E.x86_64.rpm)
|
||||
+ RPM package 32bit (Fedora, OpenSUSE): [kiwix-js-electron-<<numeric_tag>>-E.i686.rpm](https://github.com/kiwix/kiwix-js-pwa/releases/download/v<<base_tag>>/kiwix-js-electron-<<numeric_tag>>-E.i686.rpm)
|
||||
|
||||
* **Windows**:
|
||||
- **Store app for Windows 10/11 (UWP)** - *recommended* [**AUTO**]
|
||||
@ -30,14 +30,14 @@ Please choose the correct version (those marked [**AUTO**] will self-update auto
|
||||
+ Or, on a PC, open a Terminal (or command prompt) and run `winget install 'kiwix js' -s msstore`
|
||||
+ Or, if you cannot use the Store, sideload a signed package with `winget install kiwix.kiwixjs` - this doesn't auto-update, but you can upgrade easily by running `winget upgrade kiwix.kiwixjs`
|
||||
- **Installable (Electron)**
|
||||
+ Windows 10/11 64bit - [Kiwix-JS-Electron-<<numeric_tag>>-E.appx](https://github.com/kiwix/kiwix-js-windows/releases/download/v<<base_tag>>/Kiwix-JS-Electron-<<numeric_tag>>-E.appx) - new, modern install / uninstall
|
||||
+ Windows 7/8/10/11: [Kiwix-JS-Electron-Setup-<<numeric_tag>>-E.exe](https://github.com/kiwix/kiwix-js-windows/releases/download/v<<base_tag>>/Kiwix-JS-Electron-Setup-<<numeric_tag>>-E.exe) [**AUTO**]
|
||||
+ Windows 10/11 64bit - [Kiwix-JS-Electron-<<numeric_tag>>-E.appx](https://github.com/kiwix/kiwix-js-pwa/releases/download/v<<base_tag>>/Kiwix-JS-Electron-<<numeric_tag>>-E.appx) - new, modern install / uninstall
|
||||
+ Windows 7/8/10/11: [Kiwix-JS-Electron-Setup-<<numeric_tag>>-E.exe](https://github.com/kiwix/kiwix-js-pwa/releases/download/v<<base_tag>>/Kiwix-JS-Electron-Setup-<<numeric_tag>>-E.exe) [**AUTO**]
|
||||
+ Alternatively, run `winget install kiwix.kiwixjs.electron` in a Windows 10/11 Terminal [**AUTO**]
|
||||
- **Portable - no install needed**
|
||||
+ **_WARNING:_** Windows **XP** or **Vista** **only** (legacy version): [kiwix_js_windows-XP-<<base_tag>>-N-win-ia32.zip](https://github.com/kiwix/kiwix-js-windows/releases/download/v<<base_tag>>/kiwix_js_windows-XP-<<base_tag>>-N-win-ia32.zip) - **do not use this with modern Windows!**
|
||||
+ Windows 7/8/10/11: self-contained **portable** version, no unzip needed - [Kiwix-JS-Electron-<<numeric_tag>>-E.exe](https://github.com/kiwix/kiwix-js-windows/releases/download/v<<base_tag>>/Kiwix-JS-Electron-<<numeric_tag>>-E.exe) (if you find this version slow to launch, try the Setup version above, or a zipped version below)
|
||||
+ [Electron] Windows 7/8/10/11: just unzip to any drive or folder - [Kiwix-JS-Electron-<<numeric_tag>>-E.zip](https://github.com/kiwix/kiwix-js-windows/releases/download/v<<base_tag>>/Kiwix-JS-Electron-<<numeric_tag>>-E.zip)
|
||||
+ [NWJS] Windows 7/8/10/11: just unzip to any drive or folder - [kiwix_js_windows-<<base_tag>>-N-win-ia32.zip](https://github.com/kiwix/kiwix-js-windows/releases/download/v<<base_tag>>/kiwix_js_windows-<<base_tag>>-N-win-ia32.zip)
|
||||
+ **_WARNING:_** Windows **XP** or **Vista** **only** (legacy version): [kiwix_js_windows-XP-<<base_tag>>-N-win-ia32.zip](https://github.com/kiwix/kiwix-js-pwa/releases/download/v<<base_tag>>/kiwix_js_windows-XP-<<base_tag>>-N-win-ia32.zip) - **do not use this with modern Windows!**
|
||||
+ Windows 7/8/10/11: self-contained **portable** version, no unzip needed - [Kiwix-JS-Electron-<<numeric_tag>>-E.exe](https://github.com/kiwix/kiwix-js-pwa/releases/download/v<<base_tag>>/Kiwix-JS-Electron-<<numeric_tag>>-E.exe) (if you find this version slow to launch, try the Setup version above, or a zipped version below)
|
||||
+ [Electron] Windows 7/8/10/11: just unzip to any drive or folder - [Kiwix-JS-Electron-<<numeric_tag>>-E.zip](https://github.com/kiwix/kiwix-js-pwa/releases/download/v<<base_tag>>/Kiwix-JS-Electron-<<numeric_tag>>-E.zip)
|
||||
+ [NWJS] Windows 7/8/10/11: just unzip to any drive or folder - [kiwix_js_windows-<<base_tag>>-N-win-ia32.zip](https://github.com/kiwix/kiwix-js-pwa/releases/download/v<<base_tag>>/kiwix_js_windows-<<base_tag>>-N-win-ia32.zip)
|
||||
|
||||
|
||||
|
||||
@ -78,10 +78,10 @@ Please choose the correct version (those marked [**AUTO**] will self-update auto
|
||||
* In the **NWJS app** only, YouTube-based videos in **Zimit archives** do not play with sound (this does not affect other archives such as TED Talks or Khan Academy).
|
||||
* Image manipulation (e.g. saving image to disk) does not currently work with the **NWJS app**.
|
||||
* On the **XP build** with some recent ZIMs __there is a CSS error in rendering image-heavy landing pages__, 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__.
|
||||
* Please see https://github.com/kiwix/kiwix-js-windows/issues for further known issues. If you find a problem not reported there, please open a new issue on that page.
|
||||
* Please see https://github.com/kiwix/kiwix-js-pwa/issues for further known issues. If you find a problem not reported there, please open a new issue on that page.
|
||||
|
||||
## Instructions for sideloading (UWP)
|
||||
|
||||
You can sideload the UWP app easily by typing `winget install kiwix.kiwixjs` in a Command Prompt or PowerShell terminal (Windows 10/11). This will download and install the Electron-based appx. If you want to install the legacy UWP appxbundle based on EdgeHTML, then simply download the appxbundle (see below) and double click it. The app installer should launch and will let you install it.
|
||||
|
||||
For Windows Mobile or for sideloading manually, please download [KiwixWebApp_<<base_tag>>.0_AnyCPU.appxbundle](https://github.com/kiwix/kiwix-js-windows/releases/download/v<<base_tag>>/KiwixWebApp_<<base_tag>>.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/main/AppPackages#readme.
|
||||
For Windows Mobile or for sideloading manually, please download [KiwixWebApp_<<base_tag>>.0_AnyCPU.appxbundle](https://github.com/kiwix/kiwix-js-pwa/releases/download/v<<base_tag>>/KiwixWebApp_<<base_tag>>.0_AnyCPU.appxbundle) and the zipped PowerShell script from Assets below. Then follow the detailed instructions at https://github.com/kiwix/kiwix-js-pwa/tree/main/AppPackages#readme.
|
||||
@ -17,7 +17,7 @@ if ($overridetarget) {
|
||||
$INPUT_TARGET = $overridetarget
|
||||
}
|
||||
$target = "/data/download/release/kiwix-js-electron"
|
||||
$win_target = "/data/download/release/kiwix-js-windows"
|
||||
$win_target = "/data/download/release/kiwix-js-pwa"
|
||||
$keyfile = "$PSScriptRoot\ssh_key"
|
||||
$keyfile = $keyfile -ireplace '[\\/]', '/'
|
||||
|
||||
@ -47,7 +47,7 @@ if (-not $CRON_LAUNCHED) {
|
||||
$GITHUB_TOKEN = Get-Content -Raw "$PSScriptRoot/github_token"
|
||||
}
|
||||
$draft_release_params = @{
|
||||
Uri = "https://api.github.com/repos/kiwix/kiwix-js-windows/releases"
|
||||
Uri = "https://api.github.com/repos/kiwix/kiwix-js-pwa/releases"
|
||||
Method = 'GET'
|
||||
Headers = @{
|
||||
'Authorization' = "token $GITHUB_TOKEN"
|
||||
|
||||
@ -19,7 +19,7 @@ param (
|
||||
)
|
||||
|
||||
# Provide parameters
|
||||
$release_uri = 'https://api.github.com/repos/kiwix/kiwix-js-windows/actions/workflows/publish-docker.yaml/dispatches'
|
||||
$release_uri = 'https://api.github.com/repos/kiwix/kiwix-js-pwa/actions/workflows/publish-docker.yaml/dispatches'
|
||||
|
||||
$app_params = Select-String 'appVersion' "$PSScriptRoot\..\www\js\init.js" -List
|
||||
$serviceworker = Select-String 'appVersion' "$PSScriptRoot\..\service-worker.js" -List
|
||||
|
||||
@ -35,7 +35,7 @@ function Main {
|
||||
exit 1
|
||||
}
|
||||
$release_params = @{
|
||||
Uri = "https://api.github.com/repos/kiwix/kiwix-js-windows/releases"
|
||||
Uri = "https://api.github.com/repos/kiwix/kiwix-js-pwa/releases"
|
||||
Method = 'GET'
|
||||
Headers = @{
|
||||
'Authorization' = "token $GITHUB_TOKEN"
|
||||
@ -115,10 +115,10 @@ function Main {
|
||||
|
||||
# If the path is a file of the right type, ask for confirmation
|
||||
if ((Test-Path $filename -PathType leaf) -and ($filename -imatch '(.*)\.(?:appx|appxbundle|appxupload)$')) {
|
||||
$newfilename = $filename -ireplace '^.*\\[^\d]+([\d.]+?)\.0_[^\d]+?(\.appx(?:bundle|upload))$', 'kiwix-js-windows_$1$2'
|
||||
$newfilename = $filename -ireplace '^.*\\[^\d]+([\d.]+?)\.0_[^\d]+?(\.appx(?:bundle|upload))$', 'kiwix-js-pwa_$1$2'
|
||||
$filename = $filename -ireplace '[\\/]', '/'
|
||||
$file = $filename -ireplace '^.*/([^/]+$)', '$1'
|
||||
$target = '/data/download/release/kiwix-js-windows'
|
||||
$target = '/data/download/release/kiwix-js-pwa'
|
||||
"$filename is ready to upload to $target ..."
|
||||
if ($dryrun) { "DRY RUN: no upload will be made" }
|
||||
if (! $yes) {
|
||||
|
||||
@ -32,7 +32,7 @@ if (-not $CRON_LAUNCHED) {
|
||||
$GITHUB_TOKEN = Get-Content -Raw "$PSScriptRoot/github_token"
|
||||
}
|
||||
$draft_release_params = @{
|
||||
Uri = "https://api.github.com/repos/kiwix/kiwix-js-windows/releases"
|
||||
Uri = "https://api.github.com/repos/kiwix/kiwix-js-pwa/releases"
|
||||
Method = 'GET'
|
||||
Headers = @{
|
||||
'Authorization' = "token $GITHUB_TOKEN"
|
||||
|
||||
@ -4,14 +4,14 @@
|
||||
<meta charset="utf-8">
|
||||
<title>Redirecting to latest WikiMed Electron release</title>
|
||||
<meta http-equiv="refresh"
|
||||
content="2; URL=https://github.com/kiwix/kiwix-js-windows/releases/tag/v2.7.4-WikiMed">
|
||||
content="2; URL=https://github.com/kiwix/kiwix-js-pwa/releases/tag/v2.7.4-WikiMed">
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<div style="max-width: 1240px; margin: 3em auto">
|
||||
<h1>Redirecting to latest WikiMed Electron release...</h1>
|
||||
<p>If your browser does not automatically redirect, please click on:</p>
|
||||
<p><a href="https://github.com/kiwix/kiwix-js-windows/releases/tag/v2.7.4-WikiMed">
|
||||
<p><a href="https://github.com/kiwix/kiwix-js-pwa/releases/tag/v2.7.4-WikiMed">
|
||||
Kiwix JS WikiMed Electron edition: releases
|
||||
</a>
|
||||
</p>
|
||||
|
||||
@ -4,14 +4,14 @@
|
||||
<meta charset="utf-8">
|
||||
<title>Redirecting to latest WikiMed UWP release</title>
|
||||
<meta http-equiv="refresh"
|
||||
content="2; URL=https://github.com/kiwix/kiwix-js-windows/releases/tag/v2.7.4-WikiMed">
|
||||
content="2; URL=https://github.com/kiwix/kiwix-js-pwa/releases/tag/v2.7.4-WikiMed">
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<div style="max-width: 1240px; margin: 3em auto">
|
||||
<h1>Redirecting to latest Kiwix JS WikiMed UWP release...</h1>
|
||||
<p>If your browser does not automatically redirect, please click on:</p>
|
||||
<p><a href="https://github.com/kiwix/kiwix-js-windows/releases/tag/v2.7.4-WikiMed">
|
||||
<p><a href="https://github.com/kiwix/kiwix-js-pwa/releases/tag/v2.7.4-WikiMed">
|
||||
Kiwix JS WikiMed UWP: releases
|
||||
</a>
|
||||
</p>
|
||||
|
||||
@ -4,14 +4,14 @@
|
||||
<meta charset="utf-8">
|
||||
<title>Redirecting to latest Wikivoyage Electron release</title>
|
||||
<meta http-equiv="refresh"
|
||||
content="2; URL=https://github.com/kiwix/kiwix-js-windows/releases/tag/v2.6.8-Wikivoyage">
|
||||
content="2; URL=https://github.com/kiwix/kiwix-js-pwa/releases/tag/v2.6.8-Wikivoyage">
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<div style="max-width: 1240px; margin: 3em auto">
|
||||
<h1>Redirecting to latest Wikivoyage Electron release...</h1>
|
||||
<p>If your browser does not automatically redirect, please click on:</p>
|
||||
<p><a href="https://github.com/kiwix/kiwix-js-windows/releases/tag/v2.6.8-Wikivoyage">
|
||||
<p><a href="https://github.com/kiwix/kiwix-js-pwa/releases/tag/v2.6.8-Wikivoyage">
|
||||
Wikivoyage by Kiwix Electron edition: releases
|
||||
</a>
|
||||
</p>
|
||||
|
||||
@ -4,14 +4,14 @@
|
||||
<meta charset="utf-8">
|
||||
<title>Redirecting to latest Wikivoyage by Kiwix (UWP) release</title>
|
||||
<meta http-equiv="refresh"
|
||||
content="2; URL=https://github.com/kiwix/kiwix-js-windows/releases/tag/v2.6.8-Wikivoyage">
|
||||
content="2; URL=https://github.com/kiwix/kiwix-js-pwa/releases/tag/v2.6.8-Wikivoyage">
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<div style="max-width: 1240px; margin: 3em auto">
|
||||
<h1>Redirecting to latest Wikivoyage by Kiwix (UWP) release...</h1>
|
||||
<p>If your browser does not automatically redirect, please click on:</p>
|
||||
<p><a href="https://github.com/kiwix/kiwix-js-windows/releases/tag/v2.6.8-Wikivoyage">
|
||||
<p><a href="https://github.com/kiwix/kiwix-js-pwa/releases/tag/v2.6.8-Wikivoyage">
|
||||
Kiwix JS Wikivoyage by Kiwix (UWP): releases
|
||||
</a>
|
||||
</p>
|
||||
|
||||
@ -5,7 +5,7 @@
|
||||
* Modified from https://userstyles.org/styles/47161/dark-wikipedia-rounded
|
||||
* In turn, the styles have been modified to work with Kiwix JS and Kiwix JS Windows.
|
||||
* The source file for this adapted version can be found at:
|
||||
* https://github.com/kiwix/kiwix-js-windows/
|
||||
* https://github.com/kiwix/kiwix-js-pwa/
|
||||
*
|
||||
* This CSS file is licensed with a CC-BY-SA Creative Commons Free Culture Licence:
|
||||
* https://creativecommons.org/licenses/by-sa/4.0/
|
||||
|
||||
@ -102,7 +102,7 @@
|
||||
<div id="update" class="update">
|
||||
<h3 style="margin-top:0;">Changes in version <span class="version">2.0</span></h3>
|
||||
<ul style="padding-left: 15px;">
|
||||
<li>For interim updates since v2.7.2, please see <a href="https://github.com/kiwix/kiwix-js-windows/blob/main/CHANGELOG.md" target="_blank">CHANGELOG</a></li>
|
||||
<li>For interim updates since v2.7.2, please see <a href="https://github.com/kiwix/kiwix-js-pwa/blob/main/CHANGELOG.md" target="_blank">CHANGELOG</a></li>
|
||||
<li>Rework file system access and support Origin Private File System (OPFS)</li>
|
||||
<li>Autoload and display of all archives in OPFS on app launch, no permission prompts!</li>
|
||||
<li>Last selected archive (and optionally article) auto-loaded on app launch if in OPFS</li>
|
||||
@ -119,7 +119,7 @@
|
||||
<li>Fixed failure to refresh full-screen state when clicking in-app in SW mode</li>
|
||||
<li>Sample archive updated to wikipedia_en_100_mini_2023-10</li>
|
||||
</ul>
|
||||
<p><a href="https://github.com/kiwix/kiwix-js-windows/blob/main/CHANGELOG.md" target="_blank" rel="noopener">And there's more...<img alt="external link" src="I/s/Icon_External_Link.png"></a></p>
|
||||
<p><a href="https://github.com/kiwix/kiwix-js-pwa/blob/main/CHANGELOG.md" target="_blank" rel="noopener">And there's more...<img alt="external link" src="I/s/Icon_External_Link.png"></a></p>
|
||||
</div>
|
||||
<div id="features">
|
||||
<h3>Features in Version 2.x</h3>
|
||||
@ -417,8 +417,8 @@
|
||||
<p>
|
||||
<b>Builds of this app are available that do not use a Store or an online Service Worker.</b> Please see:
|
||||
<ul>
|
||||
<li><a href="https://github.com/kiwix/kiwix-js-windows/releases" target="_blank">Releases</a></li>
|
||||
<li><a href="https://kiwix.github.io/kiwix-js-windows/kiwix-js-nwjs.html" target="_blank">NWJS version</a> - this version is completely standalone and will never self-update.</li>
|
||||
<li><a href="https://github.com/kiwix/kiwix-js-pwa/releases" target="_blank">Releases</a></li>
|
||||
<li><a href="https://kiwix.github.io/kiwix-js-pwa/kiwix-js-nwjs.html" target="_blank">NWJS version</a> - this version is completely standalone and will never self-update.</li>
|
||||
</ul>
|
||||
</p>
|
||||
<h3 id="filehandling">File handling and File System access</h3>
|
||||
@ -653,13 +653,13 @@
|
||||
<p>
|
||||
This application is still a work in progress. There are bugs that need fixing and improvements that
|
||||
need to be implemented. Suggestions and patches/pull requests are welcome: the source code is on
|
||||
<a href="https://github.com/kiwix/kiwix-js-windows" target="_blank">github</a>.
|
||||
The <a href="https://github.com/kiwix/kiwix-js-windows/issues" target="_blank">Kiwix JS <span class="identity">Windows</span> issue tracker</a>
|
||||
<a href="https://github.com/kiwix/kiwix-js-pwa" target="_blank">github</a>.
|
||||
The <a href="https://github.com/kiwix/kiwix-js-pwa/issues" target="_blank">Kiwix JS <span class="identity">Windows</span> issue tracker</a>
|
||||
is on GitHub too, though also check the <a href="https://github.com/kiwix/kiwix-js/issues"
|
||||
target="_blank">tracker for Kiwix JS</a> as a lot of the development is done for both apps.
|
||||
</p>
|
||||
<p>
|
||||
Alternatively, you can send your feedback <a href="mailto:egk10@cam.ac.uk?subject=%5BKiwix%5D%20Feedback%20about%20Kiwix-JS-Windows">
|
||||
Alternatively, you can send your feedback <a href="mailto:egk10@cam.ac.uk?subject=%5BKiwix%5D%20Feedback%20about%20kiwix-js-pwa">
|
||||
by email
|
||||
</a>.
|
||||
</p>
|
||||
|
||||
@ -1701,7 +1701,7 @@ document.getElementById('allowInternetAccessCheck').addEventListener('change', f
|
||||
var message;
|
||||
if (!/PWA/.test(params.appType)) {
|
||||
message = '<p>You are accessing Kiwix JS from a remote server, and it is not possible to disable Internet access fully without exiting the app.</p>' +
|
||||
'<p>Please visit <a href="https://kiwix.github.io/kiwix-js-windows/kiwix-js-electron.html" target="_blank">Kiwix JS UWP/Electron/NWJS</a> to find an app version that will run fully offline.</p>';
|
||||
'<p>Please visit <a href="https://kiwix.github.io/kiwix-js-pwa/kiwix-js-electron.html" target="_blank">Kiwix JS UWP/Electron/NWJS</a> to find an app version that will run fully offline.</p>';
|
||||
uiUtil.systemAlert(message);
|
||||
this.checked = true;
|
||||
params.allowInternetAccess = true;
|
||||
@ -3652,7 +3652,7 @@ function handleFileDrop (packet) {
|
||||
}
|
||||
}
|
||||
|
||||
function pickFileUWP () { // Support UWP FilePicker [kiwix-js-windows #3]
|
||||
function pickFileUWP () { // Support UWP FilePicker [kiwix-js-pwa #3]
|
||||
// Create the picker object and set options
|
||||
var filePicker = new Windows.Storage.Pickers.FileOpenPicker();
|
||||
filePicker.suggestedStartLocation = Windows.Storage.Pickers.PickerLocationId.downloads;
|
||||
@ -3765,7 +3765,7 @@ function processPickedFileUWP (file) {
|
||||
}
|
||||
}
|
||||
|
||||
function pickFolderUWP () { // Support UWP FilePicker [kiwix-js-windows #3]
|
||||
function pickFolderUWP () { // Support UWP FilePicker [kiwix-js-pwa #3]
|
||||
var folderPicker = new Windows.Storage.Pickers.FolderPicker();
|
||||
folderPicker.suggestedStartLocation = Windows.Storage.Pickers.PickerLocationId.downloads;
|
||||
folderPicker.fileTypeFilter.replaceAll(['.zim', '.dat', '.idx', '.txt', '.zimaa']);
|
||||
@ -4650,7 +4650,7 @@ function readArticle (dirEntry) {
|
||||
alertBoxHeader.style.display = 'none';
|
||||
// Set startup parameter to guard against boot loop
|
||||
if (settingsStore.getItem('lastPageLoad') !== 'rebooting') settingsStore.setItem('lastPageLoad', 'failed', Infinity);
|
||||
// Void the localSearch variable to prevent invalid DOM references remainining [kiwix-js-windows #56]
|
||||
// Void the localSearch variable to prevent invalid DOM references remainining [kiwix-js-pwa #56]
|
||||
localSearch = {};
|
||||
// Calculate the current article's ZIM baseUrl to use when processing relative links
|
||||
params.baseURL = encodeURI(dirEntry.namespace + '/' + dirEntry.url.replace(/[^/]+$/, ''));
|
||||
|
||||
@ -70,7 +70,7 @@ params['kiwixDownloadLink'] = 'https://download.kiwix.org/zim/'; // Include fina
|
||||
params['kiwixHiddenDownloadLink'] = 'https://master.download.kiwix.org/zim/';
|
||||
/** ***** DEV: ENSURE SERVERS BELOW ARE LISTED IN package.appxmanifest ************/
|
||||
params['PWAServer'] = 'https://pwa.kiwix.org/'; // Production server
|
||||
// params['PWAServer'] = 'https://kiwix.github.io/kiwix-js-windows/dist/'; // Test server
|
||||
// params['PWAServer'] = 'https://kiwix.github.io/kiwix-js-pwa/dist/'; // Test server
|
||||
params['storeType'] = getBestAvailableStorageAPI();
|
||||
params['appType'] = getAppType();
|
||||
params['keyPrefix'] = 'kiwixjs-'; // Prefix to use for localStorage keys
|
||||
|
||||
@ -545,7 +545,7 @@ function requestXhttpData (URL, lang, subj, kiwixDate) {
|
||||
URL.replace(/\.meta4$/, '.magnet') + '</a> (if torrent app doesn\'t launch, <a id="magnetAlt" href="#" target="_blank">tap here</a> and copy/paste link into your app)<br /></li></ul>\r\n';
|
||||
}
|
||||
if (megabytes > 4000 && /\.zim\.meta4$/i.test(URL)) {
|
||||
bodyDoc += '<p style="color:red;">If you plan to store this archive on a drive/microSD formatted as <b>FAT32</b> (most are not), then you will need to download the file on a PC and split it into chunks less than 4GB: see <a href="https://github.com/kiwix/kiwix-js-windows/tree/main/AppPackages#download-a-zim-archive-all-platforms" target="_blank">Download a ZIM archive</a>.</p>\r\n';
|
||||
bodyDoc += '<p style="color:red;">If you plan to store this archive on a drive/microSD formatted as <b>FAT32</b> (most are not), then you will need to download the file on a PC and split it into chunks less than 4GB: see <a href="https://github.com/kiwix/kiwix-js-pwa/tree/main/AppPackages#download-a-zim-archive-all-platforms" target="_blank">Download a ZIM archive</a>.</p>\r\n';
|
||||
// bodyDoc += '<p><b>To browse for a split version of this archive click here: <a id="portable" href="#" data-kiwix-dl="' +
|
||||
// URL.replace(/\/zim\/([^/]+\/).*$/m, "/portable/$1") + '">' + URL.replace(/\/zim\/([^/]+\/).*$/m, "/portable/$1") +
|
||||
// '</a>.</b></p>\r\n';
|
||||
|
||||
@ -30,7 +30,7 @@ import uiUtil from './uiUtil.js';
|
||||
* The update server configuration
|
||||
*/
|
||||
params.updateServer = {
|
||||
url: 'https://api.github.com/repos/kiwix/kiwix-js-windows/',
|
||||
url: 'https://api.github.com/repos/kiwix/kiwix-js-pwa/',
|
||||
releases: 'releases'
|
||||
};
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user