Fossil SCM
Further tightening of the Quick Start.
Commit
eb52410b0c3219aa5aff7aca5487e769e3d9d0fa5be3c819ffe08c5732516edc
Parent
529b94795da1640…
1 file changed
+21
-22
+21
-22
| --- www/quickstart.wiki | ||
| +++ www/quickstart.wiki | ||
| @@ -79,14 +79,14 @@ | ||
| 79 | 79 | <h2 id="clone">Cloning An Existing Repository</h2> |
| 80 | 80 | |
| 81 | 81 | Most fossil operations interact with a repository that is on the |
| 82 | 82 | local disk drive, not on a remote system. Hence, before accessing |
| 83 | 83 | a remote repository it is necessary to make a local copy of that |
| 84 | -repository. Making a local copy of a remote repository is called | |
| 85 | -"cloning". | |
| 84 | +repository, a process called | |
| 85 | +"[/help/clone | cloning]". | |
| 86 | 86 | |
| 87 | -Clone a remote repository as follows: ([/help/clone | more info]) | |
| 87 | +This is done as follows: | |
| 88 | 88 | |
| 89 | 89 | <pre><b>fossil clone</b> <i>URL repository-filename</i> |
| 90 | 90 | </pre> |
| 91 | 91 | |
| 92 | 92 | The <i>URL</i> specifies the fossil repository |
| @@ -158,26 +158,23 @@ | ||
| 158 | 158 | |
| 159 | 159 | <h2 id="checkout">Checking Out A Local Tree</h2> |
| 160 | 160 | |
| 161 | 161 | To work on a project in fossil, you need to check out a local |
| 162 | 162 | copy of the source tree. Create the directory you want to be |
| 163 | -the root of your tree and cd into that directory. Then | |
| 164 | -do this: ([/help/open | more info]) | |
| 163 | +the root of your tree, <tt>cd</tt> into that directory, and then: | |
| 165 | 164 | |
| 166 | 165 | <pre><b>fossil open</b> <i>repository-filename</i></pre> |
| 167 | 166 | |
| 168 | -for example: | |
| 167 | +For example: | |
| 169 | 168 | |
| 170 | 169 | <pre><b>fossil open ../myclone.fossil |
| 171 | 170 | BUILD.txt |
| 172 | 171 | COPYRIGHT-BSD2.txt |
| 173 | 172 | README.md |
| 174 | 173 | ︙ |
| 175 | 174 | </tt></b></pre> |
| 176 | 175 | |
| 177 | -(or "fossil open ..\myclone.fossil" on Windows). | |
| 178 | - | |
| 179 | 176 | This leaves you with the newest version of the tree |
| 180 | 177 | checked out. |
| 181 | 178 | From anywhere underneath the root of your local tree, you |
| 182 | 179 | can type commands like the following to find out the status of |
| 183 | 180 | your local tree: |
| @@ -329,37 +326,39 @@ | ||
| 329 | 326 | |
| 330 | 327 | <h2 id="config">Configuring Your Local Repository</h2> |
| 331 | 328 | |
| 332 | 329 | When you create a new repository, either by cloning an existing |
| 333 | 330 | project or create a new project of your own, you usually want to do some |
| 334 | -local configuration. This is easily accomplished using the web-server | |
| 335 | -that is built into fossil. Start the fossil web server like this: | |
| 336 | -([/help/ui | more info]) | |
| 331 | +local configuration. This is most easily accomplished using the web-server | |
| 332 | +that is built into Fossil, like so: | |
| 337 | 333 | |
| 338 | 334 | <pre> |
| 339 | 335 | <b>fossil ui</b> <i>repository-filename</i> |
| 340 | 336 | </pre> |
| 341 | 337 | |
| 342 | -You can omit the <i>repository-filename</i> from the command above | |
| 338 | +You can shorten that to just [/help/ui | <b>fossil ui</b>] | |
| 343 | 339 | if you are inside a checked-out local tree. |
| 344 | 340 | |
| 345 | -This starts a web server then automatically launches your | |
| 346 | -web browser and makes it point to this web server. If your system | |
| 347 | -has an unusual configuration, fossil might not be able to figure out | |
| 348 | -how to start your web browser. In that case, first tell fossil | |
| 349 | -where to find your web browser using a command like this: | |
| 341 | +After the internal web server starts, Fossil automatically launches your | |
| 342 | +default web browser, pointed at itself. You may override that default so: | |
| 350 | 343 | |
| 351 | 344 | <pre> |
| 352 | 345 | <b>fossil setting web-browser</b> <i>path-to-web-browser</i> |
| 353 | 346 | </pre> |
| 354 | 347 | |
| 355 | -By default, fossil does not require a login for HTTP connections | |
| 356 | -coming in from the IP loopback address 127.0.0.1. You can, and perhaps | |
| 357 | -should, change this after you create a few users. | |
| 348 | +Fossil binds this web server to the IP loopback address (127.0.0.1) | |
| 349 | +which it treats specially when launched this way, bypassing all user | |
| 350 | +controls. Why is that a good idea, you ask? Because it is a safe | |
| 351 | +presumption that only someone with direct file access to the repository | |
| 352 | +database file could be using the resulting web interface. Anyone who can | |
| 353 | +modify the repo DB directly could give themselves any and all access | |
| 354 | +with a SQL query, or even by direct file manipulation; no amount of | |
| 355 | +access control matters to such a user. | |
| 358 | 356 | |
| 359 | -When you are finished configuring, just press Control-C or use | |
| 360 | -the <b>kill</b> command to shut down the mini-server. | |
| 357 | +Once you are finished configuring Fossil, you may safely Control-C out | |
| 358 | +of the <b>fossil ui</b> command to shut down this privileged | |
| 359 | +built-in web server. | |
| 361 | 360 | |
| 362 | 361 | <h2 id="sharing">Sharing Changes</h2> |
| 363 | 362 | |
| 364 | 363 | When [./concepts.wiki#workflow|autosync] is turned off, |
| 365 | 364 | the changes you [/help/commit | commit] are only |
| 366 | 365 |
| --- www/quickstart.wiki | |
| +++ www/quickstart.wiki | |
| @@ -79,14 +79,14 @@ | |
| 79 | <h2 id="clone">Cloning An Existing Repository</h2> |
| 80 | |
| 81 | Most fossil operations interact with a repository that is on the |
| 82 | local disk drive, not on a remote system. Hence, before accessing |
| 83 | a remote repository it is necessary to make a local copy of that |
| 84 | repository. Making a local copy of a remote repository is called |
| 85 | "cloning". |
| 86 | |
| 87 | Clone a remote repository as follows: ([/help/clone | more info]) |
| 88 | |
| 89 | <pre><b>fossil clone</b> <i>URL repository-filename</i> |
| 90 | </pre> |
| 91 | |
| 92 | The <i>URL</i> specifies the fossil repository |
| @@ -158,26 +158,23 @@ | |
| 158 | |
| 159 | <h2 id="checkout">Checking Out A Local Tree</h2> |
| 160 | |
| 161 | To work on a project in fossil, you need to check out a local |
| 162 | copy of the source tree. Create the directory you want to be |
| 163 | the root of your tree and cd into that directory. Then |
| 164 | do this: ([/help/open | more info]) |
| 165 | |
| 166 | <pre><b>fossil open</b> <i>repository-filename</i></pre> |
| 167 | |
| 168 | for example: |
| 169 | |
| 170 | <pre><b>fossil open ../myclone.fossil |
| 171 | BUILD.txt |
| 172 | COPYRIGHT-BSD2.txt |
| 173 | README.md |
| 174 | ︙ |
| 175 | </tt></b></pre> |
| 176 | |
| 177 | (or "fossil open ..\myclone.fossil" on Windows). |
| 178 | |
| 179 | This leaves you with the newest version of the tree |
| 180 | checked out. |
| 181 | From anywhere underneath the root of your local tree, you |
| 182 | can type commands like the following to find out the status of |
| 183 | your local tree: |
| @@ -329,37 +326,39 @@ | |
| 329 | |
| 330 | <h2 id="config">Configuring Your Local Repository</h2> |
| 331 | |
| 332 | When you create a new repository, either by cloning an existing |
| 333 | project or create a new project of your own, you usually want to do some |
| 334 | local configuration. This is easily accomplished using the web-server |
| 335 | that is built into fossil. Start the fossil web server like this: |
| 336 | ([/help/ui | more info]) |
| 337 | |
| 338 | <pre> |
| 339 | <b>fossil ui</b> <i>repository-filename</i> |
| 340 | </pre> |
| 341 | |
| 342 | You can omit the <i>repository-filename</i> from the command above |
| 343 | if you are inside a checked-out local tree. |
| 344 | |
| 345 | This starts a web server then automatically launches your |
| 346 | web browser and makes it point to this web server. If your system |
| 347 | has an unusual configuration, fossil might not be able to figure out |
| 348 | how to start your web browser. In that case, first tell fossil |
| 349 | where to find your web browser using a command like this: |
| 350 | |
| 351 | <pre> |
| 352 | <b>fossil setting web-browser</b> <i>path-to-web-browser</i> |
| 353 | </pre> |
| 354 | |
| 355 | By default, fossil does not require a login for HTTP connections |
| 356 | coming in from the IP loopback address 127.0.0.1. You can, and perhaps |
| 357 | should, change this after you create a few users. |
| 358 | |
| 359 | When you are finished configuring, just press Control-C or use |
| 360 | the <b>kill</b> command to shut down the mini-server. |
| 361 | |
| 362 | <h2 id="sharing">Sharing Changes</h2> |
| 363 | |
| 364 | When [./concepts.wiki#workflow|autosync] is turned off, |
| 365 | the changes you [/help/commit | commit] are only |
| 366 |
| --- www/quickstart.wiki | |
| +++ www/quickstart.wiki | |
| @@ -79,14 +79,14 @@ | |
| 79 | <h2 id="clone">Cloning An Existing Repository</h2> |
| 80 | |
| 81 | Most fossil operations interact with a repository that is on the |
| 82 | local disk drive, not on a remote system. Hence, before accessing |
| 83 | a remote repository it is necessary to make a local copy of that |
| 84 | repository, a process called |
| 85 | "[/help/clone | cloning]". |
| 86 | |
| 87 | This is done as follows: |
| 88 | |
| 89 | <pre><b>fossil clone</b> <i>URL repository-filename</i> |
| 90 | </pre> |
| 91 | |
| 92 | The <i>URL</i> specifies the fossil repository |
| @@ -158,26 +158,23 @@ | |
| 158 | |
| 159 | <h2 id="checkout">Checking Out A Local Tree</h2> |
| 160 | |
| 161 | To work on a project in fossil, you need to check out a local |
| 162 | copy of the source tree. Create the directory you want to be |
| 163 | the root of your tree, <tt>cd</tt> into that directory, and then: |
| 164 | |
| 165 | <pre><b>fossil open</b> <i>repository-filename</i></pre> |
| 166 | |
| 167 | For example: |
| 168 | |
| 169 | <pre><b>fossil open ../myclone.fossil |
| 170 | BUILD.txt |
| 171 | COPYRIGHT-BSD2.txt |
| 172 | README.md |
| 173 | ︙ |
| 174 | </tt></b></pre> |
| 175 | |
| 176 | This leaves you with the newest version of the tree |
| 177 | checked out. |
| 178 | From anywhere underneath the root of your local tree, you |
| 179 | can type commands like the following to find out the status of |
| 180 | your local tree: |
| @@ -329,37 +326,39 @@ | |
| 326 | |
| 327 | <h2 id="config">Configuring Your Local Repository</h2> |
| 328 | |
| 329 | When you create a new repository, either by cloning an existing |
| 330 | project or create a new project of your own, you usually want to do some |
| 331 | local configuration. This is most easily accomplished using the web-server |
| 332 | that is built into Fossil, like so: |
| 333 | |
| 334 | <pre> |
| 335 | <b>fossil ui</b> <i>repository-filename</i> |
| 336 | </pre> |
| 337 | |
| 338 | You can shorten that to just [/help/ui | <b>fossil ui</b>] |
| 339 | if you are inside a checked-out local tree. |
| 340 | |
| 341 | After the internal web server starts, Fossil automatically launches your |
| 342 | default web browser, pointed at itself. You may override that default so: |
| 343 | |
| 344 | <pre> |
| 345 | <b>fossil setting web-browser</b> <i>path-to-web-browser</i> |
| 346 | </pre> |
| 347 | |
| 348 | Fossil binds this web server to the IP loopback address (127.0.0.1) |
| 349 | which it treats specially when launched this way, bypassing all user |
| 350 | controls. Why is that a good idea, you ask? Because it is a safe |
| 351 | presumption that only someone with direct file access to the repository |
| 352 | database file could be using the resulting web interface. Anyone who can |
| 353 | modify the repo DB directly could give themselves any and all access |
| 354 | with a SQL query, or even by direct file manipulation; no amount of |
| 355 | access control matters to such a user. |
| 356 | |
| 357 | Once you are finished configuring Fossil, you may safely Control-C out |
| 358 | of the <b>fossil ui</b> command to shut down this privileged |
| 359 | built-in web server. |
| 360 | |
| 361 | <h2 id="sharing">Sharing Changes</h2> |
| 362 | |
| 363 | When [./concepts.wiki#workflow|autosync] is turned off, |
| 364 | the changes you [/help/commit | commit] are only |
| 365 |