Fork of stagit-gopher that ports the output to gemini
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
sloum 2710449792 Removes an unneeded char 2 years ago
LICENSE Forks stagit-gopher to output gemini files 2 years ago
Makefile Forks stagit-gopher to output gemini files 2 years ago
README Forks stagit-gopher to output gemini files 2 years ago
compat.h remove strlcat, it is unused now 4 years ago
example_create.sh Forks stagit-gopher to output gemini files 2 years ago
example_post-receive.sh Forks stagit-gopher to output gemini files 2 years ago
reallocarray.c Bring in reallocarray() from OpenBSD 6 years ago
stagit-gemini-index.1 Forks stagit-gopher to output gemini files 2 years ago
stagit-gemini-index.c Forks stagit-gopher to output gemini files 2 years ago
stagit-gemini.1 Forks stagit-gopher to output gemini files 2 years ago
stagit-gemini.c Removes an unneeded char 2 years ago
strlcpy.c Bring in reallocarray() from OpenBSD 6 years ago

README

stagit-gemini
-------------

static git page generator for gemini.

This generates pages in the .gmi file format read by gemini
servers and delivered as `text/gemini`


Usage
-----

Make files per repository:

$ mkdir -p gphdir && cd gphdir
$ stagit-gemini path-to-repo

Make index file for repositories:

$ stagit-gemini-index repodir1 repodir2 repodir3 > index.gmi


Build and install
-----------------

$ make
# make install


Dependencies
------------

- C compiler (C99).
- libc (tested with OpenBSD, FreeBSD, NetBSD, Linux: glibc and musl).
- libgit2 (v0.22+).
- a gemini server that serves .gmi files.
- POSIX make (optional).


Documentation
-------------

See man pages: stagit-gemini(1) and stagit-gemini-index(1).


Building a static binary
------------------------

It may be useful to build static binaries, for example to run in a chroot.

It can be done like this at the time of writing (v0.24):

cd libgit2-src

# change the options in the CMake file: CMakeLists.txt
BUILD_SHARED_LIBS to OFF (static)
CURL to OFF (not needed)
USE_SSH OFF (not needed)
THREADSAFE OFF (not needed)
USE_OPENSSL OFF (not needed, use builtin)

mkdir -p build && cd build
cmake ../
make
make install


Set clone url for a directory of repos
--------------------------------------
#!/bin/sh
cd "$dir"
for i in *; do
test -d "$i" && echo "git://git.codemadness.org/$i" > "$i/url"
done


Update files on git push
------------------------

Using a post-receive hook the static files can be automatically updated.
Keep in mind git push -f can change the history and the commits may need
to be recreated. This is because stagit checks if a commit file already
exists. It also has a cache (-c) option which can conflict with the new
history. See stagit(1).

git post-receive hook (repo/.git/hooks/post-receive):

#!/bin/sh
# detect git push -f
force=0
while read -r old new ref; do
hasrevs=$(git rev-list "$old" "^$new" | sed 1q)
if test -n "$hasrevs"; then
force=1
break
fi
done

# remove commits and .cache on git push -f
#if test "$force" = "1"; then
# ...
#fi

# see example_create.sh for normal creation of the files.


Create .tar.gz archives by tag
------------------------------
#!/bin/sh
name="stagit-gemini"
mkdir -p archives
git tag -l | while read -r t; do
f="archives/${name}-$(echo "${t}" | tr '/' '_').tar.gz"
test -f "${f}" && continue
git archive \
--format tar.gz \
--prefix "${t}/" \
-o "${f}" \
-- \
"${t}"
done


Features
--------

- Log of all commits from HEAD.
- Log and diffstat per commit.
- Show file tree with line numbers.
- Show references: local branches and tags.
- Detect README and LICENSE file from HEAD and link it as a page.
- Detect submodules (.gitmodules file) from HEAD and link it as a page.
- Atom feed log (atom.xml).
- Make index page for multiple repositories with stagit-gemini-index.
- After generating the pages (relatively slow) serving the files is very fast,
simple and requires little resources (because the content is static), only
a Gemini server with mime associations to .gmi is required.


Cons
----

- Not suitable for large repositories (2000+ commits), because diffstats are
an expensive operation, the cache (-c flag) is a workaround for this in
some cases.
- Not suitable for large repositories with many files, because all files are
written for each execution of stagit. This is because stagit shows the lines
of textfiles and there is no "cache" for file metadata (this would add more
complexity to the code).
- Not suitable for repositories with many branches, a quite linear history is
assumed (from HEAD).
- Relatively slow to run the first time (about 3 seconds for sbase,
1500+ commits), incremental updates are faster.
- Does not support some dynamic features like:
- Snapshot tarballs per commit.
- File tree per commit.
- History log of branches diverged from HEAD.
- Stats (git shortlog -s).

This is by design, just use git locally.