<h1>Fossil Cookbook</h1>
The <cite>Fossil</cite> Cookbook is a collection of task-oriented instructions for intermediate users who wish to do more than basic operations with their <cite>Fossil</cite> repositories.  The [Tutorial|tutorial] is a more suitable place for newcomers trying to learn the basic concepts to go first before tackling these recipes.

<h2>Index</h2>
Server recipes:
  *  <a href="#CGI">Using <cite>Fossil</cite>'s Built-In CGI</a>

<h2><a name="CGI">Using <cite>Fossil</cite>'s Built-In
<h3>Motivation</h3>
  *  You want to share a repository through your existing web infrastructure.
  *  You want to share more than one repository at the same time.

<h3>Problem</h3>
Unlike some other distributed SCMs, <cite>Fossil</cite> can only clone, push, pull and and otherwise interact through repositories over HTTP.  This can be simply and easily managed through use of the <code>fossil server</code> and/or <code>fossil ui</code> commands, of course, but this is really only adequate for ad-hoc repository sharing.  Consider, for example, sharing ten repositories.  Using the built-in server would require you to open ten ports in your firewall to permit access.  Any serious sharing will require something more robust and permanent.

<h3>Solution</h3>
<cite>Fossil</cite> supports three different ways to share repositories.  For ad-hoc sharing <code>fossil is more than adequate.  For more robust solutions, however, the use of <cite>(x)inetd</cite> or CGI support is indicated.

Setting up fossil for CGI support is simple.  (Setting up your web server for CGI support may or may not be simple, but it is out of scope of this recipe.  Consult your web server/service provider's documentation for this.)

<h4>UNIX</h4>
  1.  Find your CGI scripts directory (if applicable).  This is commonly something like but does not have to be.
  2.  Inside that directory build a script file which looks like this:<br><code><pre>  #! fossil<br>  repository:
  3.  Ensure that the script file so generated is set executable for the CGI user account.
  4.  Ensure that every directory in the path leading to the repository is  browseable (chmod +x) to the CGI user account.
  5.  Ensure that the repository file is readable <em>and</em> writable to the CGI user account.

The following <cite>bash</cite> script can be run from within the directory containing the <cite>Fossil</cite> repositories to be shared (and, of course, altered for your setup) to set some of the constraints above up automatically:

<nowiki><font face="monospace">
<font color="#a52a2a">&nbsp;1 </font><font color="#0000ff">#! bash</font><br>
<font color="#a52a2a">&nbsp;2 </font><font
<font color="#a52a2a">&nbsp;3 </font><font color="#008b8b">REPOSITORY_OWNER</font>=michael<br>
<font color="#a52a2a">&nbsp;4 </font><font color="#008b8b">CGI_GROUP</font>=www-data<br>
<font color="#a52a2a">&nbsp;5 </font><font color="#6a5acd">`whoami`</font>&nbsp;<font color="#ff00ff">'root'</font>&nbsp;<font
<font color="#a52a2a">&nbsp;6 </font><font
<font color="#a52a2a">&nbsp;7 </font>&nbsp;&nbsp;<font <font
<font color="#a52a2a">&nbsp;8 </font>&nbsp;&nbsp;<font
<font color="#a52a2a">&nbsp;9 </font>&nbsp;&nbsp;&nbsp;&nbsp;<font color="#008b8b">SOURCE</font>=<font color="#6a5acd">`</font><font color="#a020f0">$repository</font><br>
<font color="#a52a2a">10 </font>&nbsp;&nbsp;&nbsp;&nbsp;<font color="#008b8b">DESTINATION</font>=<font color="#a020f0">${</font><font color="#a020f0">repository</font><font color="#a020f0">}</font><br>
<font color="#a52a2a">11 </font>&nbsp;&nbsp;&nbsp;&nbsp;<font color="#ff00ff">&nbsp;</font><font color="#ff00ff">#! fossil</font><font color="#ff00ff">&nbsp;</font><font color="#a020f0">$DESTINATION</font><br>
<font color="#a52a2a">12 </font>&nbsp;&nbsp;&nbsp;&nbsp;<font color="#ff00ff">&nbsp;</font><font color="#ff00ff">repository: </font><font color="#a020f0">$SOURCE</font><font color="#ff00ff">&nbsp;</font><font color="#a020f0">$DESTINATION</font><br>
<font color="#a52a2a">13 </font>&nbsp;&nbsp;&nbsp;&nbsp;chown <font color="#a020f0">$REPOSITORY_OWNER</font>:<font color="#a020f0">$CGI_GROUP</font>&nbsp;<font color="#a020f0">$SOURCE</font><br>
<font color="#a52a2a">14 </font>&nbsp;&nbsp;&nbsp;&nbsp;<font color="#ff00ff">664</font>&nbsp;<font color="#a020f0">$SOURCE</font><br>
<font color="#a52a2a">15 </font>&nbsp;&nbsp;&nbsp;&nbsp;chown root:root <font color="#a020f0">$DESTINATION</font><br>
<font color="#a52a2a">16 </font>&nbsp;&nbsp;&nbsp;&nbsp;<font color="#ff00ff">755</font>&nbsp;<font color="#a020f0">$DESTINATION</font><br>
<font color="#a52a2a">17 </font>&nbsp;&nbsp;<font
<font color="#a52a2a">18 </font><font
<font color="#a52a2a">19 </font>&nbsp;&nbsp;sudo <font color="#a020f0">$0</font>&nbsp;<font color="#a020f0">$*</font><br>
<font color="#a52a2a">20 </font><font


<h4>Windows</h4>
<p>While it is far from a perfect set of instructions.. here are some quick notes that should help windows users along the way...</p>
<ul>
<li>you need fossil.exe accessible by your web server or on your path.. easiest is to just chuck it in (usually </li>
<li>assuming you are running apache, you need to either add the ExecCGI to the options on your DocumentRoot, or make sure the ScriptAlias directive is set and put your .cgi files in that folder..</li>
<li>the contents of your cgi file needs to essentially the same as above.. however paths needs to be windows friendly.. i have made sure that all folders on my test box are free of spaces, and as such this file works for me (obviously your paths may differ)
<pre>
#! fossil.exe
repository:
</pre>
I suppose you could put fossil.exe somewhere more specific and set the path to it as well, but since you are probably using the same executable for cmdline and cgi it kind of just makes sense to put it somewhere more accessible</li>
<li>As with most Windows based web instructions, permission are not as important, however at the least, you need to make sure that your repository is not flagged read-only, as you will encounter database errors if it is.</li>
</ul>

<h3>Discussion</h3>
Using the CGI server is the best solution combining an existing web infrastructure and the sharing of many <cite>Fossil</cite> repositories.  Unlike the ad-hoc solution which requires, in effect, a separate port for each simultaneously-shared repository, and which requires several instances of fossil running -- one for each shared repository -- the CGI approach uses URLs to distinguish between repositories and only (briefly) runs a copy of fossil when the repository is actually accessed.

Sharing repositories with CGI is really only worth the effort if more than one repository is being shared, however.  With only one being shared, <code>fossil server</code> is likely more than adequate or the use of (x)inetd may be indicated.  If, however, there is already an existing web infrastructure in place, CGI still may be preferred if only for consistency and maintainability of the system as a whole.