Difference between revisions of "LinuxMCE Admin Website"

From LinuxMCE
Jump to: navigation, search
(added all of the current webpages.)
(Files & Media)
 
(80 intermediate revisions by 8 users not shown)
Line 1: Line 1:
 +
[[Category: Documentation]]
 +
 +
[[Category: Programmer's Guide]]
 
{| align="right"
 
{| align="right"
 
   | __TOC__
 
   | __TOC__
 
   |}
 
   |}
<p>The LinuxMCE Admin web site is used to setup and configure your LinuxMCE system.  It also allows you to do a lot of other tasks, like checking your voice-mail, organizing your media and so on.  The web site runs on your own LinuxMCE Core, and you can access it from a Web Browser on the Core, or any other computer in your home connected to the same network.  By default, the LinuxMCE Admin web site is not accessible outside your home--everything is stored on the Core in your home, and you can only access the web site from the computers in your home.  This makes the system completely secure, however, it prevents you from accessing the web site outside the home via the internet.  You can turn on internet access, allowing you to access the web site anywhere, however, for your security, we recommend you first read about the [[Security & Privacy Issues]].</p>
+
''<center><small>If you were directed here from your Admin page, see the [[:Help:Contents|Help section]].</small></center>''
 +
The LinuxMCE Admin web site is used to setup and configure your LinuxMCE system.  It also allows you to do a lot of other tasks, such as to check your voice-mail, organize your media, etc.  The web site runs on the LinuxMCE Core. You can access it from the Core web browser, or from any other computer connected to the network.   
  
<p>Normally, from within your house, you access the website by opening any web browser (Internet Explorer, Mozilla, etc.) on any computer and going to http://dcerouter/
+
==Access to the LinuxMCE Admin Website==
    Note this assumes that the name of your core is dcerouter, which is the default name if you use a Kick-Start CD.  Otherwise, substitute the real IP address or name of your core instead of "dcerouter".</p>
+
===From a Core or Media Director desktop===
 +
* Choose '''Advanced''' -> '''Computing''' -> '''Web Admin''' from the menu
  
<p>LinuxMCE is a very modular platform with a wide variety of optional modules and devices to do just about anything.  Plus you can have lots of [[media director]] computers connected, all with their own mix of modules too.  Generally, each module will have one or more web pages to configure or use that module.  The LinuxMCE Admin web site has a pull-down menu that lets you quickly access any of those pages.  So, the menu options for your particular home will be unique to your own configuration.  If, for example, you have a LinuxMCE telephone system, then your LinuxMCE Admin will have menu options to setup your phones, check your voice-mail, and so on.  Someone else who does not have a LinuxMCE phone system will not have those options.  Note that there is only 1 LinuxMCE Admin web site for the whole house, and it is used to configure any device within the house.  If you have a media director in your den, for example, and there is a camera attached to it, you will control and view that camera using the same LinuxMCE Admin web site running on the core.  The [[Media Directors]] do not have their own sites--everything runs on the [[Core]].</p>
+
===From within your home===
 +
You can access the LinuxMCE Admin website from any web browser (Mozilla Firefox, IE, Safari):
  
<p>The 2 menu options that you will always see no matter what modules you have in your installation are "Wizard" and "Advanced". The "Wizard" is the normal way to configure and setup your LinuxMCE system.  When you choose Wizard, you will see a series of steps.  What steps you see will depend on what devices you have in your home.  However, all the pages in the Wizard section are intended to be simple for the average user and allow you to start using LinuxMCE with minimal effort and no technical skills. If you are a techie or want to do development, there are more low level options under the "Advanced" level. But regardless, you should always complete the wizard first since it's the fastest way to get going.</p>
+
*In the browser address bar, type the URL ''<nowiki>http://&lt;core_ip&gt;/pluto-admin</nowiki>''.
 +
* From within the "internal" LinuxMCE LAN, for example:
 +
**''<nowiki>http://192.168.80.1/pluto-admin</nowiki>''
 +
***(This assumes the IP address range set by default at installation.)
  
<p>The rest of the menu options are all specific to your particular mix of modules: security cameras, phone systems, etc.</p>
+
*You can also use the network name of the Core in place of the IP address. For example, if the Core was named "dcerouter" during the default installation, you could use:
 +
**''<nowiki>http://dcerouter/pluto-admin</nowiki>''
  
<p>For a general overview of how the "Wizard" works and what is involved in setting up your LinuxMCE system, [[Wizard Pages]]. If you have a question about any page or form on the website, just click the "Help" button in the upper right part of the screen. It is context sensitive, so it will take you straight to a help page that explains whatever you currently see on the screen.</p>
+
*From the "external" home LAN, the core_ip would be the LAN IP address of the core. If, for example, the core is at 192.168.0.50 on the home LAN, use:
 +
**''<nowiki>http://192.168.0.50/pluto-admin</nowiki>''
 +
 
 +
===From the Internet===
 +
You could use the IP address:port for your home LAN, with port forwarding to the Core's LAN IP address (enabled by your home LAN router).
 +
*''This is an advanced topic and may not be secure in the current version.''.
 +
 
 +
By default, the LinuxMCE Admin web site is not accessible outside your home. This makes the system secure, but it prevents you from accessing the web site via the Internet while away from home.  You can [[Outside_Access|turn on Internet access]], allowing access to the admin website anywhere. For your own security, however, we recommend you first read about [[Security & Privacy Issues]].
 +
 
 +
===Login page===
 +
*The login page should be displayed. Input an existing user name and password, then click "Login".
  
 
=LinuxMCE Admin Website Sections=
 
=LinuxMCE Admin Website Sections=
 +
 +
==Admin page structure==
 +
LinuxMCE is a modular platform with a wide variety of optional modules and devices. Generally, each module will have one or more web pages to configure when using that module.  The LinuxMCE Admin web site has a pull-down menu that lets you quickly access any of those pages.  The menu options for each particular home will be unique, depending on the configuration.
 +
 +
Two menu options will always be displayed.
 +
 +
*The ''[[Wizard Pages|Wizard]]'' is the commonly used way to configure and setup your LinuxMCE system.  When you choose Wizard, you will see a series of steps that depends on what devices you have installed in your home. The pages in the Wizard section are intended to be simple for the average user. Context-sensitive help is provided through a "Help" button.
 +
 +
*There are more low level options under the ''Advanced'' option.
 +
 
==Wizard==
 
==Wizard==
 
*[[Wizard Pages]]
 
*[[Wizard Pages]]
Line 22: Line 52:
 
*[[Users]]
 
*[[Users]]
 
*[[Rooms]]
 
*[[Rooms]]
 +
*[[Email]]
 
*[[Keyboard Layout]]
 
*[[Keyboard Layout]]
 +
 
===[[Devices]]===
 
===[[Devices]]===
 
*Core
 
*Core
Line 43: Line 75:
 
*[[Climate Scenarios]]
 
*[[Climate Scenarios]]
 
*[[Irrigation Scenarios]]
 
*[[Irrigation Scenarios]]
*[[Scenarios Security| Security Scenarios]]
+
*[[Security Scenarios]]
*[[Telecom| Telecom Scenarios]]
+
*[[Telecom Scenarios]]
 
*[[Mobile Orbiter Scenarios]]
 
*[[Mobile Orbiter Scenarios]]
 
*[[Sleeping Scenarios]]
 
*[[Sleeping Scenarios]]
===[[Events]]===
+
 
 +
===[[Events | Events Handler]]===
 
*[[Respond to Events]]
 
*[[Respond to Events]]
 
*[[Timed Events]]
 
*[[Timed Events]]
 +
===Security===
 
*[[Settings By Alert Type]]
 
*[[Settings By Alert Type]]
 
*[[Active sensors]]
 
*[[Active sensors]]
Line 55: Line 89:
 
*[[Notifications| Cellphone Notifications]]
 
*[[Notifications| Cellphone Notifications]]
 
*[[Outside Access]]
 
*[[Outside Access]]
 +
===[[Restart]]===
 +
 
==Advanced==
 
==Advanced==
 
===Software===
 
===Software===
 
*[[Add Software]]
 
*[[Add Software]]
 +
*[[Software Versions]]
 
*[[Boot Sequence]]
 
*[[Boot Sequence]]
 
*[[Packages]]
 
*[[Packages]]
 +
 
===Network===
 
===Network===
 
*[[Network Settings]]
 
*[[Network Settings]]
===[[Privacy Settings]]===
+
*[[Firewall Rules]]
===Configuration]]
+
*[[WAP/GPRS Settings]]
 +
*[[Dynamic DNS Settings]]
 +
 
 +
===Configuration===
 
* [[Advanced Pages Devices| Devices]]
 
* [[Advanced Pages Devices| Devices]]
 
* Unknown Devices
 
* Unknown Devices
 
* [[Device Templates]]
 
* [[Device Templates]]
** [[List Page]]
+
** [[Edit Device Template]]
** [[Edit Page]]
+
** [[Design Objects]]
+
 
* Device Category Device Data
 
* Device Category Device Data
 
* [[Advanced Pages Scenarios | Scenarios]]
 
* [[Advanced Pages Scenarios | Scenarios]]
 
* [[Advanced Pages Events | Events]]
 
* [[Advanced Pages Events | Events]]
* Phones Setup
+
* [[Phones Setup]]
* Backups
+
* [[Backup and Restore | Backups]]
* RAID
+
* [[Create_RAID_in_LMCE#Creating_RAID| RAID]]
 +
 
 +
===[[Privacy Settings]]===
 +
* [[Users#Users and Orbiters|Users-Orbiters]]
 +
* [[Users#Users and Rooms|Users-Rooms]]
 +
* [[Users#Restrict Access|Restrict Access]]
 +
 
 
===sqlCVS===
 
===sqlCVS===
 
* Update
 
* Update
Line 81: Line 126:
 
* Diff
 
* Diff
 
* View Batch
 
* View Batch
 +
 
===[[DCE]]===
 
===[[DCE]]===
 
* Device Data
 
* Device Data
 
* Commands
 
* Commands
 
* Events
 
* Events
 +
 
==Automation==
 
==Automation==
 
*[[Device Status]]
 
*[[Device Status]]
Line 93: Line 140:
 
*[[Status]]
 
*[[Status]]
 
*[[View Cameras]]
 
*[[View Cameras]]
==[[Files&Media]]==
+
==Files & Media==
 
* Media Browser
 
* Media Browser
* Media Files Sync
+
* [[Media Files Sync]]
 
* Playlist
 
* Playlist
 
* Media Providers
 
* Media Providers
 
* Bookmarks
 
* Bookmarks
 
* [[Cover Art]]
 
* [[Cover Art]]
* Ripping Status  
+
* Ripping Status
 +
* [[Screen Saver]]
 +
 
 
==Telecom==
 
==Telecom==
 
* My Voicemail
 
* My Voicemail
Line 108: Line 157:
 
* Priority Callers
 
* Priority Callers
 
* Callers for me
 
* Callers for me
 +
 +
The following is leftover from another page:
 +
 +
=Development=
 +
Doing development against the linuxMCE web administration requires acessing the files either locally with your editor of choice, or even remotely. Its also a good idea to install phpmyadmin, which will let you view the tables and such associated with the linuxMCE installation your working with. The web admin is located on your core in '''/var/www/lmce-admin''' and in the svn under 'web'.
 +
 +
It currently employs a large index file with case switching for the majority of pages, with those pages then leading to others relating to their specific function. The database also employs ADODB for most of the operations involving database transactions. Pages involve the use of template's with javascript objects writing data to the page. Please note, this is '''quite the basic''' overview.
 +
 +
==Network Share Method==
 +
 +
The most simple method of making '''/lmce-admin''' available for editing outside of the core on your local network involves modifying samba. Please note: samba fixes itself on reboot and  you will need to modify the config again to regain access to the files.
 +
 +
Edit '''/etc/samba/samba.conf''' and add this before the last line:
 +
 +
[www]
 +
comment = Web server files
 +
browseable = yes
 +
writable = yes
 +
create mask = 0770
 +
directory mask = 0770
 +
path = /var/www
 +
public = no
 +
guest ok = no
 +
force user = www-data
 +
force group = www-data
 +
 +
Then restart samba by typing into the console
 +
/etc/init.d/samba restart
 +
 +
And now the lmce-admin directory will appear as a share on the local network.
 +
 +
==Adding custom entries in LinuxMCE Admin menus==
 +
 +
Currently only option is to enter entries into Pluto_main database, table PageSetup. There you'll find other entries already, go to the end and add yours (but be careful not to break anything and also save your changes, cause they can probably lost in migration or updates - not sure)...
 +
 +
Anyway for simple test I've created two entries: "Tinia" as main menu entry (after Telecom) and then subentry for phpmyadmin that I frequently use. If I highlight only important fields, my entries look like this :
 +
 +
'''PK_PageSetup FK_..._Parent Website OrderNum FK_Package Description  pageURL                  showInTopMenu'''
 +
190      NULL          1  70  NULL  Tinia                                    1 
 +
191     190         1 0 NULL PHPMyAdmin  http://192.168.0.1/phpmyadmin/ 1
 +
 +
If FK_PageSetup_Parent is empty, then you'll have main entry on green main bar. If you want subentry, then you just specify PK_PageSetup of your parent in FK_PageSetup_Parent. You can also add URL

Latest revision as of 19:47, 3 December 2013

If you were directed here from your Admin page, see the Help section.

The LinuxMCE Admin web site is used to setup and configure your LinuxMCE system. It also allows you to do a lot of other tasks, such as to check your voice-mail, organize your media, etc. The web site runs on the LinuxMCE Core. You can access it from the Core web browser, or from any other computer connected to the network.

Access to the LinuxMCE Admin Website

From a Core or Media Director desktop

  • Choose Advanced -> Computing -> Web Admin from the menu

From within your home

You can access the LinuxMCE Admin website from any web browser (Mozilla Firefox, IE, Safari):

  • In the browser address bar, type the URL http://<core_ip>/pluto-admin.
  • From within the "internal" LinuxMCE LAN, for example:
    • http://192.168.80.1/pluto-admin
      • (This assumes the IP address range set by default at installation.)
  • You can also use the network name of the Core in place of the IP address. For example, if the Core was named "dcerouter" during the default installation, you could use:
    • http://dcerouter/pluto-admin
  • From the "external" home LAN, the core_ip would be the LAN IP address of the core. If, for example, the core is at 192.168.0.50 on the home LAN, use:
    • http://192.168.0.50/pluto-admin

From the Internet

You could use the IP address:port for your home LAN, with port forwarding to the Core's LAN IP address (enabled by your home LAN router).

  • This is an advanced topic and may not be secure in the current version..

By default, the LinuxMCE Admin web site is not accessible outside your home. This makes the system secure, but it prevents you from accessing the web site via the Internet while away from home. You can turn on Internet access, allowing access to the admin website anywhere. For your own security, however, we recommend you first read about Security & Privacy Issues.

Login page

  • The login page should be displayed. Input an existing user name and password, then click "Login".

LinuxMCE Admin Website Sections

Admin page structure

LinuxMCE is a modular platform with a wide variety of optional modules and devices. Generally, each module will have one or more web pages to configure when using that module. The LinuxMCE Admin web site has a pull-down menu that lets you quickly access any of those pages. The menu options for each particular home will be unique, depending on the configuration.

Two menu options will always be displayed.

  • The Wizard is the commonly used way to configure and setup your LinuxMCE system. When you choose Wizard, you will see a series of steps that depends on what devices you have installed in your home. The pages in the Wizard section are intended to be simple for the average user. Context-sensitive help is provided through a "Help" button.
  • There are more low level options under the Advanced option.

Wizard

Basic Info

Devices

Scenarios

Events Handler

Security

Restart

Advanced

Software

Network

Configuration

Privacy Settings

sqlCVS

  • Update
  • Checkin
  • Diff
  • View Batch

DCE

  • Device Data
  • Commands
  • Events

Automation

Security

Files & Media

Telecom

  • My Voicemail
  • General Voicemail
  • Phone book
  • Call Routing
  • Priority Callers
  • Callers for me

The following is leftover from another page:

Development

Doing development against the linuxMCE web administration requires acessing the files either locally with your editor of choice, or even remotely. Its also a good idea to install phpmyadmin, which will let you view the tables and such associated with the linuxMCE installation your working with. The web admin is located on your core in /var/www/lmce-admin and in the svn under 'web'.

It currently employs a large index file with case switching for the majority of pages, with those pages then leading to others relating to their specific function. The database also employs ADODB for most of the operations involving database transactions. Pages involve the use of template's with javascript objects writing data to the page. Please note, this is quite the basic overview.

Network Share Method

The most simple method of making /lmce-admin available for editing outside of the core on your local network involves modifying samba. Please note: samba fixes itself on reboot and you will need to modify the config again to regain access to the files.

Edit /etc/samba/samba.conf and add this before the last line:

[www]
comment = Web server files
browseable = yes
writable = yes
create mask = 0770
directory mask = 0770
path = /var/www
public = no
guest ok = no
force user = www-data
force group = www-data

Then restart samba by typing into the console

/etc/init.d/samba restart

And now the lmce-admin directory will appear as a share on the local network.

Adding custom entries in LinuxMCE Admin menus

Currently only option is to enter entries into Pluto_main database, table PageSetup. There you'll find other entries already, go to the end and add yours (but be careful not to break anything and also save your changes, cause they can probably lost in migration or updates - not sure)...

Anyway for simple test I've created two entries: "Tinia" as main menu entry (after Telecom) and then subentry for phpmyadmin that I frequently use. If I highlight only important fields, my entries look like this :

PK_PageSetup FK_..._Parent Website OrderNum FK_Package Description   pageURL                   showInTopMenu
190  	    NULL  	        1  	70  	NULL  	Tinia  	   	                                 1  	
191 	    190 	        1 	0 	NULL 	PHPMyAdmin   http://192.168.0.1/phpmyadmin/ 	1

If FK_PageSetup_Parent is empty, then you'll have main entry on green main bar. If you want subentry, then you just specify PK_PageSetup of your parent in FK_PageSetup_Parent. You can also add URL