Difference between revisions of "InkBox GUI user apps"

From InkBox
Jump to navigation Jump to search
(Created page with "This page describes the internals of InkBox GUI's user apps feature.")
 
Line 1: Line 1:
This page describes the internals of InkBox GUI's user apps feature.
This page describes the internals of InkBox GUI's user applications feature.
== Description ==
This GUI feature permits the user to run digitally signed external Qt/FB applications available at https://23.163.0.39/bundles/inkbox/apps.<br>User applications in are executed in their own chroot jail, to prevent external access to parts of the filesystem and increase security. They are also mounted read-only, with some exceptions.
== Application package ==
=== Contents ===
App packages have the <code>.isa</code> extension. Signature files (digests) have the <code>.isa.dgst</code> extension. A standard application package layout will look like this:<pre>.
├── app-data
├── app-lib
│   └── libzip.so
├── dev
├── proc
├── sanki
├── sanki.bin
├── sanki.png
├── sys
└── system-lib</pre>
==== <code>app-data</code> ====
This directory contains the only read-write part of the extension package. It is actually a bind mount of the related path <code>.apps-data/<app-name></code> in the exported USB mass storage. Applications can store their user data, such as preferences, files and stats, there.<br>Applications can access this location at <code>/app-data</code>.
==== <code>app-lib</code> ====
This directory contains the libraries the application needs to have to function properly. If it is based on Qt, there is no need to bundle it in there, as it will be provided in the <b>system-lib</b> directory. In this example, the application requires <code>libzip.so</code>, so it has been put there. <code>LD_LIBRARY_PATH</code> environment variable is automatically adjusted by the main launch script.<br>Applications can access this location at <code>/app-lib</code>.
==== <code>dev</code> ====
This directory contains a mounted <code>devtmpfs</code> filesystem used by the chroot.
==== <code>proc</code> ====
This directory contains a mounted <code>proc</code> filesystem used by the chroot.
==== <code>sys</code> ====
This directory contains a mounted <code>sysfs</code> filesystem used by the chroot.
==== <code>system-lib</code> ====
This directory contains the system's Qt libs and are made available so that the application can launch.<br>Applications can access this location at <code>/system-lib</code>.
==== Other files ====
Those may include a main binary, a launch script and an application icon that will be read by the GUI.

Revision as of 11:57, 21 May 2022

This page describes the internals of InkBox GUI's user applications feature.

Description

This GUI feature permits the user to run digitally signed external Qt/FB applications available at https://23.163.0.39/bundles/inkbox/apps.
User applications in are executed in their own chroot jail, to prevent external access to parts of the filesystem and increase security. They are also mounted read-only, with some exceptions.

Application package

Contents

App packages have the .isa extension. Signature files (digests) have the .isa.dgst extension. A standard application package layout will look like this:

.
├── app-data
├── app-lib
│   └── libzip.so
├── dev
├── proc
├── sanki
├── sanki.bin
├── sanki.png
├── sys
└── system-lib

app-data

This directory contains the only read-write part of the extension package. It is actually a bind mount of the related path .apps-data/<app-name> in the exported USB mass storage. Applications can store their user data, such as preferences, files and stats, there.
Applications can access this location at /app-data.

app-lib

This directory contains the libraries the application needs to have to function properly. If it is based on Qt, there is no need to bundle it in there, as it will be provided in the system-lib directory. In this example, the application requires libzip.so, so it has been put there. LD_LIBRARY_PATH environment variable is automatically adjusted by the main launch script.
Applications can access this location at /app-lib.

dev

This directory contains a mounted devtmpfs filesystem used by the chroot.

proc

This directory contains a mounted proc filesystem used by the chroot.

sys

This directory contains a mounted sysfs filesystem used by the chroot.

system-lib

This directory contains the system's Qt libs and are made available so that the application can launch.
Applications can access this location at /system-lib.

Other files

Those may include a main binary, a launch script and an application icon that will be read by the GUI.