Changes between Initial Version and Version 1 of EncapInstall

09/02/06 18:38:24 (15 years ago)

(hopefully) final INSTALL for 0.8.3 release


  • EncapInstall

    v1 v1  
     1EncapPackages | EncapReadme | '''EncapInstall''' | EncapHowto 
     5= EncapInstall: bcfg2/encap installation instructions = 
     7== Prerequisites == 
     8 * Read the [wiki:EncapReadme README] 
     9 * GNU gcc and GNU g++ 
     10   * If you are using the gcc distributed with Solaris/x86 10, you need to  
     11     install the gcc bug fix at by  
     12     running "`ksh -f values.c`" as root (or openssl will segfault) 
     13 * GNU make (make sure "gmake" links to GNU make on non-GNU platforms) 
     14 * /usr/local/man should be a directory, not a symbolic link 
     15 * epkg (the encap package manager) 
     16   * Canonical website is 
     17   * Mirror of epkg binaries is available at 
     18   * If built from source, first need all recommended libraries from web page 
     19     * To ease building from source, read `epkg/README` and use `epkg/Makefile` 
     21You will need binaries of the GNU tools. For GNU and BSD based operating  
     22systems, you should be able to get these via the operating system's package  
     23system. For commercial operating systems, these can be obtained from: 
     25 AIX:: 
     26 * UCLA's Public Domain Software Library for AIX at  
     28   (These are trivial to convert into encap packages) 
     29 * Bull AIX Freeware at 
     31 Solaris:: 
     32 * Freeware for Solaris at 
     33 * Community Software for Solaris at 
     35== Advanced Packaging Tool (APT) support ==  
     37On platforms that use APT, such as Debian and Ubuntu, "bcfg2-python-apt" must 
     38be built. Unfortunately the version required is dependent on the version of the 
     41To see if your distribution is supported, do: 
     43cat /etc/issue 
     44grep DISTRO src/encap-profiles/Makefile \ 
     45    | awk -F, '{print $2}' | sort | sed s:\)$::g 
     47If any of the lines from `src/encap-profiles/Makefile` match your `/etc/issue`, 
     48you're good to go; if not, open a ticket at with  
     49the contents of your `/etc/issue` requesting that it be supported, and support 
     50should be added within a few days (or of course patches are gratefully  
     53When building "bcfg2-python-apt", there are some additional prerequisites: 
     54 * `/usr/lib/libapt-pkg*` (Part of the "apt" package on Debian) 
     55 * `/usr/lib/libapt-inst*` (Part of the "apt-utils" package on Debian) 
     56 * The "`libapt-pkg-dev`" package  
     57So you probably want to do something like: 
     59apt-get install apt apt-utils libapt-pkg-dev 
     62== Building and installing everything == 
     63Note that the build is disruptive to the currently installed bcfg2 packages 
     64(whatever you have installed is uninstalled and then replaced with the 
     65newly-built packages), although no configuration files will be replaced 
     66unless you ask them to be (via "`REPLACE_CONFIG="yes"; export REPLACE_CONFIG`"). 
     68 1. Make sure all of the prerequisites (see above) are installed. 
     69 1. The build/install must be done as "`root`". 
     70 1. Change to the src directory (`cd src`) 
     71 1. Copy your `site-settings.conf` file to `bcfg2-site/`; if you don't have 
     72    one already, copy over `bcfg2-site/site-settings.conf-example` and change 
     73    it to suit your site. 
     74 1. Run `make` (GNU/Linux platforms) or `gmake` (all other platforms). This  
     75    will kick off and background the entire build process. Make output will be 
     76    redirected to `make.log`, and package build output will go to individual 
     77    log files. If the entire build is successful, you will see:  
     78    {{{### encap build finished...}}} 
     79    followed by the locations of the various packages at the end of make.log 
     80 1. If everything goes well, try running "`bcfg2-repo-validate`". This should  
     81    not generate a python traceback, but will probably throw an error. 
     83Packages that you can install on other machines will be in the "`DIST`"  
     84directory. In most cases you will only need the self-extracting/installing 
     85package with the name like "`bcfg2-*.run`"; that will install the bcfg2 client. 
     87You can install the doc packages if you want, although it probably makes more 
     88sense to let bcfg2 install them on machines you want to have them on after you 
     89get stuff up and running. 
     91On GNU/Linux platforms, glib and gamin will also be built; these only have to be installed only on the bcfg2 server machine. 
     93Cheetah will be built on all platforms (as it is needed as a build-time  
     94prerequisite), however for run-time it only needs to be installed on the bcfg2 
     95server machine. 
     97== Next step == 
     98For more information on the "`bcfg2-*.run`" file and what to do next, see the 
     99[wiki:EncapHowto HOWTO]. 
     101== Documentation Version == 
     102 * This is a copy of: $Id: INSTALL 2173 2006-09-02 23:37:24Z dclark $ 
     103 * Most recent version: