Menu
▾
▴
[Bobs-cvs] CVS: bobs INSTALL,1.24,1.25
|
From: Joe Z. <jz...@us...> - 2004-04-12 02:13:34
|
Update of /cvsroot/bobs/bobs In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv12518 Modified Files: INSTALL Log Message: Update documentation in preparation for release 0.6.2. Index: INSTALL =================================================================== RCS file: /cvsroot/bobs/bobs/INSTALL,v retrieving revision 1.24 retrieving revision 1.25 diff -u -d -r1.24 -r1.25 --- INSTALL 28 Mar 2004 22:33:21 -0000 1.24 +++ INSTALL 12 Apr 2004 01:59:50 -0000 1.25 @@ -1,7 +1,7 @@ Installation guide. -Latest update March, 2003. +Latest update April, 2004. PLEASE NOTE: This is NOT a secure program. Do not deploy if you have security concerns. (you can test it and see for yourself) @@ -9,34 +9,151 @@ Overview: 1.0 Requirements -2.0 Files +2.0 Installation 3.0 Configuration of other servers 4.0 Configuration of backupserver 5.0 Test your setup 6.0 Off you go -7.0 Easy install -8.0 Problems -9.0 What gets installed? +7.0 Problems +8.0 What gets installed? ::: 1.0 Requirements You'll need at least the following programs installed. (Developed on a stock redhat 7.2 install) -Bash +Bash sh sed -PHP -apache -nfs (nfs-utils) +PHP +apache web server +nfs (nfs-utils) If you want to do backups using nfs. rsync ntpd (to keep time syncronized between servers.) -samba +samba (to do backups of Windows shares) +ssh (to do rsync/ssh backups) Possibly more. I'll add them when I discover them. -::: 2.0 Files -Changes were recently made to remove the need for BOBS to reside in -the www root folder. -You should be able to place BOBS in any webaccesible dir. +::: 2.0 Install +IMPORTANT! + +If you are upgrading from release 0.6.1 or earlier please read the +RELEASE-NOTES. + +You can install from the rpm package if you do not want to change the +default locations of the installed files. Use the tar distribution if +you want to place the web directory or backup data directory in a +non-default location or if you have trouble after installing from rpm. + +::: 2.1 rpm install + +To install from the rpm package: + + rpm -Uvh bobs-x.x.x-x.i386.rpm + +::: 2.2 Installation from tarball + +Short instructions: + + tar -xzf bobs-x.x.tar.gz + ./configure + su + make install + Browse to http://your.server.name/bobs/admin.php + +Detailed instructions: + +1. Unpack your distribution + + cd to the directory containing the bobs tar file + 'bobs-x.x.x.tar.gz'. Extract the tarball: + + tar -xzf bobs-x.x.tar.gz + +2. Configure bobs. + + cd to the bobs directory: + + cd bobs-x.x.x + + Configure bobs for your system: + + ./configure + + If you want to specify your own locations, instead of the + defaults, for the bobs web pages and data backup directories, use + options to ./configure. Type './configure --help' for a list of + options, the last three are the only ones you need be concerned + with: + + --with-webdir=DIR Place the bobs web pages in DIR + --with-bobsdata=DIR Place the bobs data (backups) in DIR + --with-crondir=DIR Location of cron.daily directory + + For example, if you want your web pages placed in + /home/fred/public_html, use + '--with-webdir=/home/fred/public_html'. This will create directory + /home/fred/public_html/bobs containing the bobs web pages. + + If you want your backup data in /var/local/backup, use + '--with-bobsdata=/var/local/backup'. This will create directory + /var/local/backup/bobsdata containing all the bobs backups. + + The default web directory is /home/httpd/html, or /var/www/html, + depending on your distribution. + + The default data directory is /var/bobsdata. + + FIXME: + ./configure will also store a plain text password in + inc/config.php. This password will control access to the + bobs/admin.php web page. + +3. Install bobs + + Change to root: + + su + + Install the files: + + make install + + This will install the web pages, create the backup data + directories, and add a cron job to /etc/crontab. + +4. Bobs is now installed. + + Point your browser to http://your.server.name/bobs/admin.php. + + Log in. The default password is 'admin'. + + Click on 'Check Configuration'. This will tell you if bobs + is running properly. + +5. Now you can create backup configurations. After you create one, + highlight the new configuration in the list and click on + 'Check Configuration'. This will run lots of diagnostics and + tell you if your backup configuration is okay. + +6. If you want to uninstall bobs, or change your configuration: + + Run 'make uninstall' from the directory where you extracted + the bobs files to remove the bobs web pages and delete the + backup data directories. You can then run ./configure and 'make + install' again. + + You may want to run 'make clean' before running ./configure a + second time to ensure the reconfiguration of all options. + + If you're have trouble with the ./configure script or 'make + install', you can rebuild it by running these commands from the + bobs distribution directory: + + make maintainer-clean + aclocal + autoconf + automake --add-missing + ./configure ::: 3.0 Configuration of other servers. You'll need to configure the servers you wish to get files from. @@ -45,6 +162,11 @@ ::: 3.1 Rsync +Bobs supports two type of rsync backups: standard rsync and rsync over +secure shell (ssh). The following instructions are for standard rsync +backups. rsync over ssh configuration is explained on the bobs "help" +web page. + On the machine to be backed up, you need to enable 'rsync'. Rsync will be used to transfer the files from the production computer to the backup computer. From the rsync man page: @@ -130,13 +252,7 @@ Backupdir/process/mounts/ All dirs should be read and writeable for the apache(webserver) process. -Place the file "bash/cmdloop" in "Backupdir/process/" -(check the file to see if the program paths fit your system) - -When you have completed the setup and tests below you should place an -entry in /etc/crontab that runs "cron/check_loop" every 5 minutes. - example entry in crontab: 0-59/5 * * * * root -/var/www/html/bobs/cron/check_loop & +Place the file "bash/init.d/cmdloopd" in "/etc/init.d/" The cmdloop is a command queue. It checks the contents of the "cmd" dir and executes the files in it. It allows for shell scripts which might take @@ -225,113 +341,14 @@ homepage: http://bobs.sourceforge.net/ -::: 7.0 Easy install - -These steps use the standard make utility to automate the install process. - -Easy install steps: - -1. Unpack your distribution - - cd to the directory containing the bobs tar file - 'bobs-x.x.x.tar.gz'. Extract the tarball: - - tar -xzf bobs-x.x.tar.gz - -2. Configure bobs. - - cd to the bobs directory: - - cd bobs-x.x.x - - Configure bobs for your system: - - ./configure - - If you want to specify your own locations, instead of the - defaults, for the bobs web pages and data backup directories, use - options to ./configure. Type './configure --help' for a list of - options, the last three are the only ones you need be concerned - with: - - --with-webdir=DIR Place the bobs web pages in DIR - --with-bobsdata=DIR Place the bobs data (backups) in DIR - --with-crondir=DIR Location of cron.daily directory - - For example, if you want your web pages placed in - /home/fred/public_html, use - '--with-webdir=/home/fred/public_html'. This will create directory - /home/fred/public_html/bobs containing the bobs web pages. - - If you want your backup data in /var/local/backup, use - '--with-bobsdata=/var/local/backup'. This will create directory - /var/local/backup/bobsdata containing all the bobs backups. - - The default web directory is /home/httpd/html, or /var/www/html, - depending on your distribution. - - The default data directory is /var/bobsdata. - - FIXME: - ./configure will also store a plain text password in - inc/config.php. This password will control access to the - bobs/admin.php web page. - -3. Install bobs - - Change to root: - - su - - Install the files: - - make install - - This will install the web pages, create the backup data - directories, and add a cron job to /etc/crontab. - -4. Bobs is now installed. - - Point your browser to http://your.server.name/bobs/admin.php. - - Log in. The default password is 'admin'. - - Click on 'Check Configuration'. This will tell you if bobs - is running properly. - -5. Now you can create backup configurations. After you create one, - highlight the new configuration in the list and click on - 'Check Configuration'. This will run lots of diagnostics and - tell you if your backup configuration is okay. - -6. If you want to uninstall bobs, or change your configuration: - - Run 'make uninstall' from the directory where you extracted - the bobs files to remove the bobs web pages and delete the - backup data directories. You can then run ./configure and 'make - install' again. - - You may want to run 'make clean' before running ./configure a - second time to ensure the reconfiguration of all options. - - If you're have trouble with the ./configure script or 'make - install', you can rebuild it by running these commands from the - bobs distribution directory: - - make maintainer-clean - aclocal - automake --add-missing - autoconf - ./configure - -::: 8.0 Problems +::: 7.0 Problems If you're having trouble, read this section. First, make sure these services are running on the host computer (the one with bobs installed). See section 3 for more information. - portmap + portmap (if using nfs) httpd (web server) Second, make sure these services are running on the computer to be backed @@ -340,7 +357,7 @@ portmap nfs -Third, you can get support via the forum or mailing list at +Third, you can get support via the bobs-devel mailing list at http://sourceforge.net/projects/bobs. @@ -349,7 +366,7 @@ A: Make sure the shared directory you're restoring to is writeable. -::: 9.0 What gets installed? +::: 8.0 What gets installed? /var/bobsdata Directory for backup files, a few scripts, and mount points. |
