alexkarle.com

Source for alexkarle.com
git clone git://git.alexkarle.com/alexkarle.com.git
Log | Files | Refs | README | LICENSE

README.md (1924B) [raw]


      1 alexkarle.com
      2 =============
      3 My small corner of the internet.
      4 
      5 www.
      6 ----
      7 A static site comprised of [mdoc(7)][mdoc] flavored man pages, built to
      8 HTML via [mandoc(1)][mandoc] (managed by [make(1)][make]).
      9 
     10 Currently hosted with OpenBSD's [httpd(8)][httpd], but any web server
     11 should be able to serve it up.
     12 
     13 The Makefile to build the HTML is portable between gmake and BSD make.
     14 On OpenBSD, running `make obj` is recommended before running `make` to
     15 leverage the out-of-tree build extension (see the bit about `.OBJDIR` in
     16 the man page!).
     17 
     18 text.
     19 -----
     20 A pure ascii dump of the [mdoc(7)][mdoc] content of the www site, served
     21 over HTTP, HTTPS, and Gopher (by [httpd(8)][httpd] and
     22 [gophernicus(1)][gophernicus] respectively!
     23 
     24 Builds via [make(1)][make] at the same time as the HTML. See above for
     25 instructions.
     26 
     27 git.
     28 ----
     29 I use a simple setup of git-daemon for anonymous (read-only) downloads,
     30 ssh+git for read+write access (limited to myself) and
     31 [stagit(1)][stagit] to host static views into the diffs and files of
     32 each repo.
     33 
     34 I like the stagit approach in that it is simple, modular, and emphasizes
     35 the use of regular git for larger operations (i.e. diff between refs,
     36 etc).
     37 
     38 I use the default post-receive and create scripts that ship with the
     39 tool (with small modifications for the installation). The logo is in
     40 this repo as logo.png.
     41 
     42 The content, being static, is served up with [httpd(8)][httpd] as well.
     43 
     44 I also discuss the setup in my blog posts [self-hosted(7)][self-hosted]
     45 and [my-old-man(7)][my-old-man].
     46 
     47 [mdoc]: https://man.openbsd.org/mdoc.7
     48 [mandoc]: https://man.openbsd.org/mandoc.1
     49 [make]: https://man.openbsd.org/make.1
     50 [httpd]: https://man.openbsd.org/httpd.8
     51 [stagit]: https://git.codemadness.org/stagit
     52 [git-daemon]: https://git-scm.com/docs/git-daemon
     53 [self-hosted]: https://alexkarle.com/self-hosted.html
     54 [my-old-man]: https://alexkarle.com/my-old-man.html
     55 [gophernicus]: https://www.gophernicus.org/