Changes between Version 115 and Version 116 of Installation

Show
Ignore:
Timestamp:
04/09/12 16:53:34 (14 months ago)
Author:
max (IP: 120.148.4.74)
Comment:

Simplify installation instructions

Legend:

Unmodified
Added
Removed
Modified

  • Installation

    v115 v116  
    22 
    33= Installation = 
    4  
    5 === Which user? === 
    6 It's no longer important to choose the "right" user to install Shepherd. (In previous versions, we asked MythTV users to ensure Shepherd's user matched that of MythTV. But this could be tricky to figure out, so we changed it.) 
    7  
    8 The simplest way to install Shepherd is as whichever user you usually use. If you're concerned about [wiki:Security security], you could create a new user specifically for Shepherd, but be aware that Shepherd is user-specific: once installed for a particular user, it will only run for that user. (This prevents permissions problems.) Installing Shepherd as user "alice" then attempting to run it as user "bob" will begin a fresh install in Bob's directory, to avoid interfering with Alice's. 
    9  
    104 
    115We [wiki:Security do not recommend running Shepherd as root]. 
    … …  
    159 1. Download Shepherd: 
    1610{{{ 
    17 wget http://www.whuffy.com/shepherd/shepherd 
     11wget 'http://www.whuffy.com/shepherd/shepherd' 
    1812}}} 
    1913 1. Run it: 
    … …  
    2115perl shepherd 
    2216}}} 
    23  1. If Shepherd won't run because a "mandatory module" is not found, install it (see "[wiki:Installation#PerlDependencies Perl Dependencies]") and try again. You may have to install several mandatory Perl modules before Shepherd can run.[[BR]][[BR]]Shepherd will now install itself and its components (probably into ''~/.shepherd/''). Most likely, one or more components will fail due to missing Perl modules, but that's fine: we'll fix that later.[[BR]][[BR]] 
    24  1. Answer the configuration questions to select your region. When asked if you want Guided Channel Selection, say '''yes'''. Shepherd will then step through each of your MythTV channels, asking you to choose appropriate guide data for each one. Some MythTV channels you won't want guide data for (e.g. radio channels, guide channels, duplicate channels); that's fine.[[BR]][[BR]]If you are not a MythTV user, or Shepherd cannot access your MythTV, you will enter Advanced Channel Selection instead to manually enter [wiki:XMLTVIDs XMLTV IDs] for each channel. [[BR]][[BR]]When asked to confirm that you want to create Shepherd's configuration file, say '''yes'''.[[BR]][[BR]] 
    25  1. Shepherd will test its components. Some may fail: that's fine.[[BR]][[BR]] 
     17 If Shepherd won't run because a "mandatory module" is not found, install it (see "[wiki:Installation#PerlDependencies Perl Dependencies]") and try again. You may have to install several mandatory Perl modules before Shepherd can run.[[BR]][[BR]]Shepherd will now install itself and its components (probably into ''~/.shepherd/''). Most likely, one or more components will fail due to missing Perl modules, but that's fine: we'll fix that later.[[BR]][[BR]] 
     18 1. Answer the configuration question to select your region.[[BR]][[BR]] 
     19 1. When asked if you want Guided Channel Selection, say '''yes'''.[[BR]][[BR]] 
     20 1. Shepherd will step through each of your MythTV channels, asking you to choose appropriate guide data for each one. Some MythTV channels you won't want guide data for (e.g. radio channels, guide channels, duplicate channels); that's fine.[[BR]][[BR]]If you are not a MythTV user, or Shepherd cannot access your MythTV, you will enter Advanced Channel Selection instead to manually enter [wiki:XMLTVIDs XMLTV IDs] for each channel. [[BR]][[BR]] 
     21 1. When asked to confirm that you want to create Shepherd's configuration file, say '''yes'''.[[BR]][[BR]]Shepherd will test its components. It's fine for now if some fail.[[BR]][[BR]] 
    2622 1. Shepherd will ask if you would like to automatically configure MythTV. If you're a MythTV user, this is a good idea, because otherwise it's quite easy to get wrong. Say '''yes''', and Shepherd will setup a ''tv_grab_au'' symlink, register itself as the default grabber for MythTV, and add itself as a cron job so that your system runs it regularly.[[BR]][[BR]] 
    27  1. Shepherd will ask if you would like to install channel icons. This is optional, and you can do it later if you prefer. If you say '''yes''', Shepherd will step you through a variety of icon galleries to choose from.[[BR]][[BR]] 
     23 1. Shepherd will ask if you would like to install channel icons into MythTV. This is optional, and you can do it later if you prefer (with "tv_grab_au --set-icons"). If you say '''yes''', Shepherd will step you through a variety of icon galleries to choose from.[[BR]][[BR]] 
    2824 1. Shepherd will exit. For maximum functionality, you should now install any missing Perl modules required by components. How to do this varies depending on your distribution: see the [wiki:Installation#PerlDependencies detailed instructions] and [wiki:FAQ#HowimportantisittoinstalltheoptionalPerlmodules why this is worth doing]. Essentially, you should attempt to install any modules that Shepherd complains are missing when you do this: 
    2925{{{ 
    … …  
    3329 
    3430Shepherd is now installed. This means that when run, it will create a file of TV guide data (by default: ''~/.shepherd/output.xmltv''). It also creates a log file at ''~/.shepherd/log/shepherd.log''. Most users want this guide data to be regularly fed to another program: see the relevant section below on integration with [wiki:Installation#IntegrationwithMythTV MythTV], [wiki:Installation#IntegrationwithFreevo Freevo], or [wiki:Installation#IntegrationwithEyeTV EyeTV]. 
     31 
     32=== Which user? === 
     33It's no longer important to choose the "right" user to install Shepherd. (In previous versions, we asked MythTV users to ensure Shepherd's user matched that of MythTV. But this could be tricky to figure out, so we changed it.) 
     34 
     35The simplest way to install Shepherd is as whichever user you usually use. If you're concerned about [wiki:Security security], you could create a new user specifically for Shepherd, but be aware that Shepherd is user-specific: once installed for a particular user, it will only run for that user. (This prevents permissions problems.) Installing Shepherd as user "alice" then attempting to run it as user "bob" will begin a fresh install in Bob's directory, to avoid interfering with Alice's. 
    3536 
    3637== Integration with MythTV ==