cvs: peardoc /en/chapters installation.xml
| From: | Greg Beaver | Date: | Mon, 03 Apr 2006 00:26:35 +0000 |
| Subject: | cvs: peardoc /en/chapters installation.xml | ||
| Groups: | php.pear.doc | ||
| Request: | Send a blank email to pear-doc+get-7726@lists.php.net to get a copy of this message | ||
cellog Mon Apr 3 00:26:35 2006 UTC
Modified files:
/peardoc/en/chapters installation.xml
Log:
update to PEAR_RemoteInstaller 0.3.0
http://cvs.php.net/viewcvs.cgi/peardoc/en/chapters/installation.xml?r1=1.39&r2=1.40&diff_format=u Index: peardoc/en/chapters/installation.xml diff -u peardoc/en/chapters/installation.xml:1.39 peardoc/en/chapters/installation.xml:1.40 --- peardoc/en/chapters/installation.xml:1.39 Sat Apr 1 12:52:05 2006 +++ peardoc/en/chapters/installation.xml Mon Apr 3 00:26:35 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1" ?> -<!-- $Revision: 1.39 $ --> +<!-- $Revision: 1.40 $ --> <chapter id="installation"> <chapterinfo> <author> @@ -116,11 +116,12 @@ If you are running your site at a web hosting provider with no direct access to the server (via local logins, Telnet or SSH), you can't use the PEAR Installer unless you are using PEAR_RemoteInstaller and have - ftp access (sftp access is not yet supported). + ftp, ftps, or sftp access + <emphasis>(as of PEAR_RemoteInstaller version 0.3.0)</emphasis>. </para> <warning> <simpara> - FTP as a protocol is inherently insecure, as passwords are sent unencrypted. + FTP is an inherently insecure protocol, as passwords are sent unencrypted. </simpara> </warning> <para> @@ -651,15 +652,16 @@ </para> </sect2> <sect2 id="installation.shared.ftp"> - <title>Installing a local copy of PEAR through ftp</title> + <title>Installing a local copy of PEAR through ftp/ftps/sftp</title> <para> There are two ways to install a local copy of PEAR through ftp: the old, difficult way, - and the new, easy way. The new, easy way requires an upgrade to version 1.4.x of PEAR. + and the new, easy way. The new, easy way requires an upgrade to version 1.4.3 or newer + of PEAR. </para> <sect3> - <title>New improved method using PEAR 1.4.0 and Net_FTP</title> + <title>New improved method using PEAR 1.4.3+ and PEAR_RemoteInstaller</title> <para> - Installing a local copy of PEAR through ftp has become a piece of cake in PEAR 1.4.0+. + Installing a local copy of PEAR through ftp has become a piece of cake in PEAR 1.4.3+. </para> <para> One of the banes of many user's existence is trying to install PEAR on a remote host @@ -673,13 +675,31 @@ <orderedlist> <listitem> <para> + Make sure you are running PHP 5.0 or newer on your local computer + </para> + </listitem> + <listitem> + <para> + If you wish to use ftps, make sure you have enabled the openssl extension + on your local computer in php.ini. + </para> + </listitem> + <listitem> + <para> + If you wish to use sftp, make sure you have enabled the ssh2 extension + on your local computer in php.ini. + </para> + </listitem> + <listitem> + <para> Make sure you have a working copy of the CLI version of PEAR on your local computer (the "pear" command, not the web interface) </para> </listitem> <listitem> <para> - Make sure you have ftp access to the remote host, and write access through ftp + Make sure you have ftp access to the remote host, and write access through ftp. + (sftp or ftps is <emphasis>highly</emphasis> recommended for security reasons). </para> </listitem> <listitem> @@ -705,7 +725,8 @@ </listitem> <listitem> <para> - Install packages at will! + Manage packages at will using the remote-install, remote-uninstall, + remote-upgrade and remote-upgrade-all commands. </para> </listitem> </orderedlist> @@ -726,8 +747,7 @@ </para> <para> This is pretty straightforward - if you can loging using the ftp command in a DOS - prompt or from a unix shell, you have ftp access. Note that sftp is not yet supported - by PEAR, but will be as soon as the Net_FTP package supports sftp. + prompt or from a unix shell, you have ftp access. </para> <para> Write down the user and password that you need to login. @@ -754,7 +774,8 @@ </programlisting> </para> <para> - Chances are, it will be something like: <filename>/home/username/htdocs</filename>. + Chances are, it will be something like: <filename>/home/username/htdocs</filename> + or <filename>/home/username/public_html</filename>. When you log into ftp, if you can change directory to /home/username, that's great. </para> <para> @@ -817,6 +838,37 @@ </emphasis> </para> <para> + If you wish to use unencrypted ftp (remember: this is inherently insecure), then + use <literal>ftp://</literal> as your stream. If you wish to use ftps, then use + <literal>ftps://</literal> as your stream. If you wish to use sftp, then use + <literal>ssh2.sftp</literal> as your stream. + </para> + <para> + The path you use for the <literal>remote_config</literal> variable may need to be + a full pathname, as in: + </para> + <para> + <screen> + <![CDATA[ +ssh2.sftp://user:pass@myremotehost.com/home/username/.pearrc + ]]> + </screen> + </para> + <para> + If the initial connection attempt fails, try a relative path as in: + </para> + <para> + <screen> + <![CDATA[ +ftps://user:pass@myremotehost.com/.pearrc + ]]> + </screen> + </para> + <para> + To set the value of the <literal>remote_config</literal> configuration variable, + use this syntax: + </para> + <para> In windows: </para> <para> @@ -838,12 +890,12 @@ </para> <para> <emphasis> - 7. install packages at will! + 7. Manage packages at will using the remote-install, remote-uninstall, + remote-upgrade and remote-upgrade-all commands. </emphasis> </para> <para> - From this point on, you can use the pear command normally, and it will automatically - synchronize the local and the remote repositories. + From this point on, you can synchronize the local and the remote repositories. </para> <para> <emphasis> @@ -851,26 +903,31 @@ </emphasis> </para> <para> - Simple. The installer installs the package locally, and then uses Net_FTP and uploads - a copy of each locally installed file to its equivalent location remotely. All commands - that affect installation (install, upgrade, even upgrade-all) can be used with this - option. The "remote_config" option tells the installer that it should automatically - mirror the local copy to the remote host. + The installer installs the package locally, and then uses ftp streams and uploads + a copy of each locally installed file to its equivalent location remotely. + All commands that affect installation (install, uninstall, upgrade, and upgrade-all) + have corresponding remote- commands (remote-install, remote-uninstall, + remote-upgrade, remote-upgrade-all). The "remote_config" option tells the + installer how to retrieve the remote configuration file containing absolute paths + where packages should be installed. </para> <para> - Even more exciting, the remote configuration file is used for any replacements. In + The remote configuration file is used for any special tasks such as replacements. In other words, if a file expects to get the path to data files through the data_dir configuration directive, then it will have the path on the remote host (<filename>/home/username/pear/data</filename>) rather than the local copy ( - <filename>C:\remote\pear\data</filename>). This has - one side effect: the local copy will not work on the local machine, but if you think - of it as a backup copy (In an emergency, you can always just upload the entire contents - to the remote host using regular old ftp or scp), the reasoning becomes obvious. + <filename>C:\remote\pear\data</filename>). Note that packages installed this way + will not work on the local machine, and should be thought of as a backup copy. + In an emergency, you can always just upload the entire contents + to the remote host using ftp or scp. </para> <para> - It is important to note that some packages install themselves differently on windows and on - unix. Be sure you know whether this is the case before installing, or ensure that your - local and remote systems are the same kind of operating system. + It is important to note that some packages install themselves differently on + windows and on unix. Be sure you know whether this is the case before installing, + or ensure that your local and remote systems are the same kind of operating system. + In addition, your local packages may depend on PHP extensions. To ensure these + are available on the remote server, use the output of phpinfo(); to determine + which extensions are available. </para> </sect3> <sect3>
http://cvs.php.net/viewcvs.cgi/peardoc/en/chapters/installation.xml?r1=1.39&r2=1.40&diff_format=u Index: peardoc/en/chapters/installation.xml diff -u peardoc/en/chapters/installation.xml:1.39 peardoc/en/chapters/installation.xml:1.40 --- peardoc/en/chapters/installation.xml:1.39 Sat Apr 1 12:52:05 2006 +++ peardoc/en/chapters/installation.xml Mon Apr 3 00:26:35 2006 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1" ?> -<!-- $Revision: 1.39 $ --> +<!-- $Revision: 1.40 $ --> <chapter id="installation"> <chapterinfo> <author> @@ -116,11 +116,12 @@ If you are running your site at a web hosting provider with no direct access to the server (via local logins, Telnet or SSH), you can't use the PEAR Installer unless you are using PEAR_RemoteInstaller and have - ftp access (sftp access is not yet supported). + ftp, ftps, or sftp access + <emphasis>(as of PEAR_RemoteInstaller version 0.3.0)</emphasis>. </para> <warning> <simpara> - FTP as a protocol is inherently insecure, as passwords are sent unencrypted. + FTP is an inherently insecure protocol, as passwords are sent unencrypted. </simpara> </warning> <para> @@ -651,15 +652,16 @@ </para> </sect2> <sect2 id="installation.shared.ftp"> - <title>Installing a local copy of PEAR through ftp</title> + <title>Installing a local copy of PEAR through ftp/ftps/sftp</title> <para> There are two ways to install a local copy of PEAR through ftp: the old, difficult way, - and the new, easy way. The new, easy way requires an upgrade to version 1.4.x of PEAR. + and the new, easy way. The new, easy way requires an upgrade to version 1.4.3 or newer + of PEAR. </para> <sect3> - <title>New improved method using PEAR 1.4.0 and Net_FTP</title> + <title>New improved method using PEAR 1.4.3+ and PEAR_RemoteInstaller</title> <para> - Installing a local copy of PEAR through ftp has become a piece of cake in PEAR 1.4.0+. + Installing a local copy of PEAR through ftp has become a piece of cake in PEAR 1.4.3+. </para> <para> One of the banes of many user's existence is trying to install PEAR on a remote host @@ -673,13 +675,31 @@ <orderedlist> <listitem> <para> + Make sure you are running PHP 5.0 or newer on your local computer + </para> + </listitem> + <listitem> + <para> + If you wish to use ftps, make sure you have enabled the openssl extension + on your local computer in php.ini. + </para> + </listitem> + <listitem> + <para> + If you wish to use sftp, make sure you have enabled the ssh2 extension + on your local computer in php.ini. + </para> + </listitem> + <listitem> + <para> Make sure you have a working copy of the CLI version of PEAR on your local computer (the "pear" command, not the web interface) </para> </listitem> <listitem> <para> - Make sure you have ftp access to the remote host, and write access through ftp + Make sure you have ftp access to the remote host, and write access through ftp. + (sftp or ftps is <emphasis>highly</emphasis> recommended for security reasons). </para> </listitem> <listitem> @@ -705,7 +725,8 @@ </listitem> <listitem> <para> - Install packages at will! + Manage packages at will using the remote-install, remote-uninstall, + remote-upgrade and remote-upgrade-all commands. </para> </listitem> </orderedlist> @@ -726,8 +747,7 @@ </para> <para> This is pretty straightforward - if you can loging using the ftp command in a DOS - prompt or from a unix shell, you have ftp access. Note that sftp is not yet supported - by PEAR, but will be as soon as the Net_FTP package supports sftp. + prompt or from a unix shell, you have ftp access. </para> <para> Write down the user and password that you need to login. @@ -754,7 +774,8 @@ </programlisting> </para> <para> - Chances are, it will be something like: <filename>/home/username/htdocs</filename>. + Chances are, it will be something like: <filename>/home/username/htdocs</filename> + or <filename>/home/username/public_html</filename>. When you log into ftp, if you can change directory to /home/username, that's great. </para> <para> @@ -817,6 +838,37 @@ </emphasis> </para> <para> + If you wish to use unencrypted ftp (remember: this is inherently insecure), then + use <literal>ftp://</literal> as your stream. If you wish to use ftps, then use + <literal>ftps://</literal> as your stream. If you wish to use sftp, then use + <literal>ssh2.sftp</literal> as your stream. + </para> + <para> + The path you use for the <literal>remote_config</literal> variable may need to be + a full pathname, as in: + </para> + <para> + <screen> + <![CDATA[ +ssh2.sftp://user:pass@myremotehost.com/home/username/.pearrc + ]]> + </screen> + </para> + <para> + If the initial connection attempt fails, try a relative path as in: + </para> + <para> + <screen> + <![CDATA[ +ftps://user:pass@myremotehost.com/.pearrc + ]]> + </screen> + </para> + <para> + To set the value of the <literal>remote_config</literal> configuration variable, + use this syntax: + </para> + <para> In windows: </para> <para> @@ -838,12 +890,12 @@ </para> <para> <emphasis> - 7. install packages at will! + 7. Manage packages at will using the remote-install, remote-uninstall, + remote-upgrade and remote-upgrade-all commands. </emphasis> </para> <para> - From this point on, you can use the pear command normally, and it will automatically - synchronize the local and the remote repositories. + From this point on, you can synchronize the local and the remote repositories. </para> <para> <emphasis> @@ -851,26 +903,31 @@ </emphasis> </para> <para> - Simple. The installer installs the package locally, and then uses Net_FTP and uploads - a copy of each locally installed file to its equivalent location remotely. All commands - that affect installation (install, upgrade, even upgrade-all) can be used with this - option. The "remote_config" option tells the installer that it should automatically - mirror the local copy to the remote host. + The installer installs the package locally, and then uses ftp streams and uploads + a copy of each locally installed file to its equivalent location remotely. + All commands that affect installation (install, uninstall, upgrade, and upgrade-all) + have corresponding remote- commands (remote-install, remote-uninstall, + remote-upgrade, remote-upgrade-all). The "remote_config" option tells the + installer how to retrieve the remote configuration file containing absolute paths + where packages should be installed. </para> <para> - Even more exciting, the remote configuration file is used for any replacements. In + The remote configuration file is used for any special tasks such as replacements. In other words, if a file expects to get the path to data files through the data_dir configuration directive, then it will have the path on the remote host (<filename>/home/username/pear/data</filename>) rather than the local copy ( - <filename>C:\remote\pear\data</filename>). This has - one side effect: the local copy will not work on the local machine, but if you think - of it as a backup copy (In an emergency, you can always just upload the entire contents - to the remote host using regular old ftp or scp), the reasoning becomes obvious. + <filename>C:\remote\pear\data</filename>). Note that packages installed this way + will not work on the local machine, and should be thought of as a backup copy. + In an emergency, you can always just upload the entire contents + to the remote host using ftp or scp. </para> <para> - It is important to note that some packages install themselves differently on windows and on - unix. Be sure you know whether this is the case before installing, or ensure that your - local and remote systems are the same kind of operating system. + It is important to note that some packages install themselves differently on + windows and on unix. Be sure you know whether this is the case before installing, + or ensure that your local and remote systems are the same kind of operating system. + In addition, your local packages may depend on PHP extensions. To ensure these + are available on the remote server, use the output of phpinfo(); to determine + which extensions are available. </para> </sect3> <sect3>