Fossil

Check-in [154ea087]
Login

Many hyperlinks are disabled.
Use anonymous login to enable hyperlinks.

Overview
Comment:Outline how to configure a repository before and after server activation.
Downloads: Tarball | ZIP archive | SQL archive
Timelines: family | ancestors | descendants | both | trunk
Files: files | file ages | folders
SHA3-256: 154ea087af6d39dbcb45799f9af88d8ad2f2a759b1e0faaf1d1224182c235a88
User & Date: drh 2019-08-21 18:15:14
Context
2019-08-21
19:18
Fix the $ROOT mechanism in HTML documents so that it accepts any whitespace character before href= and script=. Add $ROOT in appropriate places in the server documentation. check-in: 3e183bfa user: drh tags: trunk
18:15
Outline how to configure a repository before and after server activation. check-in: 154ea087 user: drh tags: trunk
17:37
Improvements to the althttpd documentation. check-in: 44f1df9f user: drh tags: trunk
Changes
Hide Diffs Unified Diffs Ignore Whitespace Patch

Changes to www/server/index.html.

61
62
63
64
65
66
67
































68
69
70
71
72
73
74
75
76
77
...
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
...
227
228
229
230
231
232
233




































234
235
236
237
238
239
240
or on a small device like a RaspberryPI, or it can co-exist 
on a host running other services without getting in the way.

<p>This article is a quick-reference guide for setting up your own
Fossil server, with links to more detailed instructions specific to
particular systems, should you want extra help.</p>

































<h2 id="methods">Methods</h2>

<p>There are basically four ways to set up a Fossil server:</p>

<ol>
  <li><a id="cgi"        href="any/cgi.md">CGI</a>
  <li>Socket listener
  <li><a id="standalone" href="any/none.md">Stand-alone HTTP server</a>
  <li><a id="scgi"       href="any/scgi.md">SCGI</a>
</ol>
................................................................................
than HTTP, since the HTTP doesn't have to be re-interpreted in terms of
the proxy's existing HTTP implementation, but it's more complex to set
up because you also have to set up an SCGI-to-HTTP proxy for it. It is
worth taking on this difficulty only when you need to integrate Fossil
into an existing web site already being served by an SCGI-capable web
server.</p>

<h2 id="matrix">Setup Tutorials</h2>

<p>We've broken the configuration for each method out into a series of
sub-articles. Some of these are generic, while others depend on
particular operating systems or front-end software:</p>

<div id="tutpick" class="show"></div>

................................................................................
Fossil's built-in HTTP server: <a href="debian/nginx.md">nginx</a>, <a
href="windows/iis.md">IIS</a>, Apache, etc.</p>

<p>We welcome <a href="../contribute.wiki">contributions</a> to fill gaps
(<font size="-2">❌</font>) in the table above.</p>
</noscript>






































<h2 id="more">Further Details</h2>

<ul>
  <li><a id="chroot"   href="../chroot.md"     >The Server Chroot Jail</a>
  <li><a id="loadmgmt" href="../loadmgmt.md"   >Managing Server Load</a>
  <li><a id="bkofc"    href="../backoffice.md" >The Backoffice</a>







>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
|

|







 







|







 







>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>







61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
...
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
...
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
or on a small device like a RaspberryPI, or it can co-exist 
on a host running other services without getting in the way.

<p>This article is a quick-reference guide for setting up your own
Fossil server, with links to more detailed instructions specific to
particular systems, should you want extra help.</p>

<h2 id="prep">Repository Prep</h2>

<p>
Prior to launching a server on a Fossil repository, it is best to
prepare the repository to be served.  The easiest way to do this
is to run the <a href="/help?cmd=ui"><tt>fossil ui</tt></a> command
on a workstation and then visit the "Setup" menu.  
Minimum preparation actions include:</p>

<ol>
<li>
Ensure that you have an administrator user account and password
configured.  Visit the Setup/Users page to accomplish this.</p></li>
<li>
Visit the Setup/Security-Audit page to verify that other
security-related permissions and settings are as you want them.
You might want to configure the repository to be completely private
for the initial upload and server activatation, then open access up to
the public as part of the 
<a href="#postsetup">post-activation configuration refinement</a>
stage.
</p></li>
</ol>

<p>
Additional configuration can be accomplished after the server is up
and running.  Once the preliminary configuration is completed
upload the repository database file to the server and proceed to
activate the server using one or more of the techniques described
in the next two sections.
</p>

<h2 id="methods">Activation Methods</h2>

<p>There are basically four ways to run a Fossil server:</p>

<ol>
  <li><a id="cgi"        href="any/cgi.md">CGI</a>
  <li>Socket listener
  <li><a id="standalone" href="any/none.md">Stand-alone HTTP server</a>
  <li><a id="scgi"       href="any/scgi.md">SCGI</a>
</ol>
................................................................................
than HTTP, since the HTTP doesn't have to be re-interpreted in terms of
the proxy's existing HTTP implementation, but it's more complex to set
up because you also have to set up an SCGI-to-HTTP proxy for it. It is
worth taking on this difficulty only when you need to integrate Fossil
into an existing web site already being served by an SCGI-capable web
server.</p>

<h2 id="matrix">Activation Tutorials</h2>

<p>We've broken the configuration for each method out into a series of
sub-articles. Some of these are generic, while others depend on
particular operating systems or front-end software:</p>

<div id="tutpick" class="show"></div>

................................................................................
Fossil's built-in HTTP server: <a href="debian/nginx.md">nginx</a>, <a
href="windows/iis.md">IIS</a>, Apache, etc.</p>

<p>We welcome <a href="../contribute.wiki">contributions</a> to fill gaps
(<font size="-2">❌</font>) in the table above.</p>
</noscript>

<h2 id="postsetup">Post-Activation Configuration</h2>

<p>After the server is up and running, additional configuration
fine-tuning can be accomplished by logging in as an administrator
and visiting the Setup menu.  Pay particular attention to the
"Setup/Security-Audit" page to ensure that you have not mistakenly
configured the server in a way that might expose information that you
want to keep private. Other post-activation steps include the following:</p>

<ol>
<li>
Add additional users accounts so that all team members have appropriate
check-in and check-out access to the repository.</li>
<li>
Modify the look-and-feel of site by customizing the skin.
<li>
If the repository includes <a href="../embeddeddoc.wiki">embedded
documentation</a> then perhaps activate the search feature so that
visitors can do full-text search on your documentation.
<li>
Connect the repository to an email server so that it can send email
notifications of new check-ins or other repository activate.
<li>
Turn on the various logging features.
<li>
If you locked down the repository as completely private prior to
upload, you might want to open up access to the public once you get
everything working.  Or, keep the repository private, according to
your needs.
</ol>

<p>
After any signification configuration change, it is a good idea to
revisit the Setup/Security-Audit page just to double-check that you
have not created any security problems in your installation.
</p>

<h2 id="more">Further Details</h2>

<ul>
  <li><a id="chroot"   href="../chroot.md"     >The Server Chroot Jail</a>
  <li><a id="loadmgmt" href="../loadmgmt.md"   >Managing Server Load</a>
  <li><a id="bkofc"    href="../backoffice.md" >The Backoffice</a>