summary refs log tree commit diff stats
path: root/pkgs/by-name/ba/back/README.md
blob: 4bbd9c0392b589f75f9ab062a492b25d71b47d3b (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
<!--
Back - An extremely simple git issue tracking system. Inspired by tvix's
panettone

Copyright (C) 2024 Benedikt Peetz <benedikt.peetz@b-peetz.de>
SPDX-License-Identifier: AGPL-3.0-or-later

This file is part of Back.

You should have received a copy of the License along with this program.
If not, see <https://www.gnu.org/licenses/agpl.txt>.
-->

# Back

> An extremely simple git issue tracking system. Inspired by tvix's panettone.

## Usage

Currently, `back` only visualizes a `git-bug` repository. As such it takes exactly one
argument, being the repository to visualize.
The server is than started at `http://127.0.0.1:8000` and provides access to the issues
(bugs) tracked via `git-bug`.

### Note

`back` needs write access to the repository, because of internal `gix` and `git` object
reasons.

## Relevant Environment Variables

### `ROCKET_PORT`

> Default: 8000

This is the port the server binds to.

### `SOURCE_CODE_REPOSITORY_URL`

The URL to the back's source.

## Licensing

This project complies with the REUSE v3.3 specification. This means that every file
clearly states its copyright.