Official Kodi Wiki - User contributions [en]

NFO files

2014-01-06T10:31:21Z

Bakslash: /* Importing library information from "My Movies" media management software */

{{mininav|[[General topics]]|[[Videos]] {{l2|[[Music/Audio]]}}|[[Video library/Management|Management]] <br />  }}
<section begin="intro" />NFO files can be used to provide data for a video file in XBMC or influence the search behaviour of scrapers. In particular they are helpful if the information fetched from a web site does not match the video file, or data for that particular file does not exist.<section end="intro" />

By default at the time of scanning, if the media folder contains a correctly named *.nfo file, then XBMC will load the *.nfo file and attempt to either, in the case of it containing XML data get the meta-data directly from the .nfo file or will parse it for a direct URL to the scraper info page. This allows XBMC to skip its normal lookup and/or search procedures; this is useful if a file's information is not available on any of the scraper sites or if the file-matching criteria fail for the particular file.

== Getting an .NFO file ==
Various options:

=== .NFO exists ===
If you have a movie with an .NFO file already, continue with the next section.

=== Create an .NFO file (recommended) ===
* This is recommended to have .NFO files only where needed.
* Create a text file with a text editor (e.g. notepad) with '''exactly the same name as the movie file''' (if all movies in one dir; in case each movie has its own folder, place the '''.nfo''' file there and the name does not matter). The extension has to be '''.nfo''' (e.g. ''Hellboy (2004) English.DTS.1080p.x264.nfo'').

=== Export .NFO files for all movies ===
* First you need to have all the movies scanned into your [[Video Library]].
* Once this is done you’ll need to export your library as a series of separate .NFO files. This can be done by going to [[Videos Settings|Settings > Video]] > Library and choosing Export Library. Make sure you choose the separate files option, and a bunch of .NFO files (one for every movie) will be dumped to the directories the movies are stored in.
{{tip|See '''[[Import-export library]]'''}}
* Once you have the .NFO you'll need to open it for all the movies in the series and add some info to them.

== NFO Examples ==

Below are the different sections explained on how to create specific nfo files for them.

* '''[[NFO files/movies|Movies]]'''
:* [[NFO files/movies#Movie sets|Movie sets]]
:* [[NFO files/movies#Movie tags|Movie tags]]

* '''[[NFO files/tvshows|TV Shows]]'''

:* '''[[NFO files/tvepisodes|TV Episodes]]'''

* '''[[NFO files/musicvideos|Music videos]]'''

* '''[[NFO files/music|Music]]'''

== Importing library information from "My Movies" media management software ==
[http://www.mymovies.dk/ My Movies (www.mymovies.dk)] is an online database for profiling DVD-Video movies. [http://www.mymovies.dk/ My Movies] saves an XML file and a poster cover image which with this patch will get scanned by XBMC in the same way as XBMC's own XML formatted NFO files are scanned/scraped.

XBMC has the ability to get the import movie library information from "[http://www.mymovies.dk/ My Movies]" via the mymovies.xml files that it generates, these mymovies.xml are checked after the movie.nfo file.

[[Category:Scraper]]
[[Category:Video Library]]
[[Category:Music Library]]
[[Category:XBMC Manual]]
{{frodo updated}}

NFS

2013-12-23T01:29:00Z

Bakslash: /* NFS sharing from Windows */

<section begin="intro"/>'''Network File System''', or '''[http://en.wikipedia.org/wiki/Network_File_System_%28protocol%29 NFS]''', is a way to share folders over a network, and was added to XBMC in v11 (Eden). The main benefits of using NFS instead of SMB are its low protocol overhead (which allows it to send data across a network more quickly) and its use of simple [http://en.wikipedia.org/wiki/User_identifier UID's] to authenticate users rather than username/password combinations. This part bears repeating, as many people are confused on this point and try to create usernames and passwords to get XBMC to work with NFS: '''NFS does not use usernames or passwords as logins;''' it uses a UNIX-based "userID" (UID) alone.<section end="intro"/>

NFS's main disadvantage in comparison to SMB (a commonly-encountered protocol in Windows environments) is that it can be more complicated to set up in some cases, since many non-technical users are unfamiliar with configuring UNIX-based protocols.

NFS is commonly found on all Linux/UNIX distributions, as well as on OS X and Solaris, and offers several features:
:* It is already incorporated in UNIX-like operating systems (such as OS X), eliminating the need for additional software and services to be installed on your computer.
:* It allows for authentication by UID, thus eliminating the need to save usernames and passwords in XBMC source XML files (note, however, that this simple authentication also makes it more vulnerable to attacks; NFS should be only used inside a private LAN).
:* Once properly configured, NFS will allow your network shares to be seen and accessed by not only XBMC, but also any other machine on your network.

;{{note|If you already have a working NFS server check that the export options required by XBMC have been set (as described in the relevant section below).}}

When configuring NFS shares to use as network sources for XBMC's music/video libraries, use the following format: '''nfs://1.2.3.4/path/to/folder''' (where "1.2.3.4" should be replaced with the IP of your NFS server, and "/path/to/folder" should be replaced with the path to the folder you want to share; a double slash between the server and the path is wrong, you '''should not''' use nfs://1.2.3.4//path/to/folder). See the sections below for help configuring NFS shares on various devices' operating systems.

For more info on network sources for your music and video in XBMC, see [[Types of Media Sources]].<br />

== NFS sharing from Windows ==
Windows does not have any built-in native ability to share folders via NFS; and only a limited selection of Windows operating systems have the native ability to access NFS shares as a client. However, several third-party solutions attempt to provide NFS functionality, on both the server side and the client side.

For ''serving'' (sharing) files from Windows using NFS, there seem to be three choices:
:* Windows Server 2003 R2, Windows Server 2008 and Windows Server 2012 have built-in NFS Server and Client through Subsystem for UNIX-based Applications (SUA). With 64-bit support, this solution supports files up to 4TB in size
:* [http://en.wikipedia.org/wiki/Microsoft_Windows_Services_for_UNIX Microsoft Windows Services for UNIX (SFU)] available [http://www.microsoft.com/download/en/details.aspx?id=274 here]for Windows 2000, Windows XP Professional (NOT Home edition, without a [http://www.networkedmediatank.com/showthread.php?tid=1434 hexedit hack]), Windows 2003 Server, and Windows Home Server (based on 2003 Server). SFU is 32-bit only, which ''may'' mean it only supports files up to 2GB in size, [http://www.suacommunity.com/SUA_Tools_Env_Start.htm#_Toc203389873 according to some sources] (this is unconfirmed). A good installation guide can be found [http://www.networkedmediatank.com/showthread.php?tid=1434 here]. Windows SFU will not install on Windows Vista or Windows 7, so there is no way to ''serve'' NFS from Windows Vista or Windows 7 with the possible exception of the haneWIN solution below, but it is unconfirmed if that works with Windows Vista/7.
:* [http://www.hanewin.net/nfs-e.htm haneWIN NFS Server for Windows] - a shareware program that costs 19EUR for non-commercial use. Claims to work for "Windows 2000 and above."

== NFS sharing from OS X ==
{{see also|NFS Manager}}
NFS is built into Mac OS X (OS 10.5 and later), and thus no additional software is required to set up NFS shares on a Mac OS X device.

;{{note|The following assumes some basic knowledge of the UNIX/BSD operating system interface and environment, and assumes you are familiar with using a Mac's Terminal command-line utility. It also assumes you have a beginner's understanding of UNIX text editors such as [http://mintaka.sdsu.edu/reu/nano.html nano] or [http://www.eng.hawaii.edu/Tutor/vi.html vi].}}

1. To allow regular (non-root) users to connect to your NFS shared folders, you'll need to edit the "/System/Library/LaunchDaemons/com.apple.nfsd.plist" file. Open it and add the option "-N" to the startup parameters as follows:

<array>
<string>/sbin/nfsd</string>
'''<string>-N</string>'''
</array>

If you don't do this step, XBMC will only be able to access the Mac's shared NFS folders if XBMC is running as root (normally, XBMC does not run as root, so you will almost certainly want to do this first step and add the -N parameter).

2. The NFS server and its shared folders are set up in a config file named "exports", located in the /etc directory. Technically speaking, with NFS you "export a path" rather than "share a folder" (which is why the file is named "exports"), but we'll use the latter phrasing for simplicity's sake.

The /etc/exports file may not yet exist; if not, you'll need to create it. The file is edited either manually (in Terminal, using a UNIX text editor such as '''nano''' or '''vi''') or via a GUI utility, the most well-known of which is [http://www.bresink.com/osx/NFSManager.html NFS Manager]. The following guide assumes you are using Terminal (if using NFS Manager, consult that software's documentation for help).

To view the current contents of /etc/exports, if any, execute the following command in a Terminal window:

'''cat /etc/exports'''

Any folders to be shared via NFS should be listed on separate lines, along with any configuration parameters governing connections to those folders. The lines should follow this general format:

/path/to/folder_name_to_share [-parameter1 -parameter2 ...] <IP address restriction (optional)>

<big>Examples</big>

In this sample /etc/exports file, we've set up four folders to be shared via NFS, using various parameters and options. The folders are all contained in a folder called "nfs_shares", and are named to indicate some things about how we've set them up; obviously, on your system, the folder names would be things like "video", "music", and so on.

/nfs_shares/allread -ro -mapall=nobody -alldirs
/nfs_shares/allwrite -mapall=nobody -alldirs -network 192.168.1.0 -mask 255.255.255.0
/nfs_shares/writeAs501 -mapall=501 -alldirs 192.168.1.5
/nfs_shares/xbmcuser

Let's look at what each of these shared folder configurations means.

* The folder "'''/nfs_shares/allread'''" can be accessed from all computers (because no IP address is given), is read-only ("'''-ro'''"), and all incoming connections are assigned the same permissions as the UNIX user "nobody", who has anonymous access ("'''-mapall=nobody'''"). This last parameter ensures that anyone can access the folder, but they will not have any rights on your NFS server other than those belonging to the "nobody" user. Also, the "'''-alldirs'''" parameter is used to indicate that incoming connections can mount either the /allread folder OR any subfolder underneath /allread.

* The folder "'''/nfs_shares/allwrite'''" can be accessed from all computers on the subnet 192.168.1.0/255.255.255.0, has read and write permissions (we've omitted "'''-ro'''"), and again access rights for user "nobody" are assigned ("'''-mapall=nobody'''"). The "'''-alldirs'''" parameter is once again used to allow subfolders to be mounted directly.

* The folder "'''/nfs_shares/writeAs501'''" can be accessed from the computer with an IP of 192.168.1.5, has read and write permissions (again we've omitted "'''-ro'''"), and access rights belonging to users on your system with a UID of 501 (see note below) will be inherited by all incoming connections ('''-mapall=501'''). The "'''-alldirs'''" parameter is once again used to allow subfolders to be mounted directly.

:;{{note|As already mentioned, authentication to the NFS server is done by checking UIDs. For XBMC, this means that the UID which the XBMC process is running under is given to the NFS server to be authenticated. To find out your current UID, just type "id" into a console:}}

Mac:~ [''your_user_name'']$ '''id'''

::You should see something that begins like this:

uid=501(''your_user_name'')

:In this example, my UID is 501. If you are going to be connecting to your NFS shared folder from XBMC on iOS, keep in mind that on iOS XBMC runs as the user "mobile", which should have UID 501 also.

* The folder "'''/nfs_shares/xbmcuser'''" can be accessed from all computers ('''no ip given'''), readwrite (no "'''-ro'''") and the access rights belonging to the UID which is connecting to the NFS server are used ("'''-mapall'''" removed).
;{{note|The important effect of the absence of the -mapall parameter in this case: if someone connects to your NFS server as root, they will be running on your system as root! Also note that because "-alldirs" is not specified, incoming connections will only be able to connect to the /xbmcuser folder, NOT any folders underneath it.}}

Bear in mind that any UID's that are used to connect to the NFS server, or that are specified with "-mapall", have to exist on your NFS server (i.e. on your Mac).

'''Each change on the exports config file needs a restart of the nfs server! Just issue "sudo nfsd restart" for this.'''

3. Once you've configured and saved your /etc/exports file, the NFS server can be started either by rebooting or by executing the following command:

$ sudo nfsd start

=== Troubleshooting NFS on OS X ===

==== -N flag is set, but shares still won’t work ====

Sometimes there are issues with NFS shares on OS X. Most of them result in the <code>-N</code> flag not being set, but they result in different error messages or issues. One of the root issues is the flag being set in the Property List file, but not read by launchd which controls the process. The following observations are pretty common in this case and if you see one of these points, it won’t hurt to either inspect the nfsd process on your Mac or restart the whole computer.

* You have successfully shared the volume and you can mount it from other Macs in your network (via ⌘K in the Finder), but not from XBMC.
* You can add the computer share (e.g. <code>nfs://192.168.1.5/</code>), but not the share that contains a path (e.g. <code>nfs://192.168.1.5/nfs_shares/allread</code>).
* When you add the computer share, you can enter it in XBMC’s browser, but then clicking on one of the mount points does nothing.
* You see either '''"Server responded: Procedure not available"''' or '''"RPC Packet not accepted by the server"''' in the error logs.

In most cases it’s sufficient to restart nfsd via launchd, just killing the process with <code>kill -9</code> or <code>killall nfsd</code> after applying changes to the Property List file has no effects. To restart nfsd via launchd you have to type the following command in the Terminal:

sudo launchctl unload /System/Library/LaunchDaemons/com.apple.nfsd.plist && \
sudo launchctl load /System/Library/LaunchDaemons/com.apple.nfsd.plist

When you use <code>ps</code> to inspect the process, <code>-N</code> should be visible at the end of the line. If it’s not, then launchd didn’t apply the changes and just (re-)started nfsd with the old configuration. A proper output looks like this:

~ '''ps aux | grep nfsd'''
root 55828 0,0 0,0 2500812 2332 ?? Ss 3:54pm 0:08.96 /sbin/nfsd '''-N'''
chiefsucker 58788 0,0 0,0 2435268 496 s000 U+ 7:22pm 0:00.00 grep nfsd

Pay attention to the <code>-N</code> flag being visible in the ps output. If the <code>-N</code> flag is visible, but your shares don’t work, then it’s probably another issue.

==== NFS shares stopped working after OS X upgrade ====

If your share stopped working after you upgraded your OS (e.g. from Lion to Mountain Lion) then it usually means that the installer did overwrite the Property List file and you have to add <code>-N</code> again.

==== My Mac goes to sleep while playing a movie from a NFS share ====

OS X 10.8 Mountain Lion introduced some changes that result in very aggressive sleep behaviour. Because NFS shares aren’t handled and treated like shares set from within the Sharing panel in System Preferences, OS X will ignore clients that access your NFS shares and just put it to sleep. Fortunately there are some workarounds:

# Set '''Computer sleep''' in the Energy Saver pane of System Preferences to '''Never'''. Unfortunately this will affect the whole machine and you’ll have to put your Mac manually to sleep from now on.
# Get the [http://itunes.apple.com/app/caffeine/id411246225?mt=12 free Caffeine app from the Mac App Store]. The app will reside in your menu bar and you can prevent your Mac from sleeping with just one mouse-click. If you disable Caffeine (again with one click), your Mac will go to sleep as set in the System Preferences. This has the benefit of adjustable sleep behavior, i.e. you turn Caffeine on when you watch movies and you turn it off otherwise to preserve energy and save the planet.
# You can reach the same goal with the Terminal app <code>caffeinate</code> that gets shipped with the OS since OS X 10.8 Mountain Lion.

== NFS sharing from Linux ==

NFS sharing has been built into linux kernel for a long time.

;{{note|This article assumes some basic knowledge of the Linux/UNIX/BSD operating-system interface and environment.}}

The configuration of the NFS server takes place in the config file "/etc/exports". As already mentioned, the authentication to the NFS server is done through UIDs. For XBMC, this means the UID that the XBMC process is running under is used to authenticate on the NFS server. To find out what UID XBMC is using, just type "id" into a console:

penix:~ [your_user_name]$ id
uid=501(your_user_name)

In this example, my UID is 501. For iOS devices, keep in mind that XBMC is running as the user "mobile", whose UID should also be 501.

A basic configuration for exporting a path with NFS looks like this:

/nfs/export <ip or iprange which is allowed to connect>(rw,all_squash,insecure)

The important options here for use with XBMC are the "ip or iprange" and the "insecure" options. The "insecure" option is needed because we want to be able to run XBMC without root privileges. If the insecure option is not enabled, only the root user (uid 0) will have access to the nfs share. The "ip or iprange" specifies which hosts on the network will be allowed to access the exported NFS share.

By changing some of the options of that line, we can use any of three different approaches for getting the access rights configured as we want:

1. The option all_squash (most insecure) - all UIDs connected to the NFS server are mapped to UID 65534 (user nobody)
::* In this case all files which shall be accessed on the NFS exported path should have the correct rights for the user "nobody".
2. Using the option "all_squash" in conjunction with the option "anonuid" and "anongid"
::* By adding the options "anonuid=501" and "anongid=501" all accesses would be mapped to the user with UID 501 (user "mobile" on iOS or user "memphis" in my example above)
3. Removing the "all_squash" option the accesses will be done with the UID given from the user which is running XBMC
::* So if XBMC is started with username foobar (which has UID 1000) all accesses to the NFS export path will be made with UID 1000.

<big>Examples for exported paths:</big>
### access from ''all computers'' ("'''*'''"), ''readonly'' ("'''ro'''"), access for user ''nobody'' ("'''all_squash'''")
/nfs/allread *(ro,all_squash,insecure)

### access from the subnet 192.168.1.0/255.255.255.0, ''read/write'' ("'''rw'''"), access for user ''nobody''
### ("'''all_squash'''"). Remember that "'''rw'''" doesn't automatically allow writes; the user "nobody" must
### have write access to the path on the filesystem.
/nfs/allwrite 192.168.1.0/24(rw,all_squash,insecure)

### access from 192.168.1.5, ''read/write'' ("'''rw'''"), access for user with UID 501 (i.e. memphis, for me)
### ("'''all_squash,anonuid=501,anongid=501'''")
/nfs/writeAsMemphis 192.168.1.5(rw,all_squash,insecure,anonuid=501,anongid=501)

### access from ''all computers'' ("'''*'''"), ''read/write'' ("'''rw'''"), access for the UID connecting to the
### NFS server ("'''all_squash'''" removed)
/nfs/xbmcuser *(rw,insecure)

### NTFS export *SECURITY Warning: this gives the user ROOT access*
### access from the subnet 192.168.1.0/255.255.255.0, ''read/write'' ("'''rw'''"), nfs client connects
### as root ("'''no_root_squash'''"). Otherwise, permission is for ''nfsnobody'', (uid 65534).
### NTFS is non-POSIX permissions compliant, so you must access the share as ''root''
/nfs/NTFS_share 192.168.1.0/24(rw,'''no_root_squash''',insecure)

The UIDs which are used to connect to the NFS server or which are specified with "anonuid" and "anongid" have to exist on the NFS server. Otherwise the filesystem permission can't be set.

Remember - access rights are these you give in the filesystem. '''After each change to the exports config file issue "sudo exportfs -ra"!'''

== NFS sharing from NAS4Free 9.x (successor to legacy FreeNAS 7.x) ==
The information in the Linux section above also applies for *BSD based systems (such as FreeBSD). This section addresses some specific issues to bear in mind if you are using NAS4Free 9.x or FreeNAS 7.x (aka. legacy) installations.

;{{note|FREENAS 8.3.0-RELEASE or later does not require modifying the rc.conf file for XBMC to access NFS shares. You must however enable "allow non-root mount" which can be found under the SERVICES - NFS section in the Freenas 8.3.0 web GUI.}}

Setup your NFS shares as normal. Remember: don't create shares inside other shares. The following would be illegal...
/mnt/disk -alldirs,quiet -mapall=root -network 192.168.1.0 -mask 255.255.255.0
/mnt/disk/folder -alldirs,quiet -mapall=root -network 192.168.1.0 -mask 255.255.255.0
...because the "/mnt/disk/folder" directory is already shared by "/mnt/disk". If you remember to set the setting "All dirs" when creating your NFS shares, the flag "-alldirs" will be set. This flag allows you to mount any subdirectory of your share just as if it was a share itself. Said another way: It's not necessary to share "/mnt/disk/folder" because you can mount it through the "/mnt/disk" share.

After having set up a standard NFS share on your NAS4Free box, you need to add a few variables to rc.conf on NAS4Free. This is done by going into System > Advanced > rc.conf .
Here you need to add the following:
Variable Value Comment
mountd_flags -n Allow non-root mount requests to be served.
nfs_reserved_port_only NO Allow for insecure ports to be used by NFS.
nfs_server_flags -u -t -n 4 Serve UDP and TCP with 4 servers.

After this, apply your changes and reboot NAS4Free. You should now be able to mount your NFS shares, as well as any subdirectory of those shares.

== NFS sharing from ZFSGuru ==
Very similar to FreeNAS solution.
mountd needs the -n flag.
In ZFSGuru you can achieve this by adding
weak_mountd_authentication="YES"
to /etc/rc.conf

== NFS sharing from commercial NAS systems such as Synology or QNAP ==
Each NAS manufacturer, if it allows you to share folders via NFS on its NAS systems, does so in its own way. Often this will involve setup via the NAS's control panel or administrator interface. You can also connect to many NAS systems via ssh and manually edit files in order to set up and configure NFS (consult your NAS manual to see if this is possible/desirable/necessary). Since most NAS systems are based on Linux/UNIX, if you need to manually edit files, you should be able to make use of the [[#NFS sharing from Linux|Linux instructions above]] to create/edit your NFS shares.

=== Troubleshooting NFS on a commercial NAS with XBMC ===
Your NFS server on your NAS needs to be able to allow connections on so-called '''unprivileged ports''', which are port numbers higher than 1023. However, most NAS's are set up by default to deny incoming NFS connections on these unprivileged ports. This is one of the most common reasons why XBMC users experience problems when trying to connect to an NFS shared folder on a NAS.

If you are having trouble connecting to your NFS shares on your NAS from XBMC, make sure your NFS shares have the "insecure" option enabled, which will allow connections on unprivileged ports. To check, connect to your NAS via ssh and issue the '''cat /etc/exports''' command. Your shared folders will each have several parameters listed separated by commas. If the "insecure" parameter is not listed, you will need to add that parameter to the list. This will usually involve directly editing the /etc/exports file with a UNIX text editor and adding the "insecure" option manually, although some NAS's may offer the ability to add the option via an admin interface. Check your NAS manual for details, or explore the section below if your brand of NAS is listed.

=== Commercial NAS NFS setup instructions ===
XBMC users have contributed the following NFS setup instructions for various brands of NAS devices. If your NAS is listed below, feel free to follow the accompanying instructions to set up NFS on your system.

==== Synology ====
[[File:Synology.png|link=]]<br />
;{{note|You do not need to create a special user account on your Synology NAS in order to make use of NFS for XBMC. The following guide assumes you are comfortable with using the simplest (least secure) internal setup on your NAS, which will normally be the case for the vast majority of XBMC users.}}

<gallery widths=600px heights=340px>
File:Step1.png|'''<big>Step 1:</big>''' Log in to your Synology admin control panel.
File:Step2.png|'''<big>Step 2:</big>''' Enable SSH (if not enabled already): Control Panel --> Terminal --> Enable SSH service --> {{button|OK}}

File:Step3.png|'''<big>Step 3:</big>''' Enable NFS under Control Panel --> Win/MAC/NFS
File:Step4.png|'''<big>Step 4:</big>''' NFS Services --> Enable NFS --> {{button|OK}}

File:Step5.png|'''<big>Step 4:</big>''' Under Control Panel --> Shared Folder
File:Step6.png|'''<big>Step 6:</big>''' On NFS Privileges tab select entry for the folders you want to share e.g. '''Movies'''
File:Step7.png|'''<big>Step 7:</big>''' {{button|Create}} privileges for the selected share
File:Step8.png|'''<big>Step 8:</big>''' As per example allow all IPs (or the desired IP for your HTPC) with '''read/write''' permissions with no mapping and enable '''asynchronous'''. The option to '''allow connections from non-priviledged hosts''' is new in DSM version 4.3-3776. With this option the following steps 10 to 14 are no longer needed. --> {{button|OK}}
File:Step9.png|'''<big>Step 9:</big>''' Press {{button|OK}}
</gallery>

10. On your computer, in a command line window (Terminal on a Mac, CMD on a Windows PC, etc), ssh into your Synology:
'''ssh root@<<YOUR.SYNOLOGY.IP.ADDRESS>>'''
11. Type in '''cat /etc/exports''' to make sure your previous steps have created exported NFS directories. If no entries are found, go back to the previous steps and make sure you've followed them correctly. You should be seeing something like this:

[[File:Step11.png|600px]]

12. Type '''vi /etc/exports''' to edit the /etc/exports file, and change all the "insecure_locks" entries to simply read "insecure". If you don't know vi: press the INS[SERT] key, use arrows to go to the line to edit, and delete/edit the line. Then press the ESC key, and type ''':x''' to 'Save & Exit'.<br />
13. Type '''cat /etc/exports''' again, and you should now see something like this (make sure it says "insecure" rather than "insecure_locks"):

[[File:Step15.png|600px]]

14. Type '''exportfs -ra''' to initialize your newly exported directories, or reboot the NAS.<br />
15. You should now be able to browse NFS and get to your exported Synology subfolders in XBMC.<br />

==== QNAP ====
[[File:QNAP.gif|link=]]<br />
;{{note|You do not need to create a special user account on your QNAP NAS in order to make use of NFS for XBMC. The following guide assumes you are comfortable with using the simplest (least secure) internal setup on your NAS, which will normally be the case for the vast majority of XBMC users.}}

This guide requires you to [[SSH]] into your QNAP, and also to use the terminal editor [http://en.wikipedia.org/wiki/Vi Vi] to edit files.

Here's a couple of guides if you wish to learn more, but feel free to google for further reading:

[http://www.tuxfiles.org/linuxhelp/vimcheat.html Vi Cheat Sheet]

1. Log into your QNAP admin control panel. (Web browser = IP-ADDRESS:8080).

<gallery widths=700px heights=340px>
File:QNAP_SSH.png|'''<big>Step 2:</big>''' Enable SSH (if not already): Network Services -> Telnet / SSH -> 'tick' Allow SSH connection, Press {{button|Apply}}
File:QNAP_NFS.png|'''<big>Step 3:</big>''' Enable NFS: Network Services -> NFS Service -> 'tick' Enable NFS Service, Press {{button|Apply}}
</gallery>
<gallery widths=600px heights=350px>
File:QNAP_Shares.png|'''<big>Step 3:</big>''' Set NFS Access Rights: Under "Enable NFS Service" Click on "Click here to set the NFS access right of the network share"
File:QNAP_NFS_Access.png|'''<big>Step 4:</big>''' Click on the NFS icon next to Qmultimedia (or whatever the name of your media share on the QNAP) and set Access Right to No Limit and put in the IP Address of each individual device that requires NFS connection (ATV2, Desktop, Laptop, etc.), Press {{button|Apply}}
</gallery>

6. On your computer, in a command line window (Terminal on a Mac, CMD on a Windows PC, etc), ssh into your QNAP:
'''ssh admin@<<YOUR QNAP IP ADDRESS>>'''

7. Type in '''cat /etc/exports''' to make sure your previous steps have created exported NFS directories. If no entries are found, go back to the previous steps and make sure you've followed them correctly. You should be seeing something like this:
"/share/MD0_DATA/Qmultimedia" 192.168.1.15(rw,async,no_root_squash) 192.168.1.20(rw,async,no_root_squash)
"/share/NFS/Qmultimedia" 192.168.1.15(rw,nohide,async,no_root_squash) 192.168.1.20(rw,nohide,async,no_root_squash)

8. Type '''vi /etc/exports''' to edit the /etc/exports file, and add "insecure" entries inside the brackets in front "rw"(separated with a comma ","). If you don't know vi: press the "i" key, use arrows to go to the line to edit, and add the entries. Then press the ESC key, and type ''':wq''' to 'Save & Exit'. Your exports file should now look something like this:
"/share/MD0_DATA/Qmultimedia" 192.168.1.15(insecure,rw,async,no_root_squash) 192.168.1.20(insecure,rw,async,no_root_squash)
"/share/NFS/Qmultimedia" 192.168.1.15(insecure,rw,nohide,async,no_root_squash) 192.168.1.20(insecure,rw,nohide,async,no_root_squash)

9. Type '''exportfs -ra''' to initialize your newly exported directories, <span style="color:#FF0000">'''DO NOT''' reboot the QNAP or restart NFS via the QNAP Admin page - If you do the QNAP will overwrite the changes you just made</span>.

<gallery widths=415px heights=168px>
File:QNAP_nfssetting_before.png|'''<big>Step 10:</big>''' Now type '''vi /etc/config/nfssetting'''. You'll see something like this:
File:QNAP_nfssetting_after.png‎|'''<big>Step 11:</big>'''Move your cursor to after the '''rw''' in the line '''/share/*****/Qmultimedia = rw''' (***** interchangeable with whatever yours says). Press {{keypress|i}} and add '''insecure''' separated by a ''',''' (comma). When you're done editing press {{keypress|esc}} and then ''':wq''' to save the changes and close the file. It will look something like this when finished:
</gallery>
<span style="color:#FF0000">'''CAUTION: If you reboot your QNAP NAS at any time after completing the steps above, but before completing the steps below, the changes you've made will be wiped out and you will need to redo the process.'''</span>

12. That should be it for getting it working.. You should now be able to browse NFS and get to your exported QNAP folders in XBMC. Now there's just a few more steps to ensure all your hard work survives a reboot/firmware upgrade.

* We're going to edit/create an autorun script that overwrites two files from backups we're going to make.

13. Okay, you need to make a folder to store the backup files. You need to use the absolute path in the Autorun script. Type '''mkdir /share/MD0_DATA/backups''' and press '''enter'''. (The MD0_DATA part could be different on your model, I'm running a TS-509).

14. Now type '''cp /etc/exports /share/MD0_DATA/backups/exports''' and press enter.

15. Type '''cp /etc/config/nfssetting /share/MD0_DATA/backups/nfssetting''' and press enter.

16. Now for the fun part. To mount the ramblock follow the procedure below. This is based on the guide here (Method 1): [http://wiki.qnap.com/wiki/Running_Your_Own_Application_at_Startup QNAP Autorun Wikiguide]

17. Pick the method that is applicable to your QNAP model.
## Model TS-201: Mount the config ramblock /dev/mtdblock4: <pre># mount -t ext2 /dev/mtdblock4 /tmp/config </pre>
## Models TS-109, TS-109P, TS-110, TS-119, TS-209, TS-209P, TS-219, TS-409 (Marvell ARM), TS-419P: Mount the config ramblock /dev/mtdblock5: <pre># mount -t ext2 /dev/mtdblock5 /tmp/config</pre>
## Models TS-439, TS-509, TS-639, TS-809, TS-809U (x86): Mount the config ramblock /dev/sdx6: <pre># mount -t ext2 /dev/sdx6 /tmp/config</pre>
# Create/Edit /tmp/config/autorun.sh .
## either using vi: <pre># vi /tmp/config/autorun.sh</pre>
### Get vi editor into edit mode: '''press i'''
### Add these lines to the autorun.sh script:
### '''cp /share/MD0_DATA/backups/exports /etc/exports'''
### '''cp /share/MD0_DATA/backups/nfssetting /etc/config/nfssetting'''
### Exit edit mode: '''press ESC'''
### Save and exit: ''':wq'''
## or editing it using a desktop PC and e.g. SFTP
# Ensure that /tmp/config/autorun.sh is executable: <pre># chmod +x /tmp/config/autorun.sh</pre>
# '''IMPORTANT:''' Unmount the mounted flash partition: <pre># cd /</pre> <pre># umount /tmp/config</pre>

18. Finish the linked guide, making sure to unmount the ramblock. (You will need to cd away from the /tmp/config directory to umount it.

19. Should be done!

[[Category:File Sharing]]
[[Category:Linux]]
[[Category:Mac OS X]]
[[Category:How-to]]
{{frodo updated}}

Archive:Debug Python Scripts with Eclipse

2013-12-06T22:38:01Z

Bakslash: /* Copy pysrc in XBMC Python install */

{{mininav|[[Development]]|[[Add-on development]]|[[Python development]]}}

Here is a method you can adopt in order to use the Eclipse (multi-platforms) remote debugger with your Python scripts/plugin.

Note: Follow this link [[HOW-TO debug Python Scripts|Debugging Python Scripts on Linux with WinPDB]] for more information if you prefer to use WinPDB instead.

Note: The information provided herein is also applicable to user with [http://www.aptana.com/ Aptana Studio 3] installation which come pre-installed with pydev. For this case, you can skip to [[#Configure Pydev and Eclipse|Configure Pydev and Eclipse]] after the Aptana Studio 3 installation.

== Prerequisite ==
* Any platform able to run [http://www.eclipse.org/downloads/ Eclipse IDE] (Windows 32bit-64bit, Mac Carbon 32bit-64bit, Mac Cocoa 32bit-64bit, Linux 32bit-64bit): it is the platform from where you will run the debugger IDE
* Pyhton interpreter 2.4 (use the same version as XBMC or version <= 2.7 ) install on the machine running Eclipse
* Any platform running XBMC (Xbox, Linux, MACOSX, Windows): it is the platform running Python scripts/plugin connecting with the remote debugger.
:XBMC installed on Ubuntu (should work just fine on Windows and Mac too)
* [http://pydev.org/ Pydev] plugin for Eclipse IDE: Pydev is a Python IDE for Eclipse, which may be used in Python, Jython and IronPython development.

== Prepare and Setup Eclipse ==

=== Install Eclipse ===
* Download [http://www.eclipse.org/downloads/ Eclipse IDE] and install it
Note: in our example Eclipse Galileo (3.5.1) is used

=== Install Pydev in Eclipse ===
* In Eclipse go in: ''Help'' -> ''Install New Software...''
* Click on the ''Add'' button and add Pydev website as a source: http://pydev.org/updates
* You will see the window below:
[[File:EclipsePydevUpdate.png]]
* Check ''PyDev'' box and follow the steps in order to install PyDev
Note: in our example PyDev 1.5.5

=== Configure Pydev and Eclipse ===

==== Add Pyhton Interpreter Path ====
* Go in ''Window'' -> ''Preferences''
* ''Pydev'' then ''Interpreter - Python''
* Click on button ''New...''
* In the new prompt, enter the ''Interpreter Name: Python'', and Browse for your Python Interpreter 2.4 ''python.exe'' file and select it. After that you should see something like this:
[[File:EclipsePydevPref.png|none]]
This will help in order to have Python code completion (except for XBMC modules)

==== Add Pydev view to Eclipse ====
* On the top right corner click on the View button on select ''Others''
[[File:EclipsePydevViewMenu.png]]
* Select Pydev then OK, a PyDev View Button should be now available on the top right corner
[[File:EclipsePydevViewMenu2.png]]
Use this view for your developments in Python for XBMC

==== Add Pydev Start/Stop debug server buttons ====
* In the menu bar select ''Window'' -> ''Customize perspective...'', a window ''Customize Perspective - PyDev'' will open
* Select ''Command Groups Availability'' Tab
* Check ''Pydev Debug'' box and OK
* You should see 2 new buttons in your toolbar:
[[File:EclipsePydevDebugSrvButtons.png]]

==== Setting the remote debugger port (optional) ====
If you do not want to use the default port (usually 5678) you can set it up:
* Go to ''Window'' -> ''Preferences''
* ''Pydev'' then ''Debug'' you can define here the port and the timeout you want

==== Setting up Predefined Completions (optional) ====
Many developers are accustom to using predefined completions when writing their code (eg. type-ahead). The standard Python completions are enabled by default when using these instructions, but the standard XBMC components will not be recognized appropriately (xbmc, xbmcgui, xbmcplugin, etc).

In order to overcome this, you can run the [http://forum.xbmc.org/showthread.php?t=79070 PyDev Predefined Completions Creator addon] and [http://pydev.org/manual_101_interpreter.html#PyDevInterpreterConfiguration-PredefinedCompletions setup Eclipse] to reference this file:
# Download the 'PyDev Predefined Completions Creator' Addon (eg. System > Settings > Addons > XBMC.org > Program Add-Ons)
# Navigate to the newly installed Addon (eg. Programs from the home screen)
# Open the context menu for newly installed addon and select 'Add-on Settings'
# Set the location to save the help docs to and save the new settings (This can be anywhere on your system - we'll configure it in Eclipse later)
# Select the add-on to run it (the addon should run and close quickly)
# Open Eclipse and select Window > Preferences > PyDev > Interpreter - Python
# From the 'Predefined' tab, click the new button and select the folder you created in the step above
# Press Apply / OK to ensure the changes are saved

== Create a Python script/plugin for XBMC in Eclipse ==

=== Create a new PyDev Project ===
Most of the time when you are doing development, likely that you are running XBMC and Eclipse on the same platform; (The installed debugger described in this article actually can also work with a remote XBMC).<br\>
Let's say you already have scripts installed in XBMC script folder that you want to create a new PyDev project e.g.
<pre>
C:\XBMC\addons\myscript1
C:\XBMC\addons\myscript2
</pre>

With myscript1 & myscript2 being sub-directories of ''C:\XBMC\addons'' each containing the Default.py scripts.<br\>
First you need to define the Python project workspace:
* ''File'' -> ''Switch Workspace'' -> ''Other...''
* ''Browse'' to the parent directory of your script module i.e. ''C:\XBMC\addons'' in this example, select and OK
Then proceed to create the Python project:
* ''File'' -> ''New'' -> ''PyDev Project''
: OR select below in case ''PyDev Project'' is not displayed
* ''File'' -> ''New'' -> ''Others''; and Select ''Pydev'' then ''PyDev Project''; Click ''Next''
* Enter the name of your project e.g. xbmc_addons
* Uncheck option ''Use Default''
* Browse to the directory of your scripts and select i.e. C:\XBMC\addons.
* Set ''Python' as Project Type
* Select ''2.4 (XBMC Python version)'' for the grammar
* Select ''Don't configure PYTHONPATH (to be done manually later on)''
* Click on ''Finish'' button

=== Set the Python Path ===
* Right click on your new project and select ''Properties''
* Select ''PyDev - PYTHONPATH'' and click on ''Add source folder''
* Select the source directory of your script, /xbmc_addons in our example

=== Import File System ===
Assuming you want to add in all the directories under C:\XBMC\addons
* Right click on your new project and select ''Import...''
* Select ''General'' and click on ''File System''; then ''Next''
* Browse to the source directory of your script (or plugin) e.g. C:\XBMC\addons
* Check the directory and files to be added
* Select ''Into folder: xbmc_addons''
* Select ''Options | <<Advanced | Create links in workspace''
* Uncheck both the options i.e. ''Create virtual folders'' & ''Create link locations relative to;...''
* Click on ''Finish'' button
Your source code is now recognized by Eclipse and you will have access to neat functionality such as code completion, link between source files, etc.

=== Add Pydev Python source code (pysrc) to XBMC ===
XBMC needs to know where to find the PyDev remote python source file in order to communicate with the remote debugger of Eclipse.

==== Identify where PyDev remote debugger Python files are ====
Python source files should be in you Eclipse installation directory:
<pre>C:\...\eclipse\plugins\org.python.pydev.debug_1.5.5.2010030420\pysrc\</pre>
In our case we use PyDev 1.5.5.
Look for org.python.pydev.debug (not core)

==== Modify PyDev source in order to support XBMC paths ====
The pysrc code that came with Eclipse-pydev does not support XBMC paths (special://... or Q:/...) and the module would not find them making it impossible to insert breakpoints in such files.

In order to add the support of XBMC paths, you will need to do a simple modification to the file ''pydevd_file_utils.py'' consisting on adding a line to each procedure that had a filename parameter (4 procedures in total).
Add a line like

def _NormFile(filename):
filename = xbmc.translatePath(filename)
try:
...

The other three procedures are:
* def _NormFile(filename):
* def NormFileToServer(filename):
* def NormFileToClient(filename):

of course you need the import directive at the top of the file:

import xbmc

at the beginning of the module...

==== Choose how XBMC will refer to Pydev debugging module ====

You have 3 options as below:
* Option 1 - Refer from our python script directly the directory where pysrc is installed
* Option 2 - Copy pysrc in our script directory and refer it from our script
* Option 3 - Copy pysrc in XBMC Python install

I am only going to show you the steps for ''Option 3'':

==== Copy pysrc in XBMC Python install ====
* Copy the content of pysrc to:
<pre>XBMC\system\python\Lib\pysrc\</pre>
* Add an empty __init__.py file in it

=== Add to your python script the code for remote debug ===
At the beginning of you Python script/plugin (usually Default.py) add the following code:
<pre>
REMOTE_DBG = True

# append pydev remote debugger
if REMOTE_DBG:
# Make pydev debugger works for auto reload.
# Note pydevd module need to be copied in XBMC\system\python\Lib\pysrc
try:
import pysrc.pydevd as pydevd
# stdoutToServer and stderrToServer redirect stdout and stderr to eclipse console
pydevd.settrace('localhost', stdoutToServer=True, stderrToServer=True)
except ImportError:
sys.stderr.write("Error: " +
"You must add org.python.pydev.debug.pysrc to your PYTHONPATH.")
sys.exit(1)
</pre>

In the case you have change the default port you can replace the line with pydevd.settrace by this one:
<pre>
pydevd.settrace('localhost', port=5678, stdoutToServer=True, stderrToServer=True)
</pre>

* Use REMOTE_DBG in order to activate or not the remote debugging
* port specifies the listening port number use between the client and the server
* Replace localhost by an IP address if XBMC and Eclipse are on 2 different machines
* stdoutToServer and stderrToServer redirect stdout and stderr to eclipse console, you won't have to open xbmc.log file

=== Run ===
* Go in Debug view (Eclipse: [[File:changeperspective.png]] / Debug ) and press on the start server button: [[File:EclipsePydevDebugSrvButtons.png]]

* You will see in the console logs like:
<pre>Debug Server at port: 5678</pre>

* Start XBMC and run your script/plugin, you will see it as "Running" but paused

* In Eclipse (Debug View) click on the Resume button (or F8), then you will see the program running in XBMC

* You are now fully set up: You can set break-point, watch on variables, run step by step etc

* Enjoy!

=== Screenshot ===

[[File:EclipsePydevDebugger.png]]

==See also==
* [[Add-ons]]
* [[:Category:All add-ons]]
* [[3rd party add-on repositories]]
'''Development:'''
* [[Add-on development]]
* [[Addon Settings]]
* [[Python development]]
* [[Add-on repositories]]
* [[Official add-on repository]]

[[Category:How-to|Python Tutorial]]
[[Category:Python]]
[[Category:Settings]]
[[Category:How-to]]
[[Category:Add-ons]]
[[Category:Addon Development]]
[[Category:Development]]