Fossil

Check-in [f17ab2989a]
Login

Check-in [f17ab2989a]

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

Overview
Comment:Assorted improvements to the "Setting Up A Server" section in the quickstart guide, primarily clarity and linking to other sources of related info.
Downloads: Tarball | ZIP archive
Timelines: family | ancestors | descendants | both | trunk
Files: files | file ages | folders
SHA3-256: f17ab2989ac55a6eeea6da377f33336f410373c9f4a32fcd9907064cfa69b312
User & Date: wyoung 2021-04-15 03:11:05.700
Original User & Date: tangent 2021-04-15 03:11:05.700
Context
2021-04-15
03:20
Added a paragraph to point #5 in the "benefits of a server" doc to point to Larry Brasfield's new "SQLite Over a Network, Caveats and Considerations" article and to give a Fossil-specific gloss on it. ... (check-in: 130abdcec2 user: wyoung tags: trunk)
03:11
Assorted improvements to the "Setting Up A Server" section in the quickstart guide, primarily clarity and linking to other sources of related info. ... (check-in: f17ab2989a user: wyoung tags: trunk)
2021-04-13
13:53
Retain original finfo behavior by introducing a new "mode" for artifact-id. ... (check-in: 5015043b2d user: andybradford tags: trunk)
Changes
Unified Diff Ignore Whitespace Patch
Changes to www/quickstart.wiki.
︙︙
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49

        [/help/clone | fossil clone])
    <li>Check out a local tree.  ([/help/open | fossil open])
    <li>Perform operations on the repository (including repository
        configuration).
</ul>

Fossil can be entirely driven from the command line. Many features
can also be conveniently accessed from the build-in web interface.

<p>The following sections give a brief overview of these
operations.</p>

<h2 id="new">Starting A New Project</h2>

<p>To start a new project with fossil create a new empty repository








|








35
36
37
38
39
40
41
42
43
44
45
46
47
48
49

        [/help/clone | fossil clone])
    <li>Check out a local tree.  ([/help/open | fossil open])
    <li>Perform operations on the repository (including repository
        configuration).
</ul>

Fossil can be entirely driven from the command line. Many features
can also be conveniently accessed from the built-in web user interface.

<p>The following sections give a brief overview of these
operations.</p>

<h2 id="new">Starting A New Project</h2>

<p>To start a new project with fossil create a new empty repository
︙︙
501
502
503
504
505
506
507
508
509
510
511

512

513






514
515
516

517
518

519
520
521
522
523
524
525


526
527




528
529
530
531
532
533
534


<blockquote>
<b>[/help/server | fossil server]</b> <i>repository-filename</i><br>
<b>[/help/ui | fossil ui]</b> <i>repository-filename</i>
</blockquote>

<p>The <i>repository-filename</i> can be omitted when these commands
are run from within an open check-out, which a particularly useful
shortcut for the <b>fossil ui</b> command.

<p>The <b>ui</b> command is intended for accessing the web interface

from a local desktop.  The <b>ui</b> command binds to the loopback IP

address only (and thus makes the web interface visible only on the






local machine) and it automatically start your web browser pointing at the
server.  For cross-machine collaboration, use the <b>server</b> command,
which binds on all IP addresses and does not try to start a web browser.</p>


<p>Servers are also easily configured as:

<ul>
<li>[./server/any/inetd.md|inetd]
<li>[./server/debian/service.md|systemd]
<li>[./server/any/cgi.md|CGI]
<li>[./server/any/scgi.md|SCGI]
</ul>



<p>The [./selfhost.wiki | self-hosting fossil repositories] use
CGI.





<h2 id="proxy">HTTP Proxies</h2>

<p>If you are behind a restrictive firewall that requires you to use
an HTTP proxy to reach the internet, then you can configure the proxy
in three different ways.  You can tell fossil about your proxy using
a command-line option on commands that use the network,








|
|

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


>







>
>


>
>
>
>








501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550


<blockquote>
<b>[/help/server | fossil server]</b> <i>repository-filename</i><br>
<b>[/help/ui | fossil ui]</b> <i>repository-filename</i>
</blockquote>

<p>The <i>repository-filename</i> can be omitted when these commands
are run from within an open check-out, which is a particularly useful
shortcut with the <b>fossil ui</b> command.

<p>The <b>ui</b> command is intended for accessing the web user interface
from a local desktop. (We sometimes call this mode "Fossil UI.")
The <b>ui</b> command differs from the
<b>server</b> command by binding to the loopback IP
address only (thus making the web UI visible only on the
local machine) and by automatically starting your default web browser,
pointing it at the running UI
server. The localhost restriction exists because it also gives anyone
who can access the resulting web UI full control over the
repository. (This is the [./caps/admin-v-setup.md#apsu | all-powerful
Setup capabliity].)</p>

<p>For cross-machine collaboration, use the <b>server</b> command instead,
which binds on all IP addresses, does not try to start a web browser,
and enforces [./caps/ | Fossil's role-based access control system].</p>

<p>Servers are also easily configured as:

<ul>
<li>[./server/any/inetd.md|inetd]
<li>[./server/debian/service.md|systemd]
<li>[./server/any/cgi.md|CGI]
<li>[./server/any/scgi.md|SCGI]
</ul>

<p>…along with [./server/#matrix | several other options].</p>

<p>The [./selfhost.wiki | self-hosting fossil repositories] use
CGI.

<p>You might <i>need</i> to set up a server, whether you know it yet or
not.  See the [./server/whyuseaserver.wiki | Benefits of a Fossil Server]
article details.</p>

<h2 id="proxy">HTTP Proxies</h2>

<p>If you are behind a restrictive firewall that requires you to use
an HTTP proxy to reach the internet, then you can configure the proxy
in three different ways.  You can tell fossil about your proxy using
a command-line option on commands that use the network,
︙︙