Fossil SCM
Assorted improvements to the "Setting Up A Server" section in the quickstart guide, primarily clarity and linking to other sources of related info.
Commit
f17ab2989ac55a6eeea6da377f33336f410373c9f4a32fcd9907064cfa69b312
Parent
5015043b2d3e06f…
1 file changed
+26
-10
+26
-10
| --- www/quickstart.wiki | ||
| +++ www/quickstart.wiki | ||
| @@ -37,11 +37,11 @@ | ||
| 37 | 37 | <li>Perform operations on the repository (including repository |
| 38 | 38 | configuration). |
| 39 | 39 | </ul> |
| 40 | 40 | |
| 41 | 41 | Fossil can be entirely driven from the command line. Many features |
| 42 | -can also be conveniently accessed from the build-in web interface. | |
| 42 | +can also be conveniently accessed from the built-in web user interface. | |
| 43 | 43 | |
| 44 | 44 | <p>The following sections give a brief overview of these |
| 45 | 45 | operations.</p> |
| 46 | 46 | |
| 47 | 47 | <h2 id="new">Starting A New Project</h2> |
| @@ -503,30 +503,46 @@ | ||
| 503 | 503 | <b>[/help/server | fossil server]</b> <i>repository-filename</i><br> |
| 504 | 504 | <b>[/help/ui | fossil ui]</b> <i>repository-filename</i> |
| 505 | 505 | </blockquote> |
| 506 | 506 | |
| 507 | 507 | <p>The <i>repository-filename</i> can be omitted when these commands |
| 508 | -are run from within an open check-out, which a particularly useful | |
| 509 | -shortcut for the <b>fossil ui</b> command. | |
| 510 | - | |
| 511 | -<p>The <b>ui</b> command is intended for accessing the web interface | |
| 512 | -from a local desktop. The <b>ui</b> command binds to the loopback IP | |
| 513 | -address only (and thus makes the web interface visible only on the | |
| 514 | -local machine) and it automatically start your web browser pointing at the | |
| 515 | -server. For cross-machine collaboration, use the <b>server</b> command, | |
| 516 | -which binds on all IP addresses and does not try to start a web browser.</p> | |
| 508 | +are run from within an open check-out, which is a particularly useful | |
| 509 | +shortcut with the <b>fossil ui</b> command. | |
| 510 | + | |
| 511 | +<p>The <b>ui</b> command is intended for accessing the web user interface | |
| 512 | +from a local desktop. (We sometimes call this mode "Fossil UI.") | |
| 513 | +The <b>ui</b> command differs from the | |
| 514 | +<b>server</b> command by binding to the loopback IP | |
| 515 | +address only (thus making the web UI visible only on the | |
| 516 | +local machine) and by automatically starting your default web browser, | |
| 517 | +pointing it at the running UI | |
| 518 | +server. The localhost restriction exists because it also gives anyone | |
| 519 | +who can access the resulting web UI full control over the | |
| 520 | +repository. (This is the [./caps/admin-v-setup.md#apsu | all-powerful | |
| 521 | +Setup capabliity].)</p> | |
| 522 | + | |
| 523 | +<p>For cross-machine collaboration, use the <b>server</b> command instead, | |
| 524 | +which binds on all IP addresses, does not try to start a web browser, | |
| 525 | +and enforces [./caps/ | Fossil's role-based access control system].</p> | |
| 517 | 526 | |
| 518 | 527 | <p>Servers are also easily configured as: |
| 528 | + | |
| 519 | 529 | <ul> |
| 520 | 530 | <li>[./server/any/inetd.md|inetd] |
| 521 | 531 | <li>[./server/debian/service.md|systemd] |
| 522 | 532 | <li>[./server/any/cgi.md|CGI] |
| 523 | 533 | <li>[./server/any/scgi.md|SCGI] |
| 524 | 534 | </ul> |
| 525 | 535 | |
| 536 | +<p>…along with [./server/#matrix | several other options].</p> | |
| 537 | + | |
| 526 | 538 | <p>The [./selfhost.wiki | self-hosting fossil repositories] use |
| 527 | 539 | CGI. |
| 540 | + | |
| 541 | +<p>You might <i>need</i> to set up a server, whether you know it yet or | |
| 542 | +not. See the [./server/whyuseaserver.wiki | Benefits of a Fossil Server] | |
| 543 | +article details.</p> | |
| 528 | 544 | |
| 529 | 545 | <h2 id="proxy">HTTP Proxies</h2> |
| 530 | 546 | |
| 531 | 547 | <p>If you are behind a restrictive firewall that requires you to use |
| 532 | 548 | an HTTP proxy to reach the internet, then you can configure the proxy |
| 533 | 549 |
| --- www/quickstart.wiki | |
| +++ www/quickstart.wiki | |
| @@ -37,11 +37,11 @@ | |
| 37 | <li>Perform operations on the repository (including repository |
| 38 | configuration). |
| 39 | </ul> |
| 40 | |
| 41 | Fossil can be entirely driven from the command line. Many features |
| 42 | can also be conveniently accessed from the build-in web interface. |
| 43 | |
| 44 | <p>The following sections give a brief overview of these |
| 45 | operations.</p> |
| 46 | |
| 47 | <h2 id="new">Starting A New Project</h2> |
| @@ -503,30 +503,46 @@ | |
| 503 | <b>[/help/server | fossil server]</b> <i>repository-filename</i><br> |
| 504 | <b>[/help/ui | fossil ui]</b> <i>repository-filename</i> |
| 505 | </blockquote> |
| 506 | |
| 507 | <p>The <i>repository-filename</i> can be omitted when these commands |
| 508 | are run from within an open check-out, which a particularly useful |
| 509 | shortcut for the <b>fossil ui</b> command. |
| 510 | |
| 511 | <p>The <b>ui</b> command is intended for accessing the web interface |
| 512 | from a local desktop. The <b>ui</b> command binds to the loopback IP |
| 513 | address only (and thus makes the web interface visible only on the |
| 514 | local machine) and it automatically start your web browser pointing at the |
| 515 | server. For cross-machine collaboration, use the <b>server</b> command, |
| 516 | which binds on all IP addresses and does not try to start a web browser.</p> |
| 517 | |
| 518 | <p>Servers are also easily configured as: |
| 519 | <ul> |
| 520 | <li>[./server/any/inetd.md|inetd] |
| 521 | <li>[./server/debian/service.md|systemd] |
| 522 | <li>[./server/any/cgi.md|CGI] |
| 523 | <li>[./server/any/scgi.md|SCGI] |
| 524 | </ul> |
| 525 | |
| 526 | <p>The [./selfhost.wiki | self-hosting fossil repositories] use |
| 527 | CGI. |
| 528 | |
| 529 | <h2 id="proxy">HTTP Proxies</h2> |
| 530 | |
| 531 | <p>If you are behind a restrictive firewall that requires you to use |
| 532 | an HTTP proxy to reach the internet, then you can configure the proxy |
| 533 |
| --- www/quickstart.wiki | |
| +++ www/quickstart.wiki | |
| @@ -37,11 +37,11 @@ | |
| 37 | <li>Perform operations on the repository (including repository |
| 38 | configuration). |
| 39 | </ul> |
| 40 | |
| 41 | Fossil can be entirely driven from the command line. Many features |
| 42 | can also be conveniently accessed from the built-in web user interface. |
| 43 | |
| 44 | <p>The following sections give a brief overview of these |
| 45 | operations.</p> |
| 46 | |
| 47 | <h2 id="new">Starting A New Project</h2> |
| @@ -503,30 +503,46 @@ | |
| 503 | <b>[/help/server | fossil server]</b> <i>repository-filename</i><br> |
| 504 | <b>[/help/ui | fossil ui]</b> <i>repository-filename</i> |
| 505 | </blockquote> |
| 506 | |
| 507 | <p>The <i>repository-filename</i> can be omitted when these commands |
| 508 | are run from within an open check-out, which is a particularly useful |
| 509 | shortcut with the <b>fossil ui</b> command. |
| 510 | |
| 511 | <p>The <b>ui</b> command is intended for accessing the web user interface |
| 512 | from a local desktop. (We sometimes call this mode "Fossil UI.") |
| 513 | The <b>ui</b> command differs from the |
| 514 | <b>server</b> command by binding to the loopback IP |
| 515 | address only (thus making the web UI visible only on the |
| 516 | local machine) and by automatically starting your default web browser, |
| 517 | pointing it at the running UI |
| 518 | server. The localhost restriction exists because it also gives anyone |
| 519 | who can access the resulting web UI full control over the |
| 520 | repository. (This is the [./caps/admin-v-setup.md#apsu | all-powerful |
| 521 | Setup capabliity].)</p> |
| 522 | |
| 523 | <p>For cross-machine collaboration, use the <b>server</b> command instead, |
| 524 | which binds on all IP addresses, does not try to start a web browser, |
| 525 | and enforces [./caps/ | Fossil's role-based access control system].</p> |
| 526 | |
| 527 | <p>Servers are also easily configured as: |
| 528 | |
| 529 | <ul> |
| 530 | <li>[./server/any/inetd.md|inetd] |
| 531 | <li>[./server/debian/service.md|systemd] |
| 532 | <li>[./server/any/cgi.md|CGI] |
| 533 | <li>[./server/any/scgi.md|SCGI] |
| 534 | </ul> |
| 535 | |
| 536 | <p>…along with [./server/#matrix | several other options].</p> |
| 537 | |
| 538 | <p>The [./selfhost.wiki | self-hosting fossil repositories] use |
| 539 | CGI. |
| 540 | |
| 541 | <p>You might <i>need</i> to set up a server, whether you know it yet or |
| 542 | not. See the [./server/whyuseaserver.wiki | Benefits of a Fossil Server] |
| 543 | article details.</p> |
| 544 | |
| 545 | <h2 id="proxy">HTTP Proxies</h2> |
| 546 | |
| 547 | <p>If you are behind a restrictive firewall that requires you to use |
| 548 | an HTTP proxy to reach the internet, then you can configure the proxy |
| 549 |