Skip to content

Commit 01b372d

Browse files
committed
Add instructions for macOS builds
1 parent 2b7cd88 commit 01b372d

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

scripts/Kiwix_JS_Windows_Release_Body.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,11 @@ Please choose the correct version (those marked [**AUTO**] will self-update auto
4242
+ [Electron] Windows 10/11 64bit: 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) (for 32bit or Win7+, plese use the Win7 installer above)
4343
+ [NWJS] Windows 10/11 64bit: just unzip to any drive or folder - [kiwix_js_windows-<<base_tag>>-N-win-x64.zip](https://github.com/kiwix/kiwix-js-pwa/releases/download/v<<base_tag>>/kiwix_js_windows-<<base_tag>>-N-win-x64.zip)
4444

45+
* **macOS** (Experimental, unsigned - _follow instructions below to run for first time_):
46+
- **Portable (Electron)** - *experimental*
47+
+ macOS 10.15+ Apple Silicon (M1/M2/M3): [Kiwix-JS-Electron-<<numeric_tag>>-E-arm64.zip](https://github.com/kiwix/kiwix-js-pwa/releases/download/v<<base_tag>>/Kiwix-JS-Electron-<<numeric_tag>>-E-arm64.zip) - *recommended for Apple Silicon Macs*
48+
+ macOS 10.15+ Intel (x64): [Kiwix-JS-Electron-<<numeric_tag>>-E-x64.zip](https://github.com/kiwix/kiwix-js-pwa/releases/download/v<<base_tag>>/Kiwix-JS-Electron-<<numeric_tag>>-E-x64.zip)
49+
4550
![Kiwix-Zimit-montage](https://user-images.githubusercontent.com/4304337/173221055-08fd27ba-5990-4e13-9286-c11e4595d43a.png)
4651

4752
## Installation Instructions - Electron/NWJS
@@ -58,6 +63,23 @@ Please choose the correct version (those marked [**AUTO**] will self-update auto
5863
+ **_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-electron*.deb`, then `sudo apt install ./kiwix-js-electron*.deb`. To run the app from the command line, rather than from its installed icon, simply type `kiwix-js-electron` 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-electron --no-sandbox`. When you want to update, just install the new version, and it will install over the old version.
5964
+ **_Fedora_**: download the correct `.rpm` package. You should be able to install it by opening the File manager, locating the package, and double-clicking it. Alternatively, open a terminal and `cd` to the directory with the package, and then type `sudo rpm --install ./kiwix-js-electron-*.rpm` (you may need to do `chmod a+x kiwix-js-electron-*.rpm` first). After install, you should find Kiwix JS Electron in your app list, and you can launch it from there. To upgrade, locate the newly downloaded package in terminal and type `sudo rpm --upgrade ./kiwix.js.electron-*.rpm` (ensure you specify the correct package number in place of `*` if you have more than one). If you find the app is stuck looking for an old sample package after upgrade, please just press the Reset button next to the version number at the top of Configuration.
6065
+ **_OpenSUSE_**: download the correct `.rpm` package. You may get a better installation experience if you first install Chrome or another Chromium browser, as the Electron app has the same dependencies as Chrome. Then open a Terminal with superuser privileges, navigate to the directory containing the `.rpm` package, and type `zypper install kiwix-js-electron-*.rpm` (you may need to do `chmod a+x kiwix-js-electron-*.rpm` first). If you are informed about missing dependencies, try "Solution 2: break kiwix-js-electron... by ignoring some of its dependencies'. You will also be warned that the app is not signed. You can ignore this, if you trust this repository. See above for commandline switches in older versions of OpenSUSE.
66+
* **For macOS builds**: Download the correct ZIP file for your Mac architecture (Apple Silicon or Intel). Extract the ZIP file to any location
67+
(e.g., Desktop or Applications folder). **These builds are unsigned and require additional steps to run**:
68+
1. **Extract** the application (`Kiwix JS Electron.app`) from the downloaded ZIP archive
69+
2. **Open Terminal** (Applications > Utilities > Terminal)
70+
3. **Remove quarantine flag** by running:
71+
```bash
72+
xattr -d com.apple.quarantine /path/to/Kiwix\ JS\ Electron.app
73+
```
74+
*(Replace `/path/to/` with the actual location where you extracted the app)*
75+
4. **Launch** the app by double-clicking it - it should now open normally
76+
+ **Architecture Selection:**
77+
+ **Apple Silicon Macs** (M1/M2/M3): Use the ARM64 version for optimal performance
78+
+ **Intel Macs**: Use the x64 version
79+
+ If unsure of your Mac's architecture, click the Apple menu > About This Mac - look for "Apple M1/M2/M3" (Apple Silicon) or "Intel" in the processor information
80+
+ **Security Note:** These are experimental unsigned builds. macOS will initially block them for security reasons. The Terminal command above is required for first launch. Future launches will work normally after completing these steps once.
81+
82+
* **Troubleshooting:** If you encounter issues, ensure you're using the correct architecture version for your Mac. The ARM64 version provides significantly better performance on Apple Silicon Macs.
6183

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

0 commit comments

Comments
 (0)