Skip to content

Web Version [available OFFLINE]

Jump to bottom
Eliran Wong edited this page Aug 26, 2021 · 19 revisions

Web Version

You can run our Web version on any devices which has a web browser. Offline running is supported.

It may be a good choice especially if you want to want the full UBA on your mobile devices. Read more below.

Options of Running UBA on Android / iOS

There are several options to run UBA on Android devices:

  1. Native Mobile App.
  1. Hybrid Version

  • Pros: Written as a cross-platform native app, designed to be extensible in terms of resources.

  • Cons: Still in development, may be postponed indefinitely due to new development of Web Version [described below].

  • Read more at: https://github.com/eliranwong/UniqueBibleAppHybrid

  1. Web Browser Version

  • Pros: Use the same resources and codes as the UBA desktop version. Can run offline on your mobile devices. Install on one device and access from any kinds of devices having a web browser. For example, run a copy on an Android phone, and give everyone in the same room to use the app.

  • Cons: Need a third-party app, e.g. Termux or iSH, to run UBA as a http-server.

The rest of this page describe how to set up UBA as a http-server on Android / iOS devices and run with a web browser.

Running UBA http-server via Termux [Android] / iSH [iOS]

"Termux is an Android terminal emulator and Linux environment application that works directly with no rooting or setup required." Read more about Termux at: https://wiki.termux.com/wiki/Main_Page

"iSH is a project to get a Linux shell environment running locally on your iOS device, using a usermode x86 emulator." Read more at: https://ish.app/

With Termux or iSH, you can simply run UBA http-server on mobile devices.

Remarks: There are several other options on Android, we recommend Termux for its simplicity.

Setup and startup on iOS / iPhone / iPad

https://github.com/eliranwong/UniqueBible/wiki/Running-UBA-server-on-iOS

There is a known issue that iSH is slows for database access.

Setup on Android

  1. Download "Termux" from standard Play Store.

  2. Open "Termux" app after installed.

  3. Run the following commands on your Termux app to get everything ready:

pkg install root-repo

pkg install python

pkg install git

git clone https://github.com/eliranwong/UniqueBible

Startup of UBA http-server

Open Termux and run:

Remarks: It takes time for one-off automatic setup the first time UBA is launched. UBA should start up much faster after the first run.

cd UniqueBible

python uba.py http-server & disown

(Note: We use "& disown" here so that the opened terminal session won't be prevented from new input.)

You should see something like this screenshot for the first run:

Run UBA on the same device

  1. Open a web browser

  2. Enter url 'http://localhost:8080'

Run UBA from other devices

Option 1 - manual entry

  1. Open a web browser

  2. Enter url 'http://:8080'

(In our screenshot example above, the url is http://192.168.167:8080)

Option 2 - QR code

  1. Generate a QR code from the device which has the UBA http-server running, by running '.myQRcode' command or click the '.myQRcode' link on help page.

  2. Use a QR code scanner from a client-device to scan the QR code to make connection.

Support both OFFline and ONline

You can use UBA web version both offline and online.

To use the web version offline, simply install UBA on your device (mobile, laptop or desktop) and access it with a web browser using http://localhost:8080

To share the installed app with other users. For example, you have your UBA installed on your phone, bring it to a bible study group, and inform others to connect to UBA on your phone using your phone ip or QRcode.

Copy marvelData folder from desktop to an Android phone

There are various ways to achieve this, below is an example:

(reference: https://wiki.termux.com/wiki/Termux-setup-storage)

  1. Run in Termux:

termux-setup-storage

  1. Select "Allow" to allow Termux to access phone storage

  2. Connect laptop to an Android phone with a USB cable

  3. Enable USB file transfer on your Android phone

  4. Copy marvelData folder to, for example, "downloads" folder

  5. Run in Termux:

cd ~

cd UniqueBible

mv marvelData marvelData_init

mv ~/storage/downloads/marvelData/ .

User Manual

English - https://www.uniquebible.app/web/english-manual

To Developers

If you run an UBA http-server for multiple-users, it is better to set both config.developer and config.webFullAccess to False for security reasons.

Otherwise, users can run _setconfig:::enableCmd:::True, which can cause trouble.

Or any users may stop your server at anytime if you set either config.developer or config.webFullAccess to True.

Clone this wiki locally