Fossil SCM
Fix typo in OpenBSD documentation httpd link, remove block quote formatting, and make section titles consistent with existing server docs.
Commit
a9cc104eb33ed52a9e2327d79f0fbb31fe8ef88d93474e9b5b569f8faa7dd884
Parent
311f16953c0d9e0…
1 file changed
+11
-11
+11
-11
| --- www/server/openbsd/httpd.md | ||
| +++ www/server/openbsd/httpd.md | ||
| @@ -10,13 +10,13 @@ | ||
| 10 | 10 | a single directory within a chroot, and allow ``ssh`` access to create |
| 11 | 11 | new repositories remotely. |
| 12 | 12 | |
| 13 | 13 | **NOTE:** The following instructions assume an OpenBSD 6.7 installation. |
| 14 | 14 | |
| 15 | -[httpd]: https://www.openbsd.org/papers/httpd-asiabsdcon2015.pdfBPSystemStartup/ | |
| 15 | +[httpd]: https://www.openbsd.org/papers/httpd-asiabsdcon2015.pdf | |
| 16 | 16 | |
| 17 | -## [Install Fossil](#fslinstall) | |
| 17 | +## <a name="fslinstall"></a>Install Fossil | |
| 18 | 18 | |
| 19 | 19 | Use the OpenBSD package manager ``pkg_add`` to install Fossil, making |
| 20 | 20 | sure to select the statically linked binary. |
| 21 | 21 | |
| 22 | 22 | ```console |
| @@ -59,11 +59,11 @@ | ||
| 59 | 59 | $ doas mkdir /var/www/htdocs/fsl.domain.tld |
| 60 | 60 | $ doas touch /var/www/logs/fossil.log |
| 61 | 61 | $ doas chmod 755 /var/www/cgi-bin/scm |
| 62 | 62 | ``` |
| 63 | 63 | |
| 64 | -## [Setup chroot](#chroot) | |
| 64 | +## <a name="chroot"></a>Setup chroot | |
| 65 | 65 | |
| 66 | 66 | Fossil needs both ``/dev/random`` and ``/dev/null``, which aren't |
| 67 | 67 | accessible from within the chroot, so need to be constructed; ``/var``, |
| 68 | 68 | however, is mounted with the ``nodev`` option. Rather than removing |
| 69 | 69 | this default setting, create a small memory filesystem with |
| @@ -100,11 +100,11 @@ | ||
| 100 | 100 | |
| 101 | 101 | ```console |
| 102 | 102 | $ doas chown -R user:www /var/www/htdocs/fsl.domain.tld |
| 103 | 103 | ``` |
| 104 | 104 | |
| 105 | -## [Configure httpd](#httpdconfig) | |
| 105 | +## <a name="httpdconfig"></a>Configure httpd | |
| 106 | 106 | |
| 107 | 107 | On OpenBSD, [httpd.conf(5)][httpd] is the configuration file for |
| 108 | 108 | ``httpd``. To setup the server to serve all Fossil repositores within |
| 109 | 109 | the directory specified in the CGI script, and automatically redirect |
| 110 | 110 | standard HTTP requests to HTTPS—apart from [Let's Encrypt][LE] |
| @@ -154,16 +154,16 @@ | ||
| 154 | 154 | request strip 2 |
| 155 | 155 | } |
| 156 | 156 | } |
| 157 | 157 | ``` |
| 158 | 158 | |
| 159 | -> If not already in possession of a HTTPS certificate, comment out the | |
| 160 | -> ``https`` server block and proceed to securing a free | |
| 161 | -> [Let's Encrypt Certificate](#letsencrypt); otherwise skip to | |
| 162 | -> [Start httpd](#starthttpd). | |
| 159 | +**NOTE:** If not already in possession of a HTTPS certificate, comment | |
| 160 | +out the ``https`` server block and proceed to securing a free | |
| 161 | +[Let's Encrypt Certificate](#letsencrypt); otherwise skip to | |
| 162 | +[Start httpd](#starthttpd). | |
| 163 | 163 | |
| 164 | -## [Let's Encrypt Certificate](#letsencrypt) | |
| 164 | +## <a name="letsencrypt"></a>Let's Encrypt Certificate | |
| 165 | 165 | |
| 166 | 166 | In order for ``httpd`` to serve HTTPS, secure a free certificate from |
| 167 | 167 | Let's Encrypt using ``acme-client``. Before issuing the |
| 168 | 168 | request, however, ensure you have a zone record for the subdomain with |
| 169 | 169 | your registrar or nameserver. Then open ``/etc/acme-client.conf`` as a |
| @@ -218,11 +218,11 @@ | ||
| 218 | 218 | ``` |
| 219 | 219 | |
| 220 | 220 | Make sure to reopen ``/etc/httpd.conf`` to uncomment the second server |
| 221 | 221 | block responsible for serving HTTPS requests before proceeding. |
| 222 | 222 | |
| 223 | -## [Start httpd](#starthttpd) | |
| 223 | +## <a name="starthttpd"></a>Start httpd | |
| 224 | 224 | |
| 225 | 225 | With ``httpd`` configured to serve Fossil repositories out of |
| 226 | 226 | ``/var/www/htdocs/fsl.domain.tld``, and the certificates and key in |
| 227 | 227 | place, enable and start ``slowcgi``—OpenBSD's FastCGI wrapper server |
| 228 | 228 | that will execute the above Fossil CGI script—before checking the syntax |
| @@ -237,11 +237,11 @@ | ||
| 237 | 237 | configuration OK |
| 238 | 238 | $ doas rcctl start httpd |
| 239 | 239 | httpd(ok) |
| 240 | 240 | ``` |
| 241 | 241 | |
| 242 | -## [Configure Client](#clientconfig) | |
| 242 | +## <a name="clientconfig"></a>Configure Client | |
| 243 | 243 | |
| 244 | 244 | To facilitate creating new repositories and pushing them to the server, |
| 245 | 245 | add the following function to your ``~/.cshrc`` or ``~/.zprofile`` or |
| 246 | 246 | the config file for whichever shell you are using on your development |
| 247 | 247 | box. |
| 248 | 248 |
| --- www/server/openbsd/httpd.md | |
| +++ www/server/openbsd/httpd.md | |
| @@ -10,13 +10,13 @@ | |
| 10 | a single directory within a chroot, and allow ``ssh`` access to create |
| 11 | new repositories remotely. |
| 12 | |
| 13 | **NOTE:** The following instructions assume an OpenBSD 6.7 installation. |
| 14 | |
| 15 | [httpd]: https://www.openbsd.org/papers/httpd-asiabsdcon2015.pdfBPSystemStartup/ |
| 16 | |
| 17 | ## [Install Fossil](#fslinstall) |
| 18 | |
| 19 | Use the OpenBSD package manager ``pkg_add`` to install Fossil, making |
| 20 | sure to select the statically linked binary. |
| 21 | |
| 22 | ```console |
| @@ -59,11 +59,11 @@ | |
| 59 | $ doas mkdir /var/www/htdocs/fsl.domain.tld |
| 60 | $ doas touch /var/www/logs/fossil.log |
| 61 | $ doas chmod 755 /var/www/cgi-bin/scm |
| 62 | ``` |
| 63 | |
| 64 | ## [Setup chroot](#chroot) |
| 65 | |
| 66 | Fossil needs both ``/dev/random`` and ``/dev/null``, which aren't |
| 67 | accessible from within the chroot, so need to be constructed; ``/var``, |
| 68 | however, is mounted with the ``nodev`` option. Rather than removing |
| 69 | this default setting, create a small memory filesystem with |
| @@ -100,11 +100,11 @@ | |
| 100 | |
| 101 | ```console |
| 102 | $ doas chown -R user:www /var/www/htdocs/fsl.domain.tld |
| 103 | ``` |
| 104 | |
| 105 | ## [Configure httpd](#httpdconfig) |
| 106 | |
| 107 | On OpenBSD, [httpd.conf(5)][httpd] is the configuration file for |
| 108 | ``httpd``. To setup the server to serve all Fossil repositores within |
| 109 | the directory specified in the CGI script, and automatically redirect |
| 110 | standard HTTP requests to HTTPS—apart from [Let's Encrypt][LE] |
| @@ -154,16 +154,16 @@ | |
| 154 | request strip 2 |
| 155 | } |
| 156 | } |
| 157 | ``` |
| 158 | |
| 159 | > If not already in possession of a HTTPS certificate, comment out the |
| 160 | > ``https`` server block and proceed to securing a free |
| 161 | > [Let's Encrypt Certificate](#letsencrypt); otherwise skip to |
| 162 | > [Start httpd](#starthttpd). |
| 163 | |
| 164 | ## [Let's Encrypt Certificate](#letsencrypt) |
| 165 | |
| 166 | In order for ``httpd`` to serve HTTPS, secure a free certificate from |
| 167 | Let's Encrypt using ``acme-client``. Before issuing the |
| 168 | request, however, ensure you have a zone record for the subdomain with |
| 169 | your registrar or nameserver. Then open ``/etc/acme-client.conf`` as a |
| @@ -218,11 +218,11 @@ | |
| 218 | ``` |
| 219 | |
| 220 | Make sure to reopen ``/etc/httpd.conf`` to uncomment the second server |
| 221 | block responsible for serving HTTPS requests before proceeding. |
| 222 | |
| 223 | ## [Start httpd](#starthttpd) |
| 224 | |
| 225 | With ``httpd`` configured to serve Fossil repositories out of |
| 226 | ``/var/www/htdocs/fsl.domain.tld``, and the certificates and key in |
| 227 | place, enable and start ``slowcgi``—OpenBSD's FastCGI wrapper server |
| 228 | that will execute the above Fossil CGI script—before checking the syntax |
| @@ -237,11 +237,11 @@ | |
| 237 | configuration OK |
| 238 | $ doas rcctl start httpd |
| 239 | httpd(ok) |
| 240 | ``` |
| 241 | |
| 242 | ## [Configure Client](#clientconfig) |
| 243 | |
| 244 | To facilitate creating new repositories and pushing them to the server, |
| 245 | add the following function to your ``~/.cshrc`` or ``~/.zprofile`` or |
| 246 | the config file for whichever shell you are using on your development |
| 247 | box. |
| 248 |
| --- www/server/openbsd/httpd.md | |
| +++ www/server/openbsd/httpd.md | |
| @@ -10,13 +10,13 @@ | |
| 10 | a single directory within a chroot, and allow ``ssh`` access to create |
| 11 | new repositories remotely. |
| 12 | |
| 13 | **NOTE:** The following instructions assume an OpenBSD 6.7 installation. |
| 14 | |
| 15 | [httpd]: https://www.openbsd.org/papers/httpd-asiabsdcon2015.pdf |
| 16 | |
| 17 | ## <a name="fslinstall"></a>Install Fossil |
| 18 | |
| 19 | Use the OpenBSD package manager ``pkg_add`` to install Fossil, making |
| 20 | sure to select the statically linked binary. |
| 21 | |
| 22 | ```console |
| @@ -59,11 +59,11 @@ | |
| 59 | $ doas mkdir /var/www/htdocs/fsl.domain.tld |
| 60 | $ doas touch /var/www/logs/fossil.log |
| 61 | $ doas chmod 755 /var/www/cgi-bin/scm |
| 62 | ``` |
| 63 | |
| 64 | ## <a name="chroot"></a>Setup chroot |
| 65 | |
| 66 | Fossil needs both ``/dev/random`` and ``/dev/null``, which aren't |
| 67 | accessible from within the chroot, so need to be constructed; ``/var``, |
| 68 | however, is mounted with the ``nodev`` option. Rather than removing |
| 69 | this default setting, create a small memory filesystem with |
| @@ -100,11 +100,11 @@ | |
| 100 | |
| 101 | ```console |
| 102 | $ doas chown -R user:www /var/www/htdocs/fsl.domain.tld |
| 103 | ``` |
| 104 | |
| 105 | ## <a name="httpdconfig"></a>Configure httpd |
| 106 | |
| 107 | On OpenBSD, [httpd.conf(5)][httpd] is the configuration file for |
| 108 | ``httpd``. To setup the server to serve all Fossil repositores within |
| 109 | the directory specified in the CGI script, and automatically redirect |
| 110 | standard HTTP requests to HTTPS—apart from [Let's Encrypt][LE] |
| @@ -154,16 +154,16 @@ | |
| 154 | request strip 2 |
| 155 | } |
| 156 | } |
| 157 | ``` |
| 158 | |
| 159 | **NOTE:** If not already in possession of a HTTPS certificate, comment |
| 160 | out the ``https`` server block and proceed to securing a free |
| 161 | [Let's Encrypt Certificate](#letsencrypt); otherwise skip to |
| 162 | [Start httpd](#starthttpd). |
| 163 | |
| 164 | ## <a name="letsencrypt"></a>Let's Encrypt Certificate |
| 165 | |
| 166 | In order for ``httpd`` to serve HTTPS, secure a free certificate from |
| 167 | Let's Encrypt using ``acme-client``. Before issuing the |
| 168 | request, however, ensure you have a zone record for the subdomain with |
| 169 | your registrar or nameserver. Then open ``/etc/acme-client.conf`` as a |
| @@ -218,11 +218,11 @@ | |
| 218 | ``` |
| 219 | |
| 220 | Make sure to reopen ``/etc/httpd.conf`` to uncomment the second server |
| 221 | block responsible for serving HTTPS requests before proceeding. |
| 222 | |
| 223 | ## <a name="starthttpd"></a>Start httpd |
| 224 | |
| 225 | With ``httpd`` configured to serve Fossil repositories out of |
| 226 | ``/var/www/htdocs/fsl.domain.tld``, and the certificates and key in |
| 227 | place, enable and start ``slowcgi``—OpenBSD's FastCGI wrapper server |
| 228 | that will execute the above Fossil CGI script—before checking the syntax |
| @@ -237,11 +237,11 @@ | |
| 237 | configuration OK |
| 238 | $ doas rcctl start httpd |
| 239 | httpd(ok) |
| 240 | ``` |
| 241 | |
| 242 | ## <a name="clientconfig"></a>Configure Client |
| 243 | |
| 244 | To facilitate creating new repositories and pushing them to the server, |
| 245 | add the following function to your ``~/.cshrc`` or ``~/.zprofile`` or |
| 246 | the config file for whichever shell you are using on your development |
| 247 | box. |
| 248 |