Back
An extremely simple git issue tracking system. Inspired by tvix's panettone.
Usage
back
is modelled after cgit
, only for git-bug
initialized repositories.
The server is than started at http://127.0.0.1:8000
and provides access to the
issues (bugs) tracked via git-bug
, via multiple routes:
/
The default index is a list of all repositories that have git-bug
data in
them.
<repo_path>/issues/?query=<query>
This path displays all issues that match the query <query>
for the repository
at <repo_path>
.
<repo_path>/issue/<issue_id>
Displays the actual issue with id
<issue_id>
.
<repo_path>/issues/feed
An RSS feed usable to subscribe to. This includes all issues and all comments of issues.
Configuration file
The config file is passed to back
via the first command line argument. It is
written in JSON. An example configuration file is available at
./contrib/config.json
.
Following keys are required:
source_code_repository_url
The URL to the source code of this instance of back
.
root_url
The root URL this instance of back
is hosted at. For example:
https://issues.foss-syndicate.org
. This is required by the RSS feed to
generate links to the various issues/comments.
scan_path
The path under which to search for the repositories as specified by the
projects.list
file. This is semantically the same as cgit
's scan-path
.
project_list
The path to the file specifying the repositories to search. A repository path
per line. This is semantically the same as cgit
's project-list
.
Note
back
needs write access to the repository, because it will generate an entity
lookup cache at .git/git-bug-rs
.
Licensing
This project complies with the REUSE v3.3 specification. This means that every file clearly states its copyright.