Fossil

Building and Installing Fossil
Login

Building and Installing Fossil

0.0 Using A Pre-compiled Binary

You can skip all of the following by downloading a pre-compiled binary appropriate for your platform and putting that self-contained binary someplace on your $PATH. To uninstall, simply delete the binary. To upgrade from an older release, just overwrite the older binary with the newer one.

0.1 Executive Summary

Building and installing is very simple. Three steps:

  1. Download and unpack a source tarball or ZIP.
  2. ./configure; make
  3. Move or copy the resulting "fossil" executable to someplace on your $PATH.


1.0 Obtaining The Source Code

Fossil is self-hosting, so you can obtain a ZIP archive containing a snapshot of the latest version directly from fossil's own fossil repository. Follow these steps:

  1. Point your web browser at http://www.fossil-scm.org/. Click on the "Login" menu button.

  2. Log in as anonymous. The password is shown on screen. The reason for requiring this login is to prevent spiders from walking the entire website, downloading ZIP archives of every historical version, and thereby soaking up all our bandwidth.

  3. Click on the Timeline link at the top of the page.

  4. Select a version of of fossil you want to download. Click on its link. Note that you must successfully log in as "anonymous" in step 1 above in order to see the link to the detailed version information.

  5. Finally, click on one of the "Zip Archive" or "Tarball" links, according to your preference. These link will build a ZIP archive or a gzip-compressed tarball of the complete source code and download it to your browser.

2.0 Compiling

  1. Unpack the ZIP or tarball you downloaded into that directory then cd into the directory created.

  2. (Optional, unix only) Run ./configure to construct a makefile.

    1. If you do not have the OpenSSL library installed on your system, then add --with-openssl=none to omit the https functionality.

    2. To build a statically linked binary (suitable for use inside a chroot jail) add the --static option.

    3. Other configuration options can be seen by running ./configure --help

  3. Run make to build the "fossil" or "fossil.exe" executable. The details depend on your platform and compiler.

    1. Unix → the configure-generated Makefile should work on all unix and unix-like systems. Simply type "make".

    2. Unix without running "configure" → if you prefer to avoid running configure, you can also use: make -f Makefile.classic. You may want to make minor edits to Makefile.classic to configure the build for your system.

    3. Msys/MinGW → Use the mingw makefile: "make -f win/Makefile.mingw"

    4. VC++ → Use the msc makefile. First change to the "win/" subdirectory ("cd win") then run "nmake /f Makefile.msc".

Note that Fossil requires the "zlib" compression library. This library is available by default on most unix systems, but it will typically have to be installed separately on windows systems. For windows builds, you may need to edit the makefile to tell it exactly where zlib is located on your system.

3.0 Installing

  1. The finished binary is named "fossil" (or "fossil.exe" on windows). Put this binary in a directory that is somewhere on your PATH environment variable. It does not matter where.

  2. (Optional:) To uninstall, just delete the binary.

4.0 Additional Considerations