Skip to content

Latest commit

 

History

History
90 lines (66 loc) · 3.42 KB

README.md

File metadata and controls

90 lines (66 loc) · 3.42 KB
Raw

Build Status

OpenWebif

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

Documentation

Link

API Wiki

Link

Screenshots

Link

Latest Bandit Report

Link

Latest JSHint Reports

Link1 Link2

Latest Flake8 Report

Link

License

Licensed under the GNU General Public License, Version 3. See LICENSE for more details.

Latest Package

The most recent package may be downloaded here (ipk package).

Installation

# Remotely logged in via Telnet/SSH to enigma2 device
cd /tmp
init 4                        # graceful enigma2 shutdown
# fetching -- wget '<URL of .ipk file>'
# example:
wget 'https://github.com/E2OpenPlugins/e2openplugin-OpenWebif/raw/gh-pages/enigma2-plugin-extensions-openwebif_1.4.0-latest_all.ipk'
# installing -- opkg install <.ipk file>
# example:
opkg install ./enigma2-plugin-extensions-openwebif_1.4.0-latest_all.ipk
init 3                        # start enigma2 again

Development Information

The Changelog is available here.

Dependencies

The following additional packages need to be installed:

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

(Dependencies should be handled by using ipkg/opkg packages)

Compiling JavaScript Files

The javascipt source files inside of /sourcefiles/js needs to compress via UglifyJS3 on https://skalman.github.io/UglifyJS-online/. You need to increase the version and write down your modification description inside of the source file. The compressed file have the following syntax : xx-.min.js

Compiling CSS Files

The script contrib/inotify_watcher.py is used for compiling CSS files on the developers host using Sass . On linux you need to have installed a package providing inotifywait and a version that actually supports inotify if one wants automatic compiling of CSS files on source directory changes (For debian based distributions this would be inotify-tools).

Mac and Windows do not have inotify support thus the automatic compiling will not work (yet). But if you installed Sass (see http://sass-lang.com/install) and the scss binary/script is in your PATH calling contrib/inotify_watcher.py --force-update should work. Alternatively you may define environment variable SCSS in order to point to the location of the scss binary/script.

Base command is

scss -t compressed --unix-newlines --sourcemap=none "in.scss":"out.css"