OpenWebif

OpenWebif is an open source browser-based interface for Enigma2-based set-top boxes (STBs).

Screenshots

OpenWebif Screenshots (Classic interface) (TODO: add Modern interface screenshots)

Usage

To find out how to access it from your browser, go to the OpenWebif page through your receiver's Plugins page; once there, you'll see the http... address to use.

Documentation

Read the e2openplugin OpenWebif documentation.

API Wiki

OpenWebif API documentation

Found a Problem / Issue / Bug / Missing Feature?

See if it's already been logged.
Otherwise, feel free to log a new issue or request.

** Always try the most recent build first to see if this solves the issue. If that doesn't help, please provide as much information as possible!

You'll need to enable Debug | Display Tracebacks in browser setting either

through OpenWebif configuration, which can be found in your receiver's Plugins page. or
by adding the line config.OpenWebif.displayTracebacks=true to the /etc/enigma2/settings file

Along with the steps you took that cause the issue, the following information will be very useful:

whether the issue is constant or intermittent
if it has just recently started happening (perhaps after an update)
screenshots - A picture really is worth a thousand words!!
whether the issue happens on just one or several browsers
- try with a mainstream browser (Firefox / Brave / Chrome / Edge /Safari)
- try disabling browser extensions & plugins

** Note that the more detail we get, the sooner we'll be able to investigate!

We have limited free time and don't have every variation of setup at our disposable, so...

If possible, even more helpful details to include are:

device type and OS (Mac / Win / Android / Apple ...)
OS or device version (macOS High Sierra / Win10 / Android 11 / iOS12 ...)
browser (Brave / Chrome / Firefox / Safari / Edge ...)

Want to Help Translate OpenWebif?

Feel free to update an existing language file or create a new one by using the template

Latest Reports

[Bandit]: OpenWebif Bandit Report

[Flake8]: OpenWebif Flake8 report

[JSHint]: Modern interface report | Classic interface report

License

OpenWebif is licensed under the GNU General Public License, Version 3.

Latest Package

Download the most recent OpenWebif ipk package

Installation

OpenWebif is installed by default on a number of enigma2 images
(TODO: add list here)

To install the plugin manually:

## connect to your enigma2 device via SSH/Telnet, (eg. `ssh root@boxip`), then

# change to the temp directory
cd /tmp

# shut down enigma2 gracefully
init 4

# fetch OpenWebif ipk
wget -O openwebif.ipk https://github.com/E2OpenPlugins/e2openplugin-OpenWebif/blob/gh-pages/enigma2-plugin-extensions-openwebif_1.4.8-git20210718-r4_all.ipk

# install downloaded ipk file
opkg install openwebif.ipk

# restart enigma2
init 3

Development Information

See what's been happening, check out the OpenWebif changelog

Dependencies

The following additional packages need to be installed:
(dependencies should be handled by using ipkg/opkg packages)

python-pprint
python-cheetah
python-json
python-unixadmin
python-misc
python-twisted-web
python-pyopenssl
python-compression
python-ipaddress
python-six (>= 1.14)

File Paths

The OpenWebif plugin's files are located on the enigma2 box at /usr/lib/enigma2/python/Plugins/Extensions/OpenWebif

On non-dev builds, .tmpl files will need to be generated to .py

connect to the stb (eg. ssh root@boxip)
manually delete the .pyc/.pyo file(s) associated with the template(s) you've modified (enigma2 will regenerate them) cheetah compile --nobackup --iext=.tmpl -R /usr/lib/enigma2/python/Plugins/Extensions/OpenWebif/controllers/views/
restart Twisted server by going to /web/restarttwisted in the browser or
restart enigma2 init 4 && init 3

Updating Assets

Find out how to make changes to OpenWebif's JS & CSS assets

luxorko/e2openplugin-OpenWebif