Skip to content
README.md 3.39 KiB
Newer Older
[OpenELEC](http://www.openelec.tv)
# OpenELEC - Open Embedded Linux Entertainment Center
Daniel Burns's avatar
Daniel Burns committed
OpenELEC runs [Kodi](http://kodi.tv), an award-winning free and open source (GPL) software media 
player and entertainment hub for digital media. For more info see http://kodi.tv .
The base system has been designed and built from the ground up to be as 
efficient as possible – consuming only tiny disk and memory footprints and
providing cutting edge hardware support to deliver a set-top box experience.
Stephan Raue's avatar
Stephan Raue committed
* https://github.com/OpenELEC/OpenELEC.tv
* Please read the instructions in our wiki (http://wiki.openelec.tv/index.php?title=Installation) on how to install.
Stephan Raue's avatar
Stephan Raue committed
* OpenELEC is released under [GPLv2](http://www.gnu.org/licenses/gpl-2.0.html). Please refer to the "licenses" folder and 
  source code for clarification on upstream licensing.

**Copyright**

* Since OpenELEC includes code from many up stream projects it includes many 
  copyright owners. OpenELEC makes NO claim of copyright on any upstream code. 
  However all OpenELEC authored code is copyright openelec.tv.
  For a complete copyright list checkout the source code to examine the headers.
  Unless expressly stated otherwise all code submitted DIRECTLY to the OpenELEC 
Stephan Raue's avatar
Stephan Raue committed
  project (in any form) is licensed under [GPLv2](http://www.gnu.org/licenses/gpl-2.0.html) and the Copyright is donated to 
  openelec.tv.
  This allows the project to stay manageable in the long term by giving us the
  freedom to maintain the code as part of the whole without the management 
  overhead of preserving contact with every submitter ever e.g. move to GPLv3.
  You are absolutely free to retain copyright. To retain copyright simply add a 
  copyright header to every submitted code page.
  If you are submitting code that is not your own work it is the submitters 
  responsibility to place a header stating the copyright. 

Stefan Saraev's avatar
Stefan Saraev committed
* System size ~ 90 - 170MB
* Minimal hardware requirements
* Ultra fast boot
Daniel Burns's avatar
Daniel Burns committed
* Simple configuration via Kodi itself
* Plug and Play external storage

**Software**

Daniel Burns's avatar
Daniel Burns committed
* Kodi HTPC software – View/Manage all your media.
* Samba server – File transfer from any PC client
* SSH server – Remote console access for debugging
* IR/Bluetooth Remote Control

**Notes**

* SSH login details are user: “root” password: “openelec”.
  SSH allows command line access to your openelec.tv machine for configuration
  and file transfer. Linux/Mac clients can natively use SSH, while Windows
  users might want to try PuTTY for their terminal access.
* $HOME is mounted on /storage (the second ext4 partition on the drive). 
  All data transfered to the machine will go here, the rest of the system is
  read-only with the exception of /var (containing runtime configuration data).
* Manual update/downgrade procedure is as follows:
Stefan Saraev's avatar
Stefan Saraev committed
  Copy the snapshot (.tar) to the 'Update' network share (or /storage/.update) on
  your openelec machine. Your system will automatically upgrade during the 
  next reboot.
* Automatic mounting of filesystems is supported. Devices such as USB Flash 
  sticks can be plugged into a running machine and will be mounted to /media,
Daniel Burns's avatar
Daniel Burns committed
  showing up in Kodi’s GUI.
* Comments and questions are more than welcome, help is even better and patches 
**Questions/Support**

* Forums on [http://openelec.tv](http://openelec.tv)
* IRC chatroom **#openelec** on Freenode
**Happy OpenELEC'ing**