stagit-gopher.html - 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.html (5374B)
---
1 <!DOCTYPE html>
2 <html dir="ltr" lang="en">
3 <head>
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
5 <meta http-equiv="Content-Language" content="en" />
6 <meta name="viewport" content="width=device-width" />
7 <meta name="keywords" content="stagit, gopher, stagit-gopher, cgit, geomyidae" />
8 <meta name="description" content="a static git page generator for gopher" />
9 <meta name="author" content="Hiltjo" />
10 <meta name="generator" content="Static content generated using saait: https://codemadness.org/saait.html" />
11 <title>Stagit-gopher: a static git page generator for gopher - Codemadness</title>
12 <link rel="stylesheet" href="style.css" type="text/css" media="screen" />
13 <link rel="stylesheet" href="print.css" type="text/css" media="print" />
14 <link rel="alternate" href="atom.xml" type="application/atom+xml" title="Codemadness Atom Feed" />
15 <link rel="alternate" href="atom_content.xml" type="application/atom+xml" title="Codemadness Atom Feed with content" />
16 <link rel="icon" href="/favicon.png" type="image/png" />
17 </head>
18 <body>
19 <nav id="menuwrap">
20 <table id="menu" width="100%" border="0">
21 <tr>
22 <td id="links" align="left">
23 <a href="index.html">Blog</a> |
24 <a href="/git/" title="Git repository with some of my projects">Git</a> |
25 <a href="/releases/">Releases</a> |
26 <a href="gopher://codemadness.org">Gopherhole</a>
27 </td>
28 <td id="links-contact" align="right">
29 <span class="hidden"> | </span>
30 <a href="feeds.html">Feeds</a> |
31 <a href="pgp.asc">PGP</a> |
32 <a href="mailto:hiltjo@AT@codemadness.DOT.org">Mail</a>
33 </td>
34 </tr>
35 </table>
36 </nav>
37 <hr class="hidden" />
38 <main id="mainwrap">
39 <div id="main">
40 <article>
41 <header>
42 <h1>Stagit-gopher: a static git page generator for gopher</h1>
43 <p>
44 <strong>Last modification on </strong> <time>2021-04-11</time>
45 </p>
46 </header>
47
48 <p>stagit-gopher is a static page generator for Gopher. It creates the pages as
49 static <a href="http://git.r-36.net/geomyidae/">geomyidae</a> .gph files. stagit-gopher is a modified version from the
50 HTML version of stagit.</p>
51 <p><a href="/git/stagit-gopher/file/README.html">Read the README for more information about it.</a></p>
52 <p>I also run a gopherhole and stagit-gopher, you can see how it looks here:
53 <a href="gopher://codemadness.org/1/git/">gopher://codemadness.org/1/git/</a></p>
54 <p><a href="https://git.fifth.space/sacc/log.html">sacc</a> is a good Gopher client to view it.</p>
55 <h2>Features</h2>
56 <ul>
57 <li>Log of all commits from HEAD.</li>
58 <li>Log and diffstat per commit.</li>
59 <li>Show file tree with line numbers.</li>
60 <li>Show references: local branches and tags.</li>
61 <li>Detect README and LICENSE file from HEAD and link it as a webpage.</li>
62 <li>Detect submodules (.gitmodules file) from HEAD and link it as a webpage.</li>
63 <li>Atom feed of the commit log (atom.xml).</li>
64 <li>Atom feed of the tags/refs (tags.xml).</li>
65 <li>Make index page for multiple repositories with stagit-gopher-index.</li>
66 <li>After generating the pages (relatively slow) serving the files is very fast,
67 simple and requires little resources (because the content is static), a
68 geomyidae Gopher server is required.</li>
69 <li>Security: all pages are static. No CGI or dynamic code is run for the
70 interface. Using it with a secure Gopher server such as geomyidae it is
71 privilege-dropped and chroot(2)'d.</li>
72 <li>Simple to setup: the content generation is clearly separated from serving it.
73 This makes configuration as simple as copying a few directories and scripts.</li>
74 <li>Usable with Gopher clients such as lynx and <a href="https://git.fifth.space/sacc/log.html">sacc</a>.</li>
75 </ul>
76 <h2>Cons</h2>
77 <ul>
78 <li>Not suitable for large repositories (2000+ commits), because diffstats are
79 an expensive operation, the cache (-c flag) is a workaround for this in
80 some cases.</li>
81 <li>Not suitable for large repositories with many files, because all files are
82 written for each execution of stagit. This is because stagit shows the lines
83 of textfiles and there is no "cache" for file metadata (this would add more
84 complexity to the code).</li>
85 <li>Not suitable for repositories with many branches, a quite linear history is
86 assumed (from HEAD).</li>
87 <li>Relatively slow to run the first time (about 3 seconds for sbase,
88 1500+ commits), incremental updates are faster.</li>
89 <li>Does not support some of the dynamic features cgit has (for HTTP), like:
90 <ul>
91 <li>Snapshot tarballs per commit.</li>
92 <li>File tree per commit.</li>
93 <li>History log of branches diverged from HEAD.</li>
94 <li>Stats (git shortlog -s).</li>
95 </ul>
96 </li>
97 </ul>
98 <p>This is by design, just use git locally.</p>
99 <h2>Clone</h2>
100 <pre><code>git clone git://git.codemadness.org/stagit-gopher
101 </code></pre>
102 <h2>Browse</h2>
103 <p>You can browse the source-code at:</p>
104 <ul>
105 <li><a href="https://git.codemadness.org/stagit-gopher/">https://git.codemadness.org/stagit-gopher/</a></li>
106 <li><a href="gopher://codemadness.org/1/git/stagit-gopher">gopher://codemadness.org/1/git/stagit-gopher</a></li>
107 </ul>
108 <h2>Download releases</h2>
109 <p>Releases are available at:</p>
110 <ul>
111 <li><a href="https://codemadness.org/releases/stagit-gopher/">https://codemadness.org/releases/stagit-gopher/</a></li>
112 <li><a href="gopher://codemadness.org/1/releases/stagit-gopher">gopher://codemadness.org/1/releases/stagit-gopher</a></li>
113 </ul>
114
115 </article>
116 </div>
117 </main>
118 </body>
119 </html>