stagit-gopher.md - www.codemadness.org - www.codemadness.org saait content files
  HTML git clone git://git.codemadness.org/www.codemadness.org
   DIR Log
   DIR Files
   DIR Refs
   DIR README
   DIR LICENSE
       ---
       stagit-gopher.md (2850B)
       ---
            1 stagit-gopher is a static page generator for Gopher.  It creates the pages as
            2 static [geomyidae](http://git.r-36.net/geomyidae/) .gph files.  stagit-gopher is a modified version from the
            3 HTML version of stagit.
            4 
            5 [Read the README for more information about it.](/git/stagit-gopher/file/README.html)
            6 
            7 I also run a gopherhole and stagit-gopher, you can see how it looks here:
            8 <gopher://codemadness.org/1/git/>
            9 
           10 [sacc](https://git.fifth.space/sacc/log.html) is a good Gopher client to view it.
           11 
           12 
           13 ## Features
           14 
           15 * Log of all commits from HEAD.
           16 * Log and diffstat per commit.
           17 * Show file tree with line numbers.
           18 * Show references: local branches and tags.
           19 * Detect README and LICENSE file from HEAD and link it as a webpage.
           20 * Detect submodules (.gitmodules file) from HEAD and link it as a webpage.
           21 * Atom feed of the commit log (atom.xml).
           22 * Atom feed of the tags/refs (tags.xml).
           23 * Make index page for multiple repositories with stagit-gopher-index.
           24 * After generating the pages (relatively slow) serving the files is very fast,
           25   simple and requires little resources (because the content is static), a
           26   geomyidae Gopher server is required.
           27 * Security: all pages are static. No CGI or dynamic code is run for the
           28   interface.  Using it with a secure Gopher server such as geomyidae it is
           29   privilege-dropped and chroot(2)'d.
           30 * Simple to setup: the content generation is clearly separated from serving it.
           31   This makes configuration as simple as copying a few directories and scripts.
           32 * Usable with Gopher clients such as lynx and [sacc](https://git.fifth.space/sacc/log.html).
           33 
           34 
           35 ## Cons
           36 
           37 * Not suitable for large repositories (2000+ commits), because diffstats are
           38   an expensive operation, the cache (-c flag) is a workaround for this in
           39   some cases.
           40 * Not suitable for large repositories with many files, because all files are
           41   written for each execution of stagit. This is because stagit shows the lines
           42   of textfiles and there is no "cache" for file metadata (this would add more
           43   complexity to the code).
           44 * Not suitable for repositories with many branches, a quite linear history is
           45   assumed (from HEAD).
           46 * Relatively slow to run the first time (about 3 seconds for sbase,
           47   1500+ commits), incremental updates are faster.
           48 * Does not support some of the dynamic features cgit has (for HTTP), like:
           49   * Snapshot tarballs per commit.
           50   * File tree per commit.
           51   * History log of branches diverged from HEAD.
           52   * Stats (git shortlog -s).
           53 
           54 
           55 This is by design, just use git locally.
           56 
           57 
           58 ## Clone
           59 
           60         git clone git://git.codemadness.org/stagit-gopher
           61 
           62 
           63 ## Browse
           64 
           65 You can browse the source-code at:
           66 
           67 * <https://git.codemadness.org/stagit-gopher/>
           68 * <gopher://codemadness.org/1/git/stagit-gopher>
           69 
           70 
           71 ## Download releases
           72 
           73 Releases are available at:
           74 
           75 * <https://codemadness.org/releases/stagit-gopher/>
           76 * <gopher://codemadness.org/1/releases/stagit-gopher>