Changes between Version 10 and Version 11 of Installation

Timestamp:

12/03/06 18:15:50 (6 years ago)

Author:

max (IP: 203.45.59.92)

Comment:

--

Installation

@@ -2 +2 @@
 To install Shepherd:
 
- 1. Download http://www.whuffy.com/shepherd/tv_grab_au
- 1. Make it executable
- 1. Run it. The script will attempt to install and configure itself.
+ 1. Download Shepherd:
+{{{
+wget http://www.whuffy.com/shepherd/shepherd
+}}}
+ 1. Run it:
+{{{
+perl shepherd
+}}}
+ 1. If Shepherd complains about missing Perl modules, install these. See "Dependencies" below.
+ 1. Shepherd will attempt to download the latest versions of itself and its components into ''~/.shepherd/'' (or ''/opt/shepherd/''). You may notice that one or more components may fail to install properly, due to missing Perl modules. For maximum functionality, you should attempt to install missing Perl modules later (see "Dependencies").
+ 1. Answer the configuration questions to select your region and desired channels
+ 1. When configuration is complete, symlink ''/usr/bin/tv_grab_au'' to Shepherd:
+{{{
+sudo ln -s ~/.shepherd/shepherd /usr/bin/tv_grab_au
+}}}
+ Shepherd should then be automatically called by mythfilldatabase, according to the settings for that program.
 
-These can be accomplished via:
+== Dependencies ==
 
+Shepherd uses numerous 3rd-party modules and software. Some of these are mandatory, and some are optional, meaning that certain components (including grabbers) may not work without them, but the overall program will.
+
+A list of Required and Optional modules is below.
+
+The general way to install a Perl module is to do the following (as root):
 {{{
-wget http://www.whuffy.com/shepherd/tv_grab_au
-chmod +x tv_grab_au
-./tv_grab_au
+cpan <module>
+}}}
+For example:
+{{{
+cpan List::Compare
 }}}
 
-If you're manually upgrading from a previous version because we broke auto-update, it may be necessary to delete your ~/.shepherd/ directory.
+Your Linux distribution may offer an alternative way to install module packages -- if so, it's often better to use that.
 
-We recommended you run Shepherd as a standard user and never as ''root'' (super-user).
-
-When run for the first time, Shepherd will install itself in ''~/.shepherd/'' or ''/opt/shepherd/''.  You should symlink ''/usr/bin/tv_grab_au'' to the ''tv_grab_au'' script in the shepherd directory.  In most installations, this is accomplished via:
-
-{{{
-ln -s ~/.shepherd/tv_grab_au /usr/bin/tv_grab_au
-}}}
-
-= Dependencies =
-
-Shepherd has numerous dependencies on 3rd party modules and software.  Some of these are mandatory, some are optional depending on whether you wish Shepherd to run with its full suite of ''plugin modules'' or not.
-
-If you run Linux and your distribution has packages for Shepherd's dependencies, it is generally better to use them than to install modules through CPAN, as described below.  The first subsection below gives distribution-specific instructions; if you follow the instructions for your linux distribution, you do not need to read the rest of this wiki page.  If you use a different distribution, or a different operating system, you will need to install the dependencies as described in the sections on XMLTV and the perl dependencies.
-
-== Linux Distribution-Specific Dependencies ==
-
-=== Debian-Based Distributions ===
+==== Debian-Based Distributions ====
 
 The following command should install the necessary packages:
@@ -42 +46 @@
 }}}
 
-== XMLTV ==
+==== Gentoo ====
+Some (but not all) required modules can be installed with:
+{{{
+sudo emerge -av xmltv Algorithm-Diff 
+}}}
 
-XMLTV needs to be installed.  The latest version can be downloaded from http://files.xmltv.org/ [[BR]]
-If you are unsure about whether you have XMLTV installed, run the command ''perldoc XMLTV'' and see if there is any documentation on your system.  If there is, then it is already installed.
+=== Required Modules ===
 
-XMLTV version 0.5.44 or later is recommended as it supports HDTV flags.
-
-
-== Tor ==
-
-Many grabbers work faster/better if they can operate using The Onion Router (tor) from http://tor.eff.org/.[[BR]]
-Tor is available in RPM form from as http://tor.eff.org/dist/rpm/tor-0.1.1.25-tor.0.rh4_4.i386.rpm and http://dag.wieers.com/packages/libevent/libevent-1.2-1.fc3.rf.i386.rpm
-
-Once Tor is installed, shepherd will automatically find it and start using it. No configuration of Tor is necessary.
-
-
-== Mandatory Perl modules ==
-
-The following Perl modules are mandatory for Shepherd to be able to run:
+Shepherd cannot run without the following Perl modules:
  * Algorithm::Diff
  * Compress::Zlib
@@ -70 +64 @@
  * LWP::!UserAgent
 
-If these aren't installed on your system, you may be able to install them automtically via CPAN (note: you will probably have to do this while logged in as ''root'' or via ''sudo''):
-
 {{{
 cpan Algorithm::Diff Compress::Zlib Cwd Data::Dumper Date::Manip Getopt::Long List::Compare LWP::UserAgent
 }}}
-(it shouldn't cause any issues to just run this command; if everything is up-to-date, it'll tell you and finish)
 
-== Optional Perl modules ==
+==== Required Module: XMLTV ====
+
+XMLTV needs to be installed.  The latest version can be downloaded from http://files.xmltv.org/ [[BR]]
+If you are unsure about whether you have XMLTV installed, run the command ''perldoc XMLTV'' and see if there is any documentation on your system.  If there is, then it is already installed.
+
+XMLTV version 0.5.44 or later is recommended as it supports HDTV flags.
+
+=== Optional Perl modules ===
 
 Various grabbers and postprocessors require additional Perl/CPAN dependencies.  These include:
@@ -92 +90 @@
  * XML::DOM
 
-To install any missing CPAN modules, you can ask CPAN to install/update/check them all using the following (note: you will probably have to do this while logged in as ''root'' or via ''sudo''):
-
 {{{
 cpan DateTime::Format::Strptime File::Basename File::Path HTML::Entities HTML::TokeParser
@@ -100 +96 @@
 (it shouldn't cause any issues to just run this command; if everything is up-to-date, it'll tell you and finish)
 
-== Optional Javascript modules ==
+==== Optional Module: Javascript ====
 
 Some grabbers ''parse'' web pages that have Javascript embedded in them. These grabbers make use of a system-wide Javascript library, typically provided by ''js'' and ''js-devel'' packages from your Unix/Linux installation.
@@ -121 +117 @@
 cpan Javascript
 }}}
+
+==== Optional Software: Tor ====
+
+Many grabbers work faster/better if they can operate using The Onion Router (tor) from http://tor.eff.org/.[[BR]]
+Tor is available in RPM form from as http://tor.eff.org/dist/rpm/tor-0.1.1.25-tor.0.rh4_4.i386.rpm and http://dag.wieers.com/packages/libevent/libevent-1.2-1.fc3.rf.i386.rpm
+
+Once Tor is installed, shepherd will automatically find it and start using it. No configuration of Tor is necessary.
+
+== Security ==
+
+Shepherd automatically checks for new versions of itself and its components, downloads, and executes these.
+
+We therefore recommended you run Shepherd as a standard user and never as ''root'' (super-user). For maximum safety, you can create a special Shepherd user (instructions, anybody?).
+
+== Troubleshooting ==
+
+If you're manually upgrading from a previous version because we broke auto-update, it may be necessary to delete your ~/.shepherd/ directory.
+