LinuxMCE - User contributions [en]

Adding new web links

2011-12-31T08:06:04Z

Dan249:

{{versioninfo | 810Status=Compatible | 810UpdatedDate=5 June 2011 | 810UpdatedBy=Dan249 | 1004Status=Compatible | 1004UpdatedDate=31 Dec 2011 | 1004UpdatedBy=Dan249}}

It is possible to add new web links to the computing page. This technique tells Firefox to use the Bookmarks.html file, it does not use the bookmarks.html file by default. In order for web links to show up on the Computing page within an orbiter, you have to add the link in Firefox from a [[Media Director]]. Here is the easiest method for adding new bookmarks.
* Browse to Computing screen and select one of the preloaded "Web bookmarks". This will open up a Firefox browser on the Media Director.
* At Address bar type '''about:config''' ;note: make sure to put a colon between about and config; and press enter.
* Click the "I'll be careful, I promise" button.
* Either enter "browser.bookmarks.autoExportHTML", without quotes in the filter or scroll down screen to that field.
* Double click that field which changes it to TRUE from the default false. Make sure you chose the right field.
* Browse the web like any normal web browser and when you find a page of interest
* Add your new bookmark
* ''' NOTE: you must close the browser with File->Quit.'''
* Reopen the Computing screen,
* Your new bookmarks will be visible.

'''IMPORTANT: If you close the browser by using the LinuxMCE buttons at the bottom of the screen your bookmarks will not be saved!'''

'''Note: This works with the Firefox 3 versions provided with Linuxmce810 and Linuxmce1004!'''

[[Category : Tutorials]]

Adding new web links

2011-12-31T07:55:32Z

Dan249:

{{versioninfo | 810Status=Compatible | 810UpdatedDate=5 June 2011 | 810UpdatedBy=Dan249 | 1004Status=Compatible | 1004UpdatedDate=31 Dec 2011 | 1004UpdatedBy=Dan249}}

It is possible to add new web links to the computing page. This technique tells Firefox to make changes to the Bookmarks.html file, it does not make the changes to bookmarks.html file by default. In order for web links to show up on the Computing page within an orbiter, you have to add the link in Firefox from a [[Media Director]]. Here is the easiest method for adding new bookmarks.
* Browse to Computing screen and select one of the preloaded "Web bookmarks". This will open up a Firefox browser on the Media Director.
* At Address bar type "about:config" without quotes and press enter.
* Click the "I'll be careful, I promise" button.
* Either enter "browser.bookmarks.autoExportHTML", without quotes in the filter or scroll down screen to that field.
* Double click that field which changes it to true from the default false. Make sure you chose the right field.
* Browse the web like any normal web browser and when you find a page of interest
* Add your new bookmark
* ''' NOTE: you must close the browser with File->Quit.'''
* Reopen the Computing screen,
* Your new bookmarks will be visible.

'''IMPORTANT: If you close the browser by using the LinuxMCE buttons at the bottom of the screen your bookmarks will not be saved!'''

'''Note: This works with the Firefox 3 versions provided with Linuxmce810 and Linuxmce1004!'''

[[Category : Tutorials]]

Adding new web links

2011-12-31T07:54:24Z

Dan249:

{{versioninfo | 810Status=Compatible | 810UpdatedDate=5 June 2011 | 810UpdatedBy=Dan249 | 1004Status=Compatible | 1004UpdatedDate=30 Dec 2011 | 1004UpdatedBy=Dan249}}

It is possible to add new web links to the computing page. This technique tells Firefox to make changes to the Bookmarks.html file, it does not make the changes to bookmarks.html file by default. In order for web links to show up on the Computing page within an orbiter, you have to add the link in Firefox from a [[Media Director]]. Here is the easiest method for adding new bookmarks.
* Browse to Computing screen and select one of the preloaded "Web bookmarks". This will open up a Firefox browser on the Media Director.
* At Address bar type "about:config" without quotes and press enter.
* Click the "I'll be careful, I promise" button.
* Either enter "browser.bookmarks.autoExportHTML", without quotes in the filter or scroll down screen to that field.
* Double click that field which changes it to true from the default false. Make sure you chose the right field.
* Browse the web like any normal web browser and when you find a page of interest
* Add your new bookmark
* ''' NOTE: you must close the browser with File->Quit.'''
* Reopen the Computing screen,
* Your new bookmarks will be visible.

'''IMPORTANT: If you close the browser by using the LinuxMCE buttons at the bottom of the screen your bookmarks will not be saved!'''
'''Note: This works with the Firefox 3 versions provided with Linuxmce810 and Linuxmce1004!'''

[[Category : Tutorials]]

Adding new web links

2011-12-31T07:33:24Z

Dan249:

{{versioninfo | 810Status=Compatible | 810UpdatedDate=5 June 2011 | 810UpdatedBy=Dan249}}

It is possible to add new web links to the computing page. This technique tells Firefox to make changes to the Bookmarks.html file, it does not make the changes to bookmarks.html file by default. In order for web links to show up on the Computing page within an orbiter, you have to add the link in Firefox from a [[Media Director]]. Here is the easiest method for adding new bookmarks.
* Browse to Computing screen and select one of the preloaded "Web bookmarks". This will open up a Firefox browser on the Media Director.
* At Address bar type "about:config" without quotes and press enter.
* Click the "I'll be careful, I promise" button.
* Either enter "browser.bookmarks.autoExportHTML", without quotes in the filter or scroll down screen to that field.
* Double click that field which changes it to true from the default false. Make sure you chose the right field.
* Browse the web like any normal web browser and when you find a page of interest
* Add your new bookmark
* ''' NOTE: you must close the browser with File->Quit.'''
* Reopen the Computing screen,
** Your new bookmarks will be visible.

'''IMPORTANT: If you close the browser by using the LinuxMCE buttons at the bottom of the screen your bookmarks will not be saved!'''

[[Category : Tutorials]]

MetaData Handling

2011-07-07T15:39:32Z

Dan249: /* Automatic File tagging */

[[Category:Programmer's Guide]]
{{versioninfo|810Status=relevant|810UpdatedDate=8Sept2010|810UpdatedBy=[[User:Langstonius|Langstonius]]}}

LinuxMCE has the ability to tag multiple types of files, even those with no native tagging ability. This allows the persistence of metadata from linuxmce installation to another as the data is written to file. This page is a wide overview of the process used depending on the types of files and their capabilities.

==Basic Handling Overview==
ANY attribute stored in the media database for a file be it audio, video or otherwise gets stored on a file level as well. How it gets stored, depends on the file:

'''mp3''' files: Embed ALL the data into the ID3 section of the mp3 file. For any attributes that match analogously we use those attribute types for anything THAT DOESN'T we store it in a format that's read by SerializeClass, in a GEOB tag inside the ID3 section of the file.

'''Ogg and Flac''' files, we do similar, using Taglib to map attributes analogously into those media metadata types. TagLib does not support storing blobs, so it can't store everything into the ogg and flac files. Pictures, are stored, as APIC sections in MP3 files
or as picture resources in ogg files. Flac files do not have this facility.

'''FOR ANYTHING ELSE'''
We create what is essentially a file that just contains an ID3 section so it looks like an empty mp3 file alongside the existing file
which stores the attributes and data in exactly the same way as mp3 files using APIC resources to store pictures, mapping common attributes to id3 attributes and anything else as a SerializeClass blob inside a GEOB section.

'''In Practice'''
When a new file is detected by UpdateMedia, its data is interrogated, depending on whether there is an ID3 file, or an embedded id3 section, or something that taglib can handle and the data is brought back into the database. If there is a GEOB section then the other attributes not directly analogous will be brought back in.

When the pictures are brought in, a new picture row is made in the picture table, and the appropriate attribute and join tables.
and the picture is stored in '/home/mediapics/xxxxx.jpg' where 'xxxxx' is the PK_Picture row. If tags change on the linuxmce side, they're supposed to be reincorporated back into the serialized tag form. The URL to an image resource if one was specified, is stored as well.

As per Tschak from IRC 7 sept 2010
--[[User:Langstonius|Langstonius]] 05:48, 8 September 2010 (CEST)

==Manual file tagging==
Manually adding or removing attributes can be accomplished by navigating in the webadmin to 'Media Files Sync'. You can then select the file or files in question and edit attributes or lookup extended metadata via Imdb, Amazon, or TheTVDB.

==Merging Attributes==
From time to time you may find the need to combine (merge) or update the name of an attribute used by multiple files.

For example, you may have imported multiple Genres name variations (via IMDB or ID3 data) for a single Genre. E.g. "Sci-Fi", "Science-Fiction" and "Science Fiction". This will mean multiple files of the same Genre don't filter correctly (or you need to select 3 Genres), and it will also clutter your UI.

To fix this, go to the [[LinuxMCE Admin Website]] and select:
# Select '''Files & Media''' => '''Media Browser'''
# Tick '''Genre''' and select '''Go''' (leave the search field blank to display all values)
# Click the '''Properties''' link next to the Genre you want to change (e.g change "Science Fiction" to "Science-Fiction")
# Update the '''Name:''' attribute text box and click '''update''' (you may have to scroll to the right to see this text box)
# If the attribute name already exists a message will be displayed: "The attribute already exists. Do you want to merge this one with it?"
# Click '''Yes, merge them'''

Do an full [[Orbiter]] regeneration (Wizard => Devices => Orbiters) and the new/updated genres should be visible via UI1/2. All files previously tagged should be displayed under the single attribute.

'''Note''': The above should work with ''any Attribute'' not just Genres - just replace '''Genre''' with the attribute you want to change in the above instructions.

==Automatic File tagging==
Currently, audio files have the ability to have tags extracted from them and integrated into the LinuxMCE database. This is not the case for video media. Research has led to the development of a standalone media identification tool that will utilize online resources to identify media for presentation on orbiters and other parts of the LinuxMCE system.

The temporary version of this tool can be located here:
* [http://langstonball.com/attachments/linuxmceTag.zip 1004 Version]
* [http://langstonball.com/attachments/linuxmceTag0810.zip 0810 Version]
This file goes into /usr/pluto/bin and will enable the 'Tag this directory' function in media files sync

===State===
Currently the tool, referred to as 'linuxmceTag' is in the svn in the directory '/src/autotagger/'. It is currently not included in the build system and the binary must be taken from the location above and placed into '/usr/pluto/bin/' When initialized from the web admin, a window will show up following the log identifying files in the directory and those below it. It currently looks 1 directory down for files. If the log does not show (as has happened on 10.04 systems) note that it is still working and wait until it is done by saying 'Directory Tagged' on your media files sync page right above the file list.

===Usage===
From command line:
<table border = 1 width = 75% align=center>
<tr bgcolor="beige">
<td width = 50%>'''Command'''</td><td>'''Option'''</td>
</tr>
<tr bgcolor="WhiteSmoke">
<td> '/usr/pluto/bin/linuxmceTag 420'</td><td>Option to takte file number to scan. Can be directory or individual file.This can be located via the webadmin. Hovering over a directory link will show the fileid as part of the link</td>
</tr>
<tr bgcolor="WhiteSmoke">
<td> '/usr/pluto/bin/linuxmceTag 'home/public/data/videos/stuff/'</td><td> Takes a path enclosed in single quotes i.e. "/home/public/data/videos/Hard Drive 1 [47]".</td>
</tr>
<tr bgcolor="WhiteSmoke">
<td > '/usr/pluto/bin/linuxmceTag ' </td><td> Defaults to /home/public/data/videos with no options</td>
</tr>
</table>

-if no arguments are provided, it will select "/home/public/data/videos " as the base directory.
-take a directory argument enclosed in spaces
-also takes a filenumber.

===Identification===
This space to be updated with development progress.
Have decided on a strict filename scheme. This is due to the fact that much energy can be expended on parsing oddly named files.
Considering the fact there is a manual lookup system written and in place which provides more naming flexibility, it seems fair
to make the automatic metadata lookup more strict. The current file name conventions i have settled on are the following:

Television
Series
fringe.s(0)1.e(p)03
fringe.sx(0)1.e(p)03
fringe.103
fringe 1x03
The.Pacific.Pt.V <---Makes assumption here this is a mini series and marks it season 1.

Specials
fringe.behind.the.scenes.special.2010 <----lookup in webadmin :) To my current filter, this looks like a movie. I need to determine a better method to filter out tv specials.

Movies - Year is preferred!!!
Gleaming.The.Cube(1989)
gleaming_the_cube[1989]
the-usual-suspects
top.gun
iso - iso files are a bit tricky. For tv shows, i will need user data to determine the best method of identifying discs. With movies, it may be easier to accomplish as certain metadata sources support hash identifiers, but simply naming it should suffice.

===Image Handling===
Image Handling - Images are stored in association with the following things
<table bgcolor="WhiteSmoke" align=center width=75% border=1>
<tr bgcolor="PeachPuff">
<td colspan=4>Attributes Mapped to picture_attribute </td>
<tr>
<td width=10%>'''Attribute #'''</td><td>'''Attribute Name'''</td><td>'''Image Type'''</td><td>'''Notes'''</td>
</tr>
<tr>
<td>36</td><td>IMDB</td><td>Banner<br>[[File:birdmanBanner.jpg]]</td><td>none</td>
</tr>
<tr>
<td>43</td><td>TV Series ID</td><td>????</td><td>none</td>
</tr>
<tr>
<td>50</td><td>Season Number</td><td>Nothing</td><td>'''Not in Master DB'''</td>
</tr>
<tr>
<td>12</td><td>Program</td><td>[[File:BirdmanSeries.jpg]]<br>Series Image with title</td><td>none</td>
</tr>
<tr>
<td>13</td><td>Title (of Program)</td><td>Series Image with title</td><td>none</td>
</tr>
<tr>
<td>52</td><td>TV Season ID</td><td>Season Specific Poster<br>[[File:77119-1-2.jpg‎]]</td><td>'''Not in Master DB'''</td>
</tr>
<tr bgcolor="PapayaWhip">
<td>File</td><td>File Handling is Special. Image is associated to the PK_File in Picture_File table.</td><td>[[File:230083.jpg]]</td>
</tr>
</table>

--[[User:Langstonius|Langstonius]] 05:30, 2 April 2011 (CEST)

Telecom Features

2011-07-01T03:41:54Z

Dan249:

{| align="right"
| __TOC__
|}

[[Category:Telecom]]
This tries to be a complete list of LinuxMCE's telecom features. I will try to describe the feature, how to use it and a few implementation details.

== Hard phones plug&play ==
Allows the user to simply plug the phone into the network, it should be detected and automatically configured.
:Note : To each phone an ''extension'' is assigned : a small 3 digit number usually in range 200-299. Please don't try to change it unless you know what are you doing.
=== How to use it ===
Plug the phone (reboot it or reset it if needed), in few seconds on [[Orbiter]] you'll see something like
New device MAC XX:XX:XX:XX:XX:XX was found
Please choose device type
And you are presented with a datagrid with all device templates that matches MAC range of that specific device. After you select it, it will present you a screen to select room in which that device should be added. After selection wait a few seconds while device is configured, then you'll see a screen telling you that device is ready to use after a quick reload.
=== Technical details ===
First few steps are handled by [[Dhcpd-plugin]] so please read there. Then it comes to calling the configuration script.

The configuration script needs 6 command line parameters : '''-d DEVICE_ID -i DEVICE_IP -m DEVICE_MAC'''. Check one of ''/usr/pluto/bin/configure_*.pl'' to see how it's done.

The script usually will call another script ''/usr/pluto/bin/sync_pluto2amp.pl'' which will allocate a new extension to the phone and will submit a few pages in AMP to create proper asterisk configuration for the phone.

Then it comes to device specific stuff, it may:
* submit some pages on phone's '''web interface''' (Snom, GrandStream)
* create some files in '''/tftpboot''' (Cisco)
* '''other ways''' (like running iaxyprov to setup IAXy)

== Easy phoneline creation ==
When you sign up with a voip provider it usually gives you the following details : ''UserName'', ''Password'', ''PhoneNumber'', ''HostToConnect''. Using this data you may create a working phoneline in a few seconds.
:Note : sometimes ''UserName'' is same with ''PhoneNumber'', but not always, sometimes you may have one username/password to connect to provider's website (billing, support, call history) and OTHER pair of username/password to actually use the service. Be careful which one you use.

=== How to use it ===
Go to Users > Devices > Phone Lines.

It's a good idea before adding any phone line to fill the data in local prefixes section, like in this image. Filling it after phone line creation is useless, because that configuration can not be easily changed. You'll have to delete and recreate the phone line to make local numbers work.

[[Image:Local_prefixes.png]]

Select one of the providers (there are no 'fit them all' settings so there is a script to set up each provider, you are free to add more, just make sure that webpage is changed accordingly)

Fill the fields with your data and submit the page. The phone line should be set almost immediately, if everything is correct, there are no payment problems and the network is ok, then you can make calls right away. (for troubleshooting please read [[Asterisk-LinuxMCE#Troubleshooting|asterisk]] documentation)

=== Technical details ===
On submit a script is called with at least 3 parameters '''UserName Password PhoneNumber [ Host [ LinePrefix ] ]'''. ''Host'' is optional, it will be set to host assigned for existing VoIP accounts, new account may be assigned to other server. ''Line prefix'' is the prefix for dialing to outside, it's '9' by default.

Just check one of ''/usr/pluto/bin/create_amp_*.pl'' too see more details. As a main idea the script simply submits several pages in AMP web interface (creating a '''Trunk''', an '''Incoming Route''' and an '''Outgoing Route''').

* For creation of the trunk we use all data provided to the script.
* For incoming route usually ''PhoneNumber'' is used. Incoming call will be routed to special asterisk context '''from-LinuxMCE-custom''' which will be explained in [[LinuxMCE_telecom_features#Phoneline_call_routing | Phoneline call routing]]
* For outgoing route we use trunk number (from first step), local prefixes data submitted before line creation.

The parameters for trunk creation differ a lot between providers. The script we have will create a working configuration, it may not be optimal, some are just hacks to allow proper call routing, but it worked last time we checked.

== Make and receive calls ==
Even before creating phoneline you already can call from/to any LinuxMCE phone added to installation. This includes hardphones, softphones and as a special case of softphone any [[MediaDirector]], more specifically [[SimplePhone]] running on that media director.

If phoneline is added then you can call anywhere your service plan allows.
If you set local prefix like in picture from previous section, then you also can just dial 3372199 to actually dial 919543372199.

For international calls usually you have to dial 9(dial out)+011(international)+40(Romania)+332(IasiRDS)+402618
:(this is true for US providers only, for European providers to dial internationally you need 00)

=== How to use it ===
From a hard phone just dial the extension of the other phone and it will ring.

From a MD, go to Telecom > Dial Direct, then enter the number, select from which device to place the call or simply press "place call from here". If you are trying to place call from anything but a [[SimplePhone]], it will ring you'll have to pick it up, and after that it will dial the number you entered.

=== Technical details ===
If the call is initiated without orbiter's help (like from hard phone), then the call is simply routed by asterisk to local extension or outside number.

Otherwise a PL_Originate command is sent to [[Telecom_Plugin]] which will send CMD_Phone_Initiate if you are trying to place a call from an [[SimplePhone|Orbiter's Embedded Phone]] or CMD_PBX_Originate to [[LinuxMCE-asterisk|Asterisk]] which will pass is to [[asterisk-LinuxMCE|asterisk]].

== User call routing ==
Each LinuxMCE user gets a telecom extension (like a virtual number) in range 301-399.

Then he/she may setup a way to handle the call, like try to call phone in my room, then in kitchen, then ring several other phones, then send the call to voicemail.

But if it's a ''priority caller'' then instead after trying the phone in the room will call directly on mobile. Also you may set different routes if you are at home, or sleeping, or away.
=== How to use it ===
Go to Telecom > CallRouting, you'll see for each user something like the image below.

[[Image:User_routing_first.png]]

Then you can set up for each usermode and each called type (normal or priority) what steps to make to reach you.

[[Image:User routing second.png]]

=== Technical details ===
After submitting the second page the ''/usr/pluto/bin/create_pluto_dialplan.pl'' script is run which will query '''pluto_telecom :UserRouting''', and will create a dialplan according to your settings, which will be saved in ''/etc/asterisk/extensions_pluto_dial.conf''

This is a fragment of generated file.
exten => 301,1,AGI(pluto-getusermode.agi)
exten => 301,2,Goto(301-um${USERMODE}-pri${PRIORITYCALLER},1)
exten => 301,3,Hangup
exten => 301-um1-pri0,1,Goto(301-um1-pri0-try1,1)
exten => 301-um1-pri0-try1,1,Dial(Local/200@trusted,15)
exten => 301-um1-pri0-try1,2,Goto(301-um1-pri0-try1-${DIALSTATUS},1)
exten => 301-um1-pri0-try1,3,Hangup
exten => 301-um1-pri0-try1-BUSY,1,Goto(301-um1-pri0-try2,1)
exten => 301-um1-pri0-try1-NOANSWER,1,Goto(301-um1-pri0-try2,1)
exten => 301-um1-pri0-try1-CONGESTION,1,Goto(301-um1-pri0-try2,1)
exten => 301-um1-pri0-try1-CHANUNAVAIL,1,Goto(301-um1-pri0-try2,1)
exten => 301-um1-pri0-try2,1,Dial(Local/201@trusted,15)
exten => 301-um1-pri0-try2,2,Goto(301-um1-pri0-try2-${DIALSTATUS},1)
exten => 301-um1-pri0-try2,3,Hangup
exten => 301-um1-pri0-try2-BUSY,1,Goto(301-um1-pri0-try3,1)
exten => 301-um1-pri0-try2-NOANSWER,1,Goto(301-um1-pri0-try3,1)
exten => 301-um1-pri0-try2-CONGESTION,1,Goto(301-um1-pri0-try3,1)
exten => 301-um1-pri0-try2-CHANUNAVAIL,1,Goto(301-um1-pri0-try3,1)
exten => 301-um1-pri0-try3,1,Dial(Local/919543372199@trusted,15)
exten => 301-um1-pri0-try3,2,Goto(301-um1-pri0-try3-${DIALSTATUS},1)
exten => 301-um1-pri0-try3,3,Hangup
exten => 301-um1-pri0-try3-BUSY,1,Goto(301-um1-pri0-try4,1)
exten => 301-um1-pri0-try3-NOANSWER,1,Goto(301-um1-pri0-try4,1)
exten => 301-um1-pri0-try3-CONGESTION,1,Goto(301-um1-pri0-try4,1)
exten => 301-um1-pri0-try3-CHANUNAVAIL,1,Goto(301-um1-pri0-try4,1)
You will see a lot of '''Local/ @trusted''' numbers. Using this channel will allow you not to care about specific technology (like SIP, IAX2, SCCP or ZAP)

== Phoneline call routing ==
Is somehow similar to user call routing, However it doesn't allow fail steps (so if the action specified fails, the call will be sent to mailbox). You'll have to select what to do on each housemode.
=== How to use it ===
Go to Wizard > Devices > PhoneLines and then click on '''Settings''' on phoneline you want, and set the route you want

[[Image:Line_routing.png]]

=== Technical details ===
The same script which generates [[LinuxMCE_telecom_features#User_call_routing|user call routes]] also generates phone line routing. To fill this part of it, it looks into '''pluto_telecom : Line_HouseMode'''

This is a sample of what can be done:
exten => 100,1,VoiceMail(100)
exten => 100,2,Hangup
exten => 102,1,AGI(pluto-gethousemode.agi)
exten => 102,2,Goto(102-hm${HOUSEMODE},1)
exten => 102,3,Hangup
exten => 102-hm1,1,Dial(Local/200@trusted&Local/201@trusted,15)
exten => 102-hm1,2,Goto(102-hm1-${DIALSTATUS},1)
exten => 102-hm1,3,Hangup
exten => 102-hm1-BUSY,1,Goto(100,1)
exten => 102-hm1-NOANSWER,1,Goto(100,1)
exten => 102-hm1-CONGESTION,1,Goto(100,1)
exten => 102-hm1-CHANUNAVAIL,1,Goto(100,1)
exten => 102-hm2,1,Macro(vm,301)
exten => 102-hm2,2,Goto(102-hm2-${DIALSTATUS},1)
exten => 102-hm2,3,Hangup
exten => 102-hm2-BUSY,1,Goto(100,1)
exten => 102-hm2-NOANSWER,1,Goto(100,1)
exten => 102-hm2-CONGESTION,1,Goto(100,1)
exten => 102-hm2-CHANUNAVAIL,1,Goto(100,1)
exten => 102-hm3,1,Dial(Local/200@trusted&Local/201@trusted,15)
exten => 102-hm3,2,Goto(102-hm3-${DIALSTATUS},1)
exten => 102-hm3,3,Hangup
exten => 102-hm3-BUSY,1,Goto(100,1)
exten => 102-hm3-NOANSWER,1,Goto(100,1)
exten => 102-hm3-CONGESTION,1,Goto(100,1)
exten => 102-hm3-CHANUNAVAIL,1,Goto(100,1)
exten => 102-hm4,1,Macro(vm,301)
exten => 102-hm4,2,Goto(102-hm4-${DIALSTATUS},1)
exten => 102-hm4,3,Hangup
exten => 102-hm4-BUSY,1,Goto(100,1)
exten => 102-hm4-NOANSWER,1,Goto(100,1)
exten => 102-hm4-CONGESTION,1,Goto(100,1)
exten => 102-hm4-CHANUNAVAIL,1,Goto(100,1)
exten => 102-hm5,1,Goto(voice-menu-pluto-custom,s,1)
exten => 102-hm5,2,Goto(102-hm5-${DIALSTATUS},1)
exten => 102-hm5,3,Hangup
exten => 102-hm5-BUSY,1,Goto(100,1)
exten => 102-hm5-NOANSWER,1,Goto(100,1)
exten => 102-hm5-CONGESTION,1,Goto(100,1)
exten => 102-hm5-CHANUNAVAIL,1,Goto(100,1)
exten => 102-hm6,1,Dial(Local/919543373199@trusted,15)
exten => 102-hm6,2,Goto(102-hm6-${DIALSTATUS},1)
exten => 102-hm6,3,Hangup
exten => 102-hm6-BUSY,1,Goto(100,1)
exten => 102-hm6-NOANSWER,1,Goto(100,1)
exten => 102-hm6-CONGESTION,1,Goto(100,1)
exten => 102-hm6-CHANUNAVAIL,1,Goto(100,1)

== Priority callers and callers for me ==
This feature allows user to route differently calls coming from some numbers.

'''Priority caller''' implies possibility of different routing when dialing a user.
:For example your mother is a priority caller, you don't want to miss a call from her, because when she finally reaches you, you'll be in big trouble

'''Caller for me''' will be redirected to user extension instead of playing voicemenu when "Prompt user to choose extension or user" is selected as an option for given housemode.
:The call from your boss is a call for you and not for your wife. Your wife's boss is a caller for your wife and not for you.

A caller for me will be treated as priority caller for me but the reverse is not true.
:Meaning that call from your boss will be as special as the call from your mother (or you can be fired). But If your mother is calling, it doesn't always mean that she wants to talk with you, maybe she wants to speak with her grandchildren, but if she wants to talk to you, then she is treated as a priority caller.

=== How to use it ===
Go to Telecom > PriorityCallers and set priority callers for each user.

Then go to Telecom > CallersForMe and set callers for each user.

Pay attention how you set up those numbers, no checks are done if the same number is a 'caller for me' for more than one user.

=== Technical details ===
In dialplan we call ''pluto-getusermode.agi'' and ''pluto-callersforme.agi'' scripts which both are responsible to take care of call.
The data is also stored in '''pluto_telecom''' database

== Blind transfer of a call ==
Allows you to redirect an ongoing call to another destination.

=== How to use it ===
When you are speaking on an [[SimplePhone|Orbiter's Emmbedded Phone]] you can simply press a button Transfer and select a device or a user or a outside number. In this case you'll hangup and the call will be redirected to destination chosen by you. It will call directly a device or outside number or will follow the user's routing.

=== Technical details ===

CMD_PL_Transfer is sent to [[Telecom_Plugin]] with ''bIsConference=false'' which will send CMD_PBX_Transfer to [[LinuxMCE-asterisk|Asterisk]] with exact extension (3xx for a user, 2xx for device). The Asterisk will send a ''redirect'' command to [[asterisk-LinuxMCE|asterisk]].

If the call is already a conference call then it will continue to be conference call and you'll have to hangup manually.

== Conference calls ==
Allows you to have conference with many phones.

It doesn't use asterisk's standard [http://www.voip-info.org/wiki-Asterisk+cmd+MeetMe MeetMe] because it needs a zaptel card for realtime clock. Instead we use [http://www.voip-info.org/wiki/index.php?page=Asterisk+cmd+conference app_conference] which is not standard, but works remarkably well.

=== How to use it ===
When you are speaking on an Orbiter's Emmbedded Phone you can simply press a button Conference and select a device or a user or a outside number. In this case you and your party will join in next available conference room, and the selected extention will join you into the conference.

=== Technical details ===

CMD_PL_Transfer is sent to [[Telecom_Plugin]] with ''bIsConference=true'' which will send CMD_PBX_Transfer to [[LinuxMCE-asterisk|Asterisk]]. The Asterisk will send a redirect command to [[asterisk-LinuxMCE|asterisk]] (so far very similar with transfer), but that redirect command will have an additional channel to allow both channels to enter conference room.

Then [[Telecom_Plugin]] sends CMD_PL_External_Originate to invite the other party to join the conference room.

== Join existing call ==
Give you the possibility to join the existing conversation, practically putting it into a conference room and adding more phones to it.

=== How to use it ===
When there is an ongoing call you can see it by going to telecom floor plan. Select one or more devices and click in datagrid on the call you want to join. The call will be put into a conference room and selected devices will be invited to join it.

=== Technical details ===
Check CMD_PL_Join_Call in [[Telecom_Plugin]], is the one responsable for whole thing, practically it parses channels, devices deciding what devices are already in the call, and what need fo be added, and then
* sends CMD_PL_Transfer with ''bIsConference=true'' if a conference need to be created
* just invites new devices into the conference if the call is already a conference
* do nothing if no new devices are selected

Also by clicking on that datagrid you will bring up the call in progress screen on all [[SimplePhone]]s connected in that call.

== Phonebook, speeddial ==
Allows user to dial a number from phonebook and to define speed dial scenarios (like call mother from certain phone, by one click from orbiter)

=== How to use it ===
To add entries in phone book please go to Telecom > PhoneBook, add an entry there. Then on orbiter go to Phone > PhoneBook. Type first letters and select the contact you want to call.

Speed dial can be found in Wizard > Scenarios -> TelecomScenarios. Add an entry there, regen all orbiters. then try to call by pressing the button in main telecom menu, or by selecting it from Phone > SpeedDial datagrid.

:Note : A quick reload my be needed after adding entries and actually using them.

Also is a good idea to check ''Dial As'' phone number. There is a kind of autocomplete when you are adding a new phonebook entry, but better safe than sorry :)

=== Technical details ===
Not to much details, I wrote filling the SpeedDial datagrid and calling CMD_PL_Originate on click with right parameters.

Speed dial from the orbiter is done somewhere else.

Phone Book was already implemented and working.

== Voice mail ==
Asterisk has voicemail recording capability. We store voicemail for each user and also all 'outside' calls sent to voicemail will be stored in mailbox 100 which is default voicebox for the house. The problem usually is not the storage of voicemail, but actually the retrieval of the voicemail.

=== How to use it ===
As a LinuxMCE user you have several ways to check your voicemail :
* from any phone in the house dial "*98" followed by mailbox number (like "301") and access password (initially it's same "301"). Then you are presented to a voice menu which allows you to change password, listen to messages and so on.
* from webpage go to Telecom > MyVoiceMail. You'll se an interface which allows you to check your voicemail
* NOT COMPLETED : There should be an indicator about how many voicemails (new/old) a user have, and a datagrid which will alow to listen to voicemail from the orbiter.

=== Technical details ===
Voicemail is stored in ''/var/lib/asterisk/sounds/voicemail/default/XXX/INBOX/'', where XXX is mailbox number (same as extension). Old voicemail is moved from that path into ''.../Old/''.

[[LinuxMCE-asterisk|Asterisk]] sends an event when voicemail count changes. [[Telecom_Plugin]] catches it, process a little and sends CMD_Set_Bound_Icon to all orbiters. Datagrid is implemented but I never tested it. It will use same web interface to allow playing messages on any MD.

: Need to know : [[asterisk-LinuxMCE|asterisk]] creates voicemail files with bad permissions (asterisk:asterisk), so ''asterisk_keep_running.pl'' will show voicemail once in about a minute to asterisk:www-data. So it's not good idea to check voicemail from web interface immediately after the message was left.
==Black list==
Asterisk has a convenient blacklist functionality. It can be used to block persistent telemarketers, surveys, etc. The caller gets a short message that the line is not in service. The call is not transferred to any extension, but simply hang up.
===How to use it===
To enable the blacklist, go to the FreePBX control panel by navigating to ''advanced -> configuration -> phones setup'' in the LinuxMCE web admin tool. Once in the FreePBX panel, click on the ''Tools'' tab and then ''Module admin''. Click on the link ''Check for updates online''. A list of available modules will appear on the screen. Under the category ''CID & Number Management'' you will find a module called ''Blacklist''. Click on the link, check the ''Download and Install'' radio button and click ''Process'' at the bottom (or top) of the page. Once installation completed, go back to the ''Setup'' tab, now you will have the blacklist module to the left. Click on it and add any number to the list. Your changes will take effect immediately.
[[Category: Programmer's Guide]]
[[Category: Tutorials]]

Adding new web links

2011-06-09T16:43:51Z

Dan249:

Adding new web links

2011-06-06T04:13:23Z

Dan249:

{{versioninfo | 810Status=Compatible | 810UpdatedDate=5 June 2011 | 810UpdatedBy=Dan249}}

It is possible to add new web links to the computing page. This technique tells Firefox to make changes to the Bookmarks.html file, it does not make the changes to bookmarks.html file by default. In order for web links to show up on the Computing page within an orbiter, you have to add the link in Firefox from a [[Media Director]]. Here is the easiest method for adding new bookmarks.
* Browse to Computing screen and select one of the preloaded "Web bookmarks". This will open up a Firefox browser on the Media Director.
* At Address bar type "about:config" without quotes and press enter.
* click the "I'll be careful, I promise button".
* Either enter "browser.bookmarks.autoExportHTML", without quotes in the filter or scroll down screen to that field.
* Double click that field which changes it to true from the default false. Make sure you chose the right field.
* Browse the web like any normal web browser and when you find a page of interest
* Add your new bookmark
* ''' NOTE: you must close the browser with File->Quit.'''
* Reopen the Computing screen,
** Your new bookmarks will be visible.

'''IMPORTANT: If you close the browser by using the LinuxMCE buttons at the bottom of the screen your bookmarks will not be saved!'''

[[Category : Tutorials]]

Adding new web links

2011-06-06T04:12:23Z

Dan249:

{{versioninfo | 810Status=Compatible | 810UpdatedDate=5 June 2011 | 810UpdatedBy=Dan249}}

It is possible to add new web links to the computing page. This technique tells Firefox to make changes to the Bookmarks.html file, it does not make the changes to bookmarks.html file by default. In order for web links to show up on the Computing page within an orbiter, you have to add the link in Firefox from a [[Media Director]]. Here is the easiest method for adding new bookmarks.
* Browse to Computing screen and select one of the preloaded "Web bookmarks". This will open up a Firefox browser on the Media Director.
* At Address bar type "about:config" without quotes and press enter.
* click the "I'll be careful, I promise button.
* Either enter "browser.bookmarks.autoExportHTML", without quotes in the filter or scroll down screen to that field.
* Double click that field which changes it to true from the default false. Make sure you chose the right field.
* Browse the web like any normal web browser and when you find a page of interest
* Add your new bookmark
* ''' NOTE: you must close the browser with File->Quit.'''
* Reopen the Computing screen,
** Your new bookmarks will be visible.

'''IMPORTANT: If you close the browser by using the LinuxMCE buttons at the bottom of the screen your bookmarks will not be saved!'''

[[Category : Tutorials]]

Adding new web links

2011-06-06T04:08:59Z

Dan249:

{{versioninfo | 810Status=Compatible | 810UpdatedDate=5 June 2011 | 810UpdatedBy=Dan249}}

It is possible to add new web links to the computing page. This technique tells Firefox to make changes to the Bookmarks.html file, it does not make the changes to bookmarks.html file by default. In order for web links to show up on the Computing page within an orbiter, you have to add the link in Firefox from a [[Media Director]]. Here is the easiest method for adding new bookmarks.
* Browse to Computing screen and select one of the preloaded "Web bookmarks". This will open up a Firefox browser on the Media Director.
* At Address link type about:config and press enter.
* click the "I'll be careful, I promise button.
* Either enter "browser.bookmarks.autoExportHTML" in the filter or scroll down screen to that field.
* Double click that field which changes it to true from the default false. Make sure you chose the right field.
* Browse the web like any normal web browser and when you find a page of interest
* Add your new bookmark
* ''' NOTE: you must close the browser with File->Quit.'''
* Reopen the Computing screen,
** Your new bookmarks will be visible.

'''IMPORTANT: If you close the browser by using the LinuxMCE buttons at the bottom of the screen your bookmarks will not be saved!'''

[[Category : Tutorials]]

Adding new web links

2011-06-06T04:03:58Z

Dan249:

{{versioninfo | 810Status=Compatible | 810UpdatedDate=5 June 2011 | 810UpdatedBy=Dan249}}

It is possible to add new web links to the computing page. This can be used until the new
Web Browser is ready! This technique tells Firefox to make changes to the Bookmarks.html file. In order for web links to show up on the Computing page within an orbiter, you have to add the link in Firefox from a [[Media Director]]. Here is the easiest method for adding new bookmarks.
* Browse to Computing screen and select one of the preloaded "Web bookmarks". This will open up a Firefox browser on the Media Director.
* At Address link type about:config and press enter.
* click the "I'll be careful, I promise button.
* Either enter "browser.bookmarks.autoExportHTML" in the filter or scroll down screen to that field.
* Double click that field which changes it to true from the default false. Make sure you chose the right field.
* Browse the web like any normal web browser and when you find a page of interest
* Add your new bookmark
* ''' NOTE: you must close the browser with File->Quit.'''
* Reopen the Computing screen,
** Your new bookmarks will be visible.

'''IMPORTANT: If you close the browser by using the LinuxMCE buttons at the bottom of the screen your bookmarks will not be saved!'''

[[Category : Tutorials]]

Adding new web links

2011-06-06T03:59:16Z

Dan249:

{{versioninfo | 810Status=Compatible | 810UpdatedDate=5 June 2011 | 810UpdatedBy=Dan249}}

It is possible to add new web links to the computing page. This can be used until the new
Web Browser is ready! This technique tells Firefox to make changes to the Bookmarks.html file. In order for web links to show up on the Computing page within an orbiter, you have to add the link in Firefox from a [[Media Director]]. Here is the easiest method for adding new bookmarks.
* Browse to Computing screen and select one of the preloaded "Web bookmarks". This will open up a Firefox browser on the Media Director.
* At Address link type about:config and press enter.
* click the "I'll be cafeful, I promise button.
* Either enter "browser.bookmarks.autoExportHTML" in the filter or scroll down screen to that field.
* Double click that field which changes it to true from the default false. Make sure you chose the right field.
* Browse the web like any normal web browser and when you find a page of interest
* Add your new bookmark
* ''' NOTE: you must close the browser with File->Quit.'''
* Reopen the Computing screen,
** Your new bookmarks will be visible.

'''IMPORTANT: If you close the browser by using the LinuxMCE buttons at the bottom of the screen your bookmarks will not be saved!'''

[[Category : Tutorials]]

Adding new web links

2011-06-06T03:58:24Z

Dan249:

{{versioninfo | 810Status=Compatible | 810UpdatedDate=5 June 2011 | 810UpdatedBy=Dan249}}

It is possible to add new web links to the computing page. This can be used until the new
Web Browser is ready! This technique tells Firefox to make changes to the Bookmarks.html file. In order for web links to show up on the Computing page within an orbiter, you have to add the link in Firefox from a [[Media Director]]. Here is the easiest method for adding new bookmarks.
* Browse to Computing screen and select one of the preloaded "Web bookmarks". This will open up a Firefox browser on the Media Director.
* At Address link type about:config and press enter.
* click "I'll be cafeful, I promise button.
* Either enter "browser.bookmarks.autoExportHTML" in the filter or scroll down screen to that field.
* Double click that field which changes it to true from the default false. Make sure you chose the right field.
* Browse the web like any normal web browser and when you find a page of interest
* Add your new bookmark
* ''' NOTE: you must close the browser with File->Quit.'''
* Reopen the Computing screen,
** Your new bookmarks will be visible.

'''IMPORTANT: If you close the browser by using the LinuxMCE buttons at the bottom of the screen your bookmarks will not be saved!'''

[[Category : Tutorials]]

Adding new web links

2011-06-06T03:56:57Z

Dan249:

{{versioninfo | 810Status=Compatible | 810UpdatedDate=5 June 2011 | 810UpdatedBy=Dan249}}

It is possible to add new web links to the computing page. This can be used until the new
Web Browser is ready! This technique tells Firefox to make changes to the Bookmarks.html file. In order for web links to show up on the Computing page within an orbiter, you have to add the link in Firefox from a [[Media Director]]. Here is the easiest method for adding new bookmarks.
* Browse to Computing screen and select one of the preloaded "Web bookmarks". This will open up a Firefox browser on the Media Director.
* At Address link type about:config and press enter.
* click "I'll be cafeful, I promise button.
* Either input browser.bookmarks.autoExportHTML in the filter or scroll down screen to that field.
* Double click that field which changes it to true from the default false. Make sure you chose the right field.
* Browse the web like any normal web browser and when you find a page of interest
* Add your new bookmark
* ''' NOTE: you must close the browser with File->Quit.'''
* Reopen the Computing screen,
** Your new bookmarks will be visible.

'''IMPORTANT: If you close the browser by using the LinuxMCE buttons at the bottom of the screen your bookmarks will not be saved!'''

[[Category : Tutorials]]

Adding new web links

2011-06-06T03:52:30Z

Dan249:

{{versioninfo | 810Status=Compatible | 810UpdatedDate=5 June 2011 | 810UpdatedBy=Dan249}}

It is possible to add new web links to the computing page. This can be used until the new
Web Browser is ready! This technique tells Firefox to make changes to the Bookmarks.html file. In order for web links to show up on the Computing page within an orbiter, you have to add the link in Firefox from a [[Media Director]]. Here is the easiest method for adding new bookmarks.
* Browse to Computing screen and select one of the preloaded "Web bookmarks". This will open up a Firefox browser on the Media Director.
* At Address link type about:config and press enter.
* click "I'll be cafeful, I promise button.
* Either input browser.bookmarks.autoExportHTML in the filter or scroll down screen to that field.
* Double click that field which changes it to true from the default false.
* Browse the web like any normal web browser and when you find a page of interest
* Add your new bookmark
* ''' NOTE: you must close the browser with File->Quit.'''
* Reopen the Computing screen,
** Your new bookmarks will be visible.

'''IMPORTANT: If you close the browser by using the LinuxMCE buttons at the bottom of the screen your bookmarks will not be saved!'''

[[Category : Tutorials]]

Adding new web links

2011-06-06T03:52:12Z

Dan249:

{{versioninfo | 810Status=Compatible | 810UpdatedDate=5th June 2011 | 810UpdatedBy=Dan249}}

It is possible to add new web links to the computing page. This can be used until the new
Web Browser is ready! This technique tells Firefox to make changes to the Bookmarks.html file. In order for web links to show up on the Computing page within an orbiter, you have to add the link in Firefox from a [[Media Director]]. Here is the easiest method for adding new bookmarks.
* Browse to Computing screen and select one of the preloaded "Web bookmarks". This will open up a Firefox browser on the Media Director.
* At Address link type about:config and press enter.
* click "I'll be cafeful, I promise button.
* Either input browser.bookmarks.autoExportHTML in the filter or scroll down screen to that field.
* Double click that field which changes it to true from the default false.
* Browse the web like any normal web browser and when you find a page of interest
* Add your new bookmark
* ''' NOTE: you must close the browser with File->Quit.'''
* Reopen the Computing screen,
** Your new bookmarks will be visible.

'''IMPORTANT: If you close the browser by using the LinuxMCE buttons at the bottom of the screen your bookmarks will not be saved!'''

[[Category : Tutorials]]

Adding new web links

2011-06-06T03:51:41Z

Dan249:

{{versioninfo | 810Status=Compatible | 810UpdateDate=5th June 2011 | 810UpdatedBy=Dan249}}

It is possible to add new web links to the computing page. This can be used until the new
Web Browser is ready! This technique tells Firefox to make changes to the Bookmarks.html file. In order for web links to show up on the Computing page within an orbiter, you have to add the link in Firefox from a [[Media Director]]. Here is the easiest method for adding new bookmarks.
* Browse to Computing screen and select one of the preloaded "Web bookmarks". This will open up a Firefox browser on the Media Director.
* At Address link type about:config and press enter.
* click "I'll be cafeful, I promise button.
* Either input browser.bookmarks.autoExportHTML in the filter or scroll down screen to that field.
* Double click that field which changes it to true from the default false.
* Browse the web like any normal web browser and when you find a page of interest
* Add your new bookmark
* ''' NOTE: you must close the browser with File->Quit.'''
* Reopen the Computing screen,
** Your new bookmarks will be visible.

'''IMPORTANT: If you close the browser by using the LinuxMCE buttons at the bottom of the screen your bookmarks will not be saved!'''

[[Category : Tutorials]]

Adding new web links

2011-06-06T03:51:08Z

Dan249:

{{versioninfo | 810Status=Compatible | 810UpdateDate=5 June 2011 | 810UpdatedBy=Dan249}}

It is possible to add new web links to the computing page. This can be used until the new
Web Browser is ready! This technique tells Firefox to make changes to the Bookmarks.html file. In order for web links to show up on the Computing page within an orbiter, you have to add the link in Firefox from a [[Media Director]]. Here is the easiest method for adding new bookmarks.
* Browse to Computing screen and select one of the preloaded "Web bookmarks". This will open up a Firefox browser on the Media Director.
* At Address link type about:config and press enter.
* click "I'll be cafeful, I promise button.
* Either input browser.bookmarks.autoExportHTML in the filter or scroll down screen to that field.
* Double click that field which changes it to true from the default false.
* Browse the web like any normal web browser and when you find a page of interest
* Add your new bookmark
* ''' NOTE: you must close the browser with File->Quit.'''
* Reopen the Computing screen,
** Your new bookmarks will be visible.

'''IMPORTANT: If you close the browser by using the LinuxMCE buttons at the bottom of the screen your bookmarks will not be saved!'''

[[Category : Tutorials]]

Adding new web links

2011-06-06T03:46:56Z

Dan249:

{{versioninfo | 810Status=Relevant | 810UpdateDate=5 June 2011 | 810UpdatedBy=Dan249}}

It is possible to add new web links to the computing page. This can be used until the new
Web Browser is ready!
In order for web links to show up on the Computing page within an orbiter, you have to add the link in Firefox from a [[Media Director]]. Here is the easiest method for adding new bookmarks.
* Browse to Computing screen and select one of the preloaded "Web bookmarks". This will open up a Firefox browser on the Media Director.
* At Address link type about:config and press enter.
* click "I'll be cafeful, I promise button.
* Either input browser.bookmarks.autoExportHTML in the filter or scroll down screen to that field.
* Double click that field which changes it to true from the default false.
* Browse the web like any normal web browser and when you find a page of interest
* Add your new bookmark
* ''' NOTE: you must close the browser with File->Quit.'''
* Reopen the Computing screen,
** Your new bookmarks will be visible.

'''IMPORTANT: If you close the browser by using the LinuxMCE buttons at the bottom of the screen your bookmarks will not be saved!'''

[[Category : Tutorials]]

Howto: Using Network Shares

2011-06-04T18:21:45Z

Dan249:

{{versioninfo}}
{| align="right"
| __TOC__
|}
[[Category: Tutorials]]
[[Category: Network Attached Storage]]

The LinuxMCE core is able to auto-detect, configure and use Windows (SMB or CIFS) and *nix (NFS) network shares. This document details the different options for using network shares in LinuxMCE and the actions required to successfully configure them, when the automated discovery processes fail.

== Network Share Use ==

Network shares are accessed in LinuxMCE using symbolic links created in the media storage directories, either in ''/home/public/data'' in the case of public shares, or in ''/home/<user_name>/data'' if the share has been assigned to a user.

LinuxMCE offers two alternatives for use of network shares:

# Using LinuxMCE's directory structure
# As a simple storage area, either public or private

=== Network Share Using LinuxMCE's Directory Structure ===

In this case LinuxMCE uses separate directories on the share for each user, with media sub-directories in each one. These directory trees are created if they do not already exist on the share.

For a typical Windows share, the storage layout will look like this:

my_share\public\audio
my_share\public\documents
my_share\public\pictures
my_share\public\videos
my_share\<user_1>\audio
my_share\<user_1>\documents
my_share\<user_1>\pictures
my_share\<user_1>\videos

=== Network Share As a Simple Storage Device ===

In this case the share will simply be attached either to the ''public'' storage or to a specified user, using a symbolic link in the ''other'' media directory. For example:

/home/public/data/other/my_share

or:

/home/<user_1>/data/other/my_share

== Adding Network Shares Using Auto-Detection and the Orbiter ==

Adding a new network share to LinuxMCE consists of two stages: Adding the computer hosting the share as a ''File Server'', and then adding each share on this computer.

=== Adding a File Server ===

# Ensure that the file server is active and connected to your network.
# Quick-reload the router. In the Orbiter, click ''More -> Advanced options -> Quick reload router''.
# The orbiter will display a message identifying the detected network share, and ask what you would like to do with this share. Click ''File Server''.
# The orbiter will ask for the user name and password for this file server. If the file server does not require a login, simply click ''Ok''.
# The orbiter will inform you that the File Server has been created, and ask which room the file server is in.

This concludes the first stage. LinuxMCE will now proceed to detect and configure any available shares on this file server. At some point, the message "I finished installing the software for your new devices. You will need to restart the router before you can use them" will be displayed. You can press ''Ok'' to dismiss the message, but you should not reload the router as this will interrupt the share configuration process.

=== Adding File Shares ===

# For each available file share on your new file server, the orbiter will display the share name and ask what you would like to do with it. The list will contain a single option - either ''Windows Share'' or ''NFS Share''. Click this option.
# The orbiter will ask if the new storage device can be used automatically for storing media. If you select ''Yes'', LinuxMCE will store ripped CDs and DVDs and recorded TV shows on this device.
# The next orbiter screen will ask you to select if you would like to use LinuxMCE's directory structure on the new storage device. You have three options:
## Use LinuxMCE's directory structure
## Access the device content as-is and make it public
## Access the device content as-is and make it private for a selected user

When you have finished with this process, quick-reload the router.

== Troubleshooting and Manual Configuration ==

The automated configuration process can fail at several places. This section explains how to complete the configuration in each case, using the LinuxMCE admin website and a Linux shell.

For all processes described below, start by navigating to the ''devices tree'' in the administration site: Either click ''show devices tree'' in the left-hand '''Wizard''' menu, or select ''Advances -> configuration -> Devices'' from the top menu.

To enter shell commands, either press ''Ctrl+Alt+F2'' on the core console, or use SSH to connect to the core from another computer. In either case, log in using the user account you created when installing Ubuntu. When running a ''sudo'' operation, enter the password of the same user.

=== Manual Creation of a File Server ===

In case LinuxMCE fails to detect your file server, or if it detected it in the past and you selected to ignore it:

# Click ''Core'' in the left-hand navigation tree.
# Click ''Create Child Device'' in the main window.
# Enter the file server's description and IP address.
# Click ''Pick device template''.
# In the ''Device Category menu'' select ''File/Media Server''.
# Click ''Apply Filter''.
# In the ''Device Template'' menu select ''File Server''.
# Click ''Pick device template''.
# If the file server requires a login, in the ''Device data'' section, enter the username and password for the file server, and check ''Password Required''. Then click ''Save''.
# Note the device number of the new file server, displayed at the top of the main window.
# In the shell, trigger the network share detection script for the new file server:

sudo /usr/pluto/bin/Configure_1837.sh -d <device number>

At this point, return to the orbiter to continue the automated process.

=== Manual Creation of Network Shares ===

In case LinuxMCE fails to detect the shares on your file server:

# In the left-hand navigation tree, locate and click the file server entry.
# Click ''Create Child Device'' in the main window.
# Click ''Pick device template''.
# In the ''Device Template'' menu select the appropriate share type for your file server.
# Click ''Pick device template'' to select and close the window.
# In the ''Device data'' area, fill in:
## '''PK_Users''': Leave empty for a public share, or select the desired user [Starting with 0710, select "''Public''", "''Pluto's structure''", or a user name. "''Public''" will mount under data/other.]
## '''Share Name''' (if the share is \\my_server\my_share, enter ''my_share'')
## '''Filesystem''': ''cifs'' for Windows shares, ''nfs'' for *nix shares
## Check '''Use Automatically''' if desired
## '''Username''', '''Password''' and '''Password Required''' if the file server requires login.

LinuxMCE should now mount your new share and create the required links to make your data available.

'''NOTE''': I have not been able to find how to select to use LinuxMCE's directory structure in this process.

== Advanced Configuration Options ==

Network shares use can be further customized using the LinuxMCE admin site. To use the following options, navigate to the network share device and scroll to the ''Device data'' section.

* '''Directories''': When a share is configured to use LinuxMCE's directory structure, it will by default be used in all media directories: ''audio, documents, pictures'' and ''videos''. You can restrict which media directories will be used by entering their names in this field, separated by commas.
* '''Readonly''': checking this option will make LinuxMCE mount the share as read-only. This will stop LinuxMCE from creating .id3 files for all your videos, and from modifying the MP3 tags of your music files.

== NFS Server Hints ==

If you are wanting to have a linux system be your server, here are a few hints.

As of 0710 beta 3, LinuxMCE requires your sever to be very open (insecure). You must allow root access to the share as LinuxMCE writes files as root:public.

So on the server to share /var/media, assuming your core is at 192.168.80.1, you need to add your share to the /etc/exports like:

/var/media/ 192.168.80.1(async,no_subtree_check,rw,no_root_squash)

Ownership in your share of media files should be: root:public (0:1002) and permissions should be set to 2775 (rwxrwsr-x)

You may need to change a groupid if another group is already using 1002. The process will vary depending on your system, but here are the general steps:
# examine /etc/groups and find an unused group id to move the conflicting group to. This example will use 1234 for the new group id.
# find all files with that currently have 1002 groupid: find / -group 1002 -print
#* if it's just a few files then you can change their group id with: chgrp 1234 filename
#* if it's a lot of files, then you might prefer using the find command: find / -group 1002 -exec chgrp 1234 '{}' \;
# now double check that you changed all the files with group id 1002: find / -group 1002 -print
# edit /etc/groups and change the group id for the conflicting group from 1002 to the new group id (1234 in this example)
# while editing /etc/groups, edit or add the public group with a group id of 1002
# save /etc/groups
# if the conflicting group was for a service, then restart the service.
# if the service was one of the critical service (mine was hald), I'd go ahead and reboot the box.