The Perfect BibleAnalyzer Experience on Any Distro

[nymusicman]

Updating Instructions. v5.6 is out of Beta.

Install Podman and Distrobox
Arch
https://wiki.archlinux.org/title/Podman

Code: Select all

sudo pacman -S podman distrobox

OpenSuse Tumbleweed

Code: Select all

sudo zypper in podman distrobox netavark

Fedora 39

Code: Select all

sudo dnf install podman distrobox

Debian 12

Code: Select all

sudo apt install -y podman distrobox

Steam Deck
As of 3.5 preview podman and Distrobox is now installed by default.

BA-5.6
As of SteamOS 3.6, distrobox has been upgraded to 1.6 and can now run a 24.04 container. Upgrading to 1.8 is unnecessary unless there are other fixes/features you want.
If you want to use BA-5.6 on Debian 12, Distrobox will need to be upgraded. You can learn more about upgrading here: https://github.com/89luca89/distrobox/b ... k_guide.md

Create Distrobox Container

Create Directory for BibleAnalyzer Home
I recommend using a "clean" home directory for your Ubuntu install. I put my in ~/.bibleanalyzercontainer/.

Code: Select all

mkdir ~/.bibleanalyzercontainer

Create the Container

Code: Select all

distrobox create --image ubuntu:24.04 --name bibleanalyzer --home ~/.bibleanalyzercontainer/

BA-5.5

Code: Select all

distrobox create --image ubuntu:jammy-20231004 --name bibleanalyzer --home ~/.bibleanalyzercontainer/

Finish Setup

Code: Select all

distrobox enter bibleanalyzer

From here stay in the distrobox container.

Allow Apt Sandbox as Root

Code: Select all

echo 'APT::Sandbox::User "root";' | sudo tee -a /etc/apt/apt.conf.d/10sandbox

Install Dependencies

Code: Select all

wget https://www.bibleanalyzer.com/bibleanalyzer_5.6-5_all.deb
sudo apt install ./bibleanalyzer_5.6-5_all.deb python3-lxml libcanberra-gtk-module libcanberra-gtk3-module -y

BA-5.5

Code: Select all

wget https://www.bibleanalyzer.com/bibleanalyzer_5.5-1_all.deb
sudo apt install ./bibleanalyzer_5.5-1_all.deb libopengl0 xapp libcanberra-gtk3-module appmenu-gtk3-module libwebkit2gtk-4.0-37 -y

Run Font Cache

Code: Select all

fc-cache -v

First Launch and Icon Creation
Run the command below and make sure you can open the Module Manager

Code: Select all

export XDG_DATA_DIRS=/usr/share/ubuntu:/usr/share/gnome:/usr/local/share/:/usr/share/ && bibleanalyzer

If something goes wrong...
See troubleshooting at bottom.

If all went well, create the shortcut (in container).

Code: Select all

distrobox-export --app bibleanalyzer

On the host system find and edit the BibleAnalyzer shortcut (should be something like bibleanalyzer-bibleanalyzer.desktop)

Code: Select all

~/.local/share/applications/bibleanalyzer-bibleanalyzer.desktop

In the editor of your choice find the line that says

Code: Select all

Exec=/usr/bin/distrobox-enter  -n bibleanalyzer --   python3 -u /opt/bibleanalyzer/ba-run.py

And change it to

Code: Select all

Exec=/usr/bin/distrobox-enter  -n bibleanalyzer --  /bin/bash -c "export XDG_DATA_DIRS=/usr/share/ubuntu:/usr/share/gnome:/usr/local/share/:/usr/share/ && python3 -u /opt/bibleanalyzer/ba-run.py"

And that's it... Enjoy BibleAnalyzer on Any Distro

Troubleshooting

If you see a message like: "Authorization required, but no authorization protocol specified
Unable to access the X Display, is $DISPLAY set properly?"
On the host machine enter this:

Code: Select all

xhost +"local:podman@"

I created a script named xhost.sh and since I run kde plasma I put it in ~/.config/plasma-workspace/env/xhost.sh

Code: Select all

touch ~/.config/plasma-workspace/env/xhost.sh

Open the new file in your favorite text editor and put in the below.

Code: Select all

#!/bin/sh
xhost +"local:podman@"

Save and exist your text editor and give the file the proper permissions with the below.

Code: Select all

chmod +x ~/.config/plasma-workspace/env/xhost.sh

If it says it cannot find .config/bibleanalyzer
In container

Code: Select all

cd ~
mkdir .config

It's taking a really long time to start up after clicking the menu link
I discovered that clicking the menu link also initiates an update of the image. You can follow this using

Code: Select all

podman logs -f bibleanalyzer

Once it's done it will open Bibleanalyzer just fine.

Error: command required for rootless mode with multiple IDs: exec: "newuidmap": executable file not found in $PATH
This error was found by zortmo in Debian and MXLinux.
The fix for Debian is to install rootlesskit to the host machine.

Code: Select all

sudo apt install -y rootlesskit

BibleAnalyzer is integrating a dark theme that does not look good.
I use Plasma with the Sweet-Dark theme. BibleAnalyzer respects the GTK theme that is set so I just added a GTK theme that is light to my launch command in the Desktop file. Please choose an installed GTK theme that best aligns with your system's light color. In my case, I went with Breeze.
This is the command. Notice the GTK theme:
XDG_DATA_DIRS=/usr/share/ubuntu:/usr/share/gnome:/usr/local/share/:/usr/share/ GTK_THEME=Breeze && python3 -u /opt/bibleanalyzer/ba-run.py"

Code: Select all

XDG_DATA_DIRS=/usr/share/ubuntu:/usr/share/gnome:/usr/local/share/:/usr/share/ GTK_THEME=Breeze && python3 -u /opt/bibleanalyzer/ba-run.py"

Hyprland host doesn't show pop-up windows
Recently switched to Hyprland and noticed pop-up windows were not working. With this fix all pop-ups will be centered on the screen, but for now that is the best I could do. Please add this line to the window rules section of hyprland.conf

Code: Select all

windowrulev2=noinitialfocus,initalTitle:^ba-run.py,floating:1

[Tim]

Thanks. I'll make this a "sticky" post so others can better find it.

[doonoo]

Fixed it working on arch for me. Thanks sir!

[zortmo]

Thanks nymusicman! I've used this multiple times on different distros. Works great!
Mike

[zortmo]

On Debian and MX Linux I got this error:
Error: command required for rootless mode with multiple IDs: exec: "newuidmap": executable file not found in $PATH
Reference: https://github.com/containers/podman/bl ... hooting.md (see issue 9)

For Debian I needed to install rootlesskit. https://packages.debian.org/bullseye/rootlesskit
Arch, RH will require different packages that do the same thing.

From Debian site:
The purpose of RootlessKit is to run Docker and Kubernetes as an unprivileged user (known as "Rootless mode"), so as to protect the real root on the host from potential container-breakout attacks.

[wmcdannell]

Thank you nymusicman! Your instructions and troubleshooting worked great on the latest Manjaro (6.6.40-1-MANJARO) & KDE (6.0.5). I had it running with wine before but I like this better

[wmcdannell]

If anyone wants to use this method (distrobox) to run the Bibleanalyzer 5.6 beta with a Ubuntu 24.04 image only a few changes to the instructions are necessary:

Change the image used to create the distrobox to ubuntu:noble-20240605

Code: Select all

distrobox create --image ubuntu:noble-20240605 --name bibleanalyzer --home ~/.bibleanalyzercontainer/

Replace Install Dependencies step with:

Code: Select all

wget http://www.bibleanalyzer.com/bibleanalyzer_5.6-1_all.deb
sudo apt install ./bibleanalyzer_5.6-1_all.deb python3-lxml -y

NOTE: before the First launch step (from inside the distrobox you created) you will most likely need to:

Code: Select all

cd && mkdir .config

[nymusicman]

Thank you nymusicman! Your instructions and troubleshooting worked great on the latest Manjaro (6.6.40-1-MANJARO) & KDE (6.0.5). I had it running with wine before but I like this better

Really great to hear! Glad you are enjoying it.

[nymusicman]

If anyone wants to use this method (distrobox) to run the Bibleanalyzer 5.6 beta with a Ubuntu 24.04 image only a few changes to the instructions are necessary:

Change the image used to create the distrobox to ubuntu:noble-20240605

Code: Select all

distrobox create --image ubuntu:noble-20240605 --name bibleanalyzer --home ~/.bibleanalyzercontainer/

Replace Install Dependencies step with:

Code: Select all

wget http://www.bibleanalyzer.com/bibleanalyzer_5.6-1_all.deb
sudo apt install ./bibleanalyzer_5.6-1_all.deb python3-lxml -y

NOTE: before the First launch step (from inside the distrobox you created) you will most likely need to:

Code: Select all

cd && mkdir .config

Thanks so much for this. I'm not going to add this to main directions yet for 2 reasons.
1. BA5.6 is still in Beta.
2. https://github.com/89luca89/distrobox/pull/1005. In order to install Ubuntu 23.10 and above you need to be on >=Distrobox 1.6. Debian and Steam Deck users (at least) are still stuck on Distrobox 1.4.

Note: Debian 12 users can install BA56 natively with the Ubuntu installation command above.

[nymusicman]

On Debian and MX Linux I got this error:
Error: command required for rootless mode with multiple IDs: exec: "newuidmap": executable file not found in $PATH
Reference: https://github.com/containers/podman/bl ... hooting.md (see issue 9)

For Debian I needed to install rootlesskit. https://packages.debian.org/bullseye/rootlesskit
Arch, RH will require different packages that do the same thing.

From Debian site:
The purpose of RootlessKit is to run Docker and Kubernetes as an unprivileged user (known as "Rootless mode"), so as to protect the real root on the host from potential container-breakout attacks.

I didn't think about trying Debian as I thought it could run BA natively, but maybe not. Thank you for getting this figured out. I'll update the above when I get around to running a VM with Debian and trying your instructions.

Edit: I booted a VM and installed Debian 12 with GNOME and had no issues with a rootless mode. I did have to manually make the .config folder. I'll add this to the Troubleshooting section instead of the instructions.