Fossil SCM
Outline how to configure a repository before and after server activation.
Commit
154ea087af6d39dbcb45799f9af88d8ad2f2a759b1e0faaf1d1224182c235a88
Parent
44f1df9fefdb4e9…
1 file changed
+71
-3
+71
-3
| --- www/server/index.html | ||
| +++ www/server/index.html | ||
| @@ -63,13 +63,45 @@ | ||
| 63 | 63 | |
| 64 | 64 | <p>This article is a quick-reference guide for setting up your own |
| 65 | 65 | Fossil server, with links to more detailed instructions specific to |
| 66 | 66 | particular systems, should you want extra help.</p> |
| 67 | 67 | |
| 68 | -<h2 id="methods">Methods</h2> | |
| 68 | +<h2 id="prep">Repository Prep</h2> | |
| 69 | + | |
| 70 | +<p> | |
| 71 | +Prior to launching a server on a Fossil repository, it is best to | |
| 72 | +prepare the repository to be served. The easiest way to do this | |
| 73 | +is to run the <a href="/help?cmd=ui"><tt>fossil ui</tt></a> command | |
| 74 | +on a workstation and then visit the "Setup" menu. | |
| 75 | +Minimum preparation actions include:</p> | |
| 76 | + | |
| 77 | +<ol> | |
| 78 | +<li> | |
| 79 | +Ensure that you have an administrator user account and password | |
| 80 | +configured. Visit the Setup/Users page to accomplish this.</p></li> | |
| 81 | +<li> | |
| 82 | +Visit the Setup/Security-Audit page to verify that other | |
| 83 | +security-related permissions and settings are as you want them. | |
| 84 | +You might want to configure the repository to be completely private | |
| 85 | +for the initial upload and server activatation, then open access up to | |
| 86 | +the public as part of the | |
| 87 | +<a href="#postsetup">post-activation configuration refinement</a> | |
| 88 | +stage. | |
| 89 | +</p></li> | |
| 90 | +</ol> | |
| 91 | + | |
| 92 | +<p> | |
| 93 | +Additional configuration can be accomplished after the server is up | |
| 94 | +and running. Once the preliminary configuration is completed | |
| 95 | +upload the repository database file to the server and proceed to | |
| 96 | +activate the server using one or more of the techniques described | |
| 97 | +in the next two sections. | |
| 98 | +</p> | |
| 99 | + | |
| 100 | +<h2 id="methods">Activation Methods</h2> | |
| 69 | 101 | |
| 70 | -<p>There are basically four ways to set up a Fossil server:</p> | |
| 102 | +<p>There are basically four ways to run a Fossil server:</p> | |
| 71 | 103 | |
| 72 | 104 | <ol> |
| 73 | 105 | <li><a id="cgi" href="any/cgi.md">CGI</a> |
| 74 | 106 | <li>Socket listener |
| 75 | 107 | <li><a id="standalone" href="any/none.md">Stand-alone HTTP server</a> |
| @@ -144,11 +176,11 @@ | ||
| 144 | 176 | up because you also have to set up an SCGI-to-HTTP proxy for it. It is |
| 145 | 177 | worth taking on this difficulty only when you need to integrate Fossil |
| 146 | 178 | into an existing web site already being served by an SCGI-capable web |
| 147 | 179 | server.</p> |
| 148 | 180 | |
| 149 | -<h2 id="matrix">Setup Tutorials</h2> | |
| 181 | +<h2 id="matrix">Activation Tutorials</h2> | |
| 150 | 182 | |
| 151 | 183 | <p>We've broken the configuration for each method out into a series of |
| 152 | 184 | sub-articles. Some of these are generic, while others depend on |
| 153 | 185 | particular operating systems or front-end software:</p> |
| 154 | 186 | |
| @@ -229,10 +261,46 @@ | ||
| 229 | 261 | |
| 230 | 262 | <p>We welcome <a href="../contribute.wiki">contributions</a> to fill gaps |
| 231 | 263 | (<font size="-2">❌</font>) in the table above.</p> |
| 232 | 264 | </noscript> |
| 233 | 265 | |
| 266 | +<h2 id="postsetup">Post-Activation Configuration</h2> | |
| 267 | + | |
| 268 | +<p>After the server is up and running, additional configuration | |
| 269 | +fine-tuning can be accomplished by logging in as an administrator | |
| 270 | +and visiting the Setup menu. Pay particular attention to the | |
| 271 | +"Setup/Security-Audit" page to ensure that you have not mistakenly | |
| 272 | +configured the server in a way that might expose information that you | |
| 273 | +want to keep private. Other post-activation steps include the following:</p> | |
| 274 | + | |
| 275 | +<ol> | |
| 276 | +<li> | |
| 277 | +Add additional users accounts so that all team members have appropriate | |
| 278 | +check-in and check-out access to the repository.</li> | |
| 279 | +<li> | |
| 280 | +Modify the look-and-feel of site by customizing the skin. | |
| 281 | +<li> | |
| 282 | +If the repository includes <a href="../embeddeddoc.wiki">embedded | |
| 283 | +documentation</a> then perhaps activate the search feature so that | |
| 284 | +visitors can do full-text search on your documentation. | |
| 285 | +<li> | |
| 286 | +Connect the repository to an email server so that it can send email | |
| 287 | +notifications of new check-ins or other repository activate. | |
| 288 | +<li> | |
| 289 | +Turn on the various logging features. | |
| 290 | +<li> | |
| 291 | +If you locked down the repository as completely private prior to | |
| 292 | +upload, you might want to open up access to the public once you get | |
| 293 | +everything working. Or, keep the repository private, according to | |
| 294 | +your needs. | |
| 295 | +</ol> | |
| 296 | + | |
| 297 | +<p> | |
| 298 | +After any signification configuration change, it is a good idea to | |
| 299 | +revisit the Setup/Security-Audit page just to double-check that you | |
| 300 | +have not created any security problems in your installation. | |
| 301 | +</p> | |
| 234 | 302 | |
| 235 | 303 | <h2 id="more">Further Details</h2> |
| 236 | 304 | |
| 237 | 305 | <ul> |
| 238 | 306 | <li><a id="chroot" href="../chroot.md" >The Server Chroot Jail</a> |
| 239 | 307 |
| --- www/server/index.html | |
| +++ www/server/index.html | |
| @@ -63,13 +63,45 @@ | |
| 63 | |
| 64 | <p>This article is a quick-reference guide for setting up your own |
| 65 | Fossil server, with links to more detailed instructions specific to |
| 66 | particular systems, should you want extra help.</p> |
| 67 | |
| 68 | <h2 id="methods">Methods</h2> |
| 69 | |
| 70 | <p>There are basically four ways to set up a Fossil server:</p> |
| 71 | |
| 72 | <ol> |
| 73 | <li><a id="cgi" href="any/cgi.md">CGI</a> |
| 74 | <li>Socket listener |
| 75 | <li><a id="standalone" href="any/none.md">Stand-alone HTTP server</a> |
| @@ -144,11 +176,11 @@ | |
| 144 | up because you also have to set up an SCGI-to-HTTP proxy for it. It is |
| 145 | worth taking on this difficulty only when you need to integrate Fossil |
| 146 | into an existing web site already being served by an SCGI-capable web |
| 147 | server.</p> |
| 148 | |
| 149 | <h2 id="matrix">Setup Tutorials</h2> |
| 150 | |
| 151 | <p>We've broken the configuration for each method out into a series of |
| 152 | sub-articles. Some of these are generic, while others depend on |
| 153 | particular operating systems or front-end software:</p> |
| 154 | |
| @@ -229,10 +261,46 @@ | |
| 229 | |
| 230 | <p>We welcome <a href="../contribute.wiki">contributions</a> to fill gaps |
| 231 | (<font size="-2">❌</font>) in the table above.</p> |
| 232 | </noscript> |
| 233 | |
| 234 | |
| 235 | <h2 id="more">Further Details</h2> |
| 236 | |
| 237 | <ul> |
| 238 | <li><a id="chroot" href="../chroot.md" >The Server Chroot Jail</a> |
| 239 |
| --- www/server/index.html | |
| +++ www/server/index.html | |
| @@ -63,13 +63,45 @@ | |
| 63 | |
| 64 | <p>This article is a quick-reference guide for setting up your own |
| 65 | Fossil server, with links to more detailed instructions specific to |
| 66 | particular systems, should you want extra help.</p> |
| 67 | |
| 68 | <h2 id="prep">Repository Prep</h2> |
| 69 | |
| 70 | <p> |
| 71 | Prior to launching a server on a Fossil repository, it is best to |
| 72 | prepare the repository to be served. The easiest way to do this |
| 73 | is to run the <a href="/help?cmd=ui"><tt>fossil ui</tt></a> command |
| 74 | on a workstation and then visit the "Setup" menu. |
| 75 | Minimum preparation actions include:</p> |
| 76 | |
| 77 | <ol> |
| 78 | <li> |
| 79 | Ensure that you have an administrator user account and password |
| 80 | configured. Visit the Setup/Users page to accomplish this.</p></li> |
| 81 | <li> |
| 82 | Visit the Setup/Security-Audit page to verify that other |
| 83 | security-related permissions and settings are as you want them. |
| 84 | You might want to configure the repository to be completely private |
| 85 | for the initial upload and server activatation, then open access up to |
| 86 | the public as part of the |
| 87 | <a href="#postsetup">post-activation configuration refinement</a> |
| 88 | stage. |
| 89 | </p></li> |
| 90 | </ol> |
| 91 | |
| 92 | <p> |
| 93 | Additional configuration can be accomplished after the server is up |
| 94 | and running. Once the preliminary configuration is completed |
| 95 | upload the repository database file to the server and proceed to |
| 96 | activate the server using one or more of the techniques described |
| 97 | in the next two sections. |
| 98 | </p> |
| 99 | |
| 100 | <h2 id="methods">Activation Methods</h2> |
| 101 | |
| 102 | <p>There are basically four ways to run a Fossil server:</p> |
| 103 | |
| 104 | <ol> |
| 105 | <li><a id="cgi" href="any/cgi.md">CGI</a> |
| 106 | <li>Socket listener |
| 107 | <li><a id="standalone" href="any/none.md">Stand-alone HTTP server</a> |
| @@ -144,11 +176,11 @@ | |
| 176 | up because you also have to set up an SCGI-to-HTTP proxy for it. It is |
| 177 | worth taking on this difficulty only when you need to integrate Fossil |
| 178 | into an existing web site already being served by an SCGI-capable web |
| 179 | server.</p> |
| 180 | |
| 181 | <h2 id="matrix">Activation Tutorials</h2> |
| 182 | |
| 183 | <p>We've broken the configuration for each method out into a series of |
| 184 | sub-articles. Some of these are generic, while others depend on |
| 185 | particular operating systems or front-end software:</p> |
| 186 | |
| @@ -229,10 +261,46 @@ | |
| 261 | |
| 262 | <p>We welcome <a href="../contribute.wiki">contributions</a> to fill gaps |
| 263 | (<font size="-2">❌</font>) in the table above.</p> |
| 264 | </noscript> |
| 265 | |
| 266 | <h2 id="postsetup">Post-Activation Configuration</h2> |
| 267 | |
| 268 | <p>After the server is up and running, additional configuration |
| 269 | fine-tuning can be accomplished by logging in as an administrator |
| 270 | and visiting the Setup menu. Pay particular attention to the |
| 271 | "Setup/Security-Audit" page to ensure that you have not mistakenly |
| 272 | configured the server in a way that might expose information that you |
| 273 | want to keep private. Other post-activation steps include the following:</p> |
| 274 | |
| 275 | <ol> |
| 276 | <li> |
| 277 | Add additional users accounts so that all team members have appropriate |
| 278 | check-in and check-out access to the repository.</li> |
| 279 | <li> |
| 280 | Modify the look-and-feel of site by customizing the skin. |
| 281 | <li> |
| 282 | If the repository includes <a href="../embeddeddoc.wiki">embedded |
| 283 | documentation</a> then perhaps activate the search feature so that |
| 284 | visitors can do full-text search on your documentation. |
| 285 | <li> |
| 286 | Connect the repository to an email server so that it can send email |
| 287 | notifications of new check-ins or other repository activate. |
| 288 | <li> |
| 289 | Turn on the various logging features. |
| 290 | <li> |
| 291 | If you locked down the repository as completely private prior to |
| 292 | upload, you might want to open up access to the public once you get |
| 293 | everything working. Or, keep the repository private, according to |
| 294 | your needs. |
| 295 | </ol> |
| 296 | |
| 297 | <p> |
| 298 | After any signification configuration change, it is a good idea to |
| 299 | revisit the Setup/Security-Audit page just to double-check that you |
| 300 | have not created any security problems in your installation. |
| 301 | </p> |
| 302 | |
| 303 | <h2 id="more">Further Details</h2> |
| 304 | |
| 305 | <ul> |
| 306 | <li><a id="chroot" href="../chroot.md" >The Server Chroot Jail</a> |
| 307 |