Difference between revisions of "Main Page"

From InkBox
Jump to navigation Jump to search
(Move onboard storage expansion to dedicated page)
 
(14 intermediate revisions by 2 users not shown)
Line 1: Line 1:
InkBox is an open-source, Qt-based eBook reader. It mainly comes in two versions: the normal ".adds" package and the InkBox OS package.
[[Category:InkBox]]
== What is InkBox?==
InkBox is an open-source, fully-functional standalone operating system for some Kobo and Kindle eReaders. It makes use of Alpine Linux 3.10 and a custom user interface based on the Qt framework. Here are some of its features:


== Where to get it ==
* Fully integrated KoBox X11 subsystem
=== InkBox OS ===
* ePUB, PDF, picture and plain text display support
Based on Alpine Linux 3.10, InkBox OS is currently available for:
* Versatile configuration options for reading
* muPDF rendering engine for ePUBs and PDFs
* Wi-Fi support and web browser
* Encrypted storage with EncFS
* Fast dictionary & local storage search
* Dark mode
* Full factory reset option if needed
* Seamless update process
* VNC viewer app
* Search function
* 10 built-in fonts
* Auto-suspend
* Lock screen/passcode
* User-friendly experience
 
== Currently Supported Devices ==
* Kobo Mini N705
* Kobo Mini N705
* Kobo Touch N905B
* Kobo Touch N905B
* Kobo Touch N905C
* Kobo Touch N905C
* Kobo Glo N613
* Kobo Glo N613
* Kobo Aura 2 (SE) N236
* Kobo Aura (2nd Edition) N236
* Kobo Glo HD N437
* Kobo Glo HD N437
* Kobo Nia N306
* Kobo Nia N306 (version A, see here: https://github.com/Kobo-InkBox/inkbox/issues/47)
==== Downloads ====
* Kobo Libra N873
Distribution images are available [http://23.163.0.39/bundles/inkbox/native/ here].
* Kindle Touch
To update InkBox, visit [http://23.163.0.39/bundles/inkbox/native/update/ this page].


==== Current development goals ====
== Installation ==
InkBox's main developer currently plans to extend support to the Kobo Clara HD.
Please note that we take [https://github.com/Kobo-InkBox/inkbox/blob/master/LEGAL.md '''no responsibility'''] should problems arise when you install InkBox on your device.
 
#[http://23.163.0.39/bundles/inkbox/native/ Download the latest distribution image] for your device.
#:To flash InkBox to your eReader we need access to the internal microSD card.
#:'''Warning:''' Be careful! There is a risk of causing '''physical damage''' to your device. When in doubt, search for disassembly guides online.
# Take off the back cover of your device and remove the internal microSD card. Confirm it has at least '''4GB''' capacity. Insert the card into your computer.
#:'''Warning:''' If you proceed with the next steps using this card, '''any data on your ereader will be permanently lost'''. To prevent this, you can make a '''full backup of the microSD card''' or '''use a different microSD card''' instead.
# Use [https://www.balena.io/etcher balenaEtcher] to flash the InkBox image file to the card.
# To setup InkBox, eject the microSD card from your PC and insert it in the ereader. Put the back cover on and power it on. It might take a while to boot, so be patient. Setting InkBox up is easy; just follow the instructions on the screen.
 
== Update ==
Once the install has been done, it is strongly recommended to update to the latest version if one is available.


=== Nickel add-on ===
[http://23.163.0.39/bundles/inkbox/native/update/ Download the latest release] for your device. Connect your ereader to your PC. Copy the <code>*.upd.isa</code> file to <code>[onboard storage]/.inkbox</code>, eject the device, then unplug the USB cable. InkBox should prompt you with an update dialog. Click on "Update". If you pressed "Cancel" by accident, you can continue by going to <code>Settings -> Page 2 -> Update</code>.
'''Warning''': Those packages are '''outdated''' and '''unmaintained''' (2022/02/13). If you still want to use them, they are available there: http://23.163.0.39/bundles/inkbox/nickel/base/
The Kobo will reboot and the update process will begin.


== Quick start ==
'''Note:''' If your Kobo gets stuck for longer than 2 minutes on the "Updating" screen and the dots no longer move, hold the power button for 10 seconds and restart the device. The update process should continue normally.
=== InkBox OS ===
Download the distribution image, then either flash it on a microSD card using [https://www.balena.io/etcher/ balenaEtcher] or <code>dd</code>, like this:
<pre>xzcat /path/to/inkbox.img.xz | dd of=/dev/mmcblk0</pre>
'''Note:''' the microSD card must have a capacity of '''at least 4GB'''.
=== Nickel add-on ===
Download the latest base package from there: http://23.163.0.39/bundles/inkbox/nickel/base/
Extract it in the root of your Kobo's onboard storage.


== Documentation ==
== Documentation ==
=== InkBox OS ===
A good place to learn about how InkBox works is the [[general information]] page.
A good start would be to read the [[general information]] page about InkBox.
See [[:Category:InkBox]] for all related documentation.
See [[:Category:InkBox]] for all related documentation.
=== Porting ===
See [[:Category:Porting]] for all documentation related to porting InkBox to new devices.
See [[:Category:Porting]] for all related documentation.
 
[[Category:InkBox]]
== Community ==
Join the official [https://matrix.to/#/#inkbox-os-project:matrix.org Matrix space] or [https://discord.com/invite/uSWtWbY23m Discord server] if you'd like to chat a bit.
 
== Current Development Goals ==
InkBox's main developer currently plans to extend support to the Kobo Clara HD.
Tolino devices that are rebranded Kobos might work with some images, or not.
 
== How to Help ==
Contributions to the the wiki and on [https://github.com/Kobo-InkBox/inkbox GitHub] are always welcome, as well as donations on [https://paypal.me/NicolasMailloux/ PayPal] or [https://liberapay.com/tux-linux/ LiberaPay].

Latest revision as of 20:13, 9 July 2023

What is InkBox?

InkBox is an open-source, fully-functional standalone operating system for some Kobo and Kindle eReaders. It makes use of Alpine Linux 3.10 and a custom user interface based on the Qt framework. Here are some of its features:

  • Fully integrated KoBox X11 subsystem
  • ePUB, PDF, picture and plain text display support
  • Versatile configuration options for reading
  • muPDF rendering engine for ePUBs and PDFs
  • Wi-Fi support and web browser
  • Encrypted storage with EncFS
  • Fast dictionary & local storage search
  • Dark mode
  • Full factory reset option if needed
  • Seamless update process
  • VNC viewer app
  • Search function
  • 10 built-in fonts
  • Auto-suspend
  • Lock screen/passcode
  • User-friendly experience

Currently Supported Devices

Installation

Please note that we take no responsibility should problems arise when you install InkBox on your device.

  1. Download the latest distribution image for your device.
    To flash InkBox to your eReader we need access to the internal microSD card.
    Warning: Be careful! There is a risk of causing physical damage to your device. When in doubt, search for disassembly guides online.
  2. Take off the back cover of your device and remove the internal microSD card. Confirm it has at least 4GB capacity. Insert the card into your computer.
    Warning: If you proceed with the next steps using this card, any data on your ereader will be permanently lost. To prevent this, you can make a full backup of the microSD card or use a different microSD card instead.
  3. Use balenaEtcher to flash the InkBox image file to the card.
  4. To setup InkBox, eject the microSD card from your PC and insert it in the ereader. Put the back cover on and power it on. It might take a while to boot, so be patient. Setting InkBox up is easy; just follow the instructions on the screen.

Update

Once the install has been done, it is strongly recommended to update to the latest version if one is available.

Download the latest release for your device. Connect your ereader to your PC. Copy the *.upd.isa file to [onboard storage]/.inkbox, eject the device, then unplug the USB cable. InkBox should prompt you with an update dialog. Click on "Update". If you pressed "Cancel" by accident, you can continue by going to Settings -> Page 2 -> Update. The Kobo will reboot and the update process will begin.

Note: If your Kobo gets stuck for longer than 2 minutes on the "Updating" screen and the dots no longer move, hold the power button for 10 seconds and restart the device. The update process should continue normally.

Documentation

A good place to learn about how InkBox works is the general information page. See Category:InkBox for all related documentation. See Category:Porting for all documentation related to porting InkBox to new devices.

Community

Join the official Matrix space or Discord server if you'd like to chat a bit.

Current Development Goals

InkBox's main developer currently plans to extend support to the Kobo Clara HD. Tolino devices that are rebranded Kobos might work with some images, or not.

How to Help

Contributions to the the wiki and on GitHub are always welcome, as well as donations on PayPal or LiberaPay.

Retrieved from "https://inkbox.ddns.net/wiki/index.php?title=Main_Page&oldid=225"