aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 571b6652d814afef5101bf7f0be4d6b8760661ee (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
46
47
# 👧️ Gigi

> A Finger protocol server for risk takers

Gigi is a Finger protocol server with few features.

- Gigi can respond to Finger requests statically
- Gigi can respond to Finger requests dynamically

<p align="center">
  <br>
  <img src="https://i.imgur.com/RddckKP.png" width="75%">
</p>

## Usage

### Local

```bash
$ git clone [email protected]:Fuwn/gigi.git
$ cd gigi
$ tup
```

### Configuration

Gigi is configured through the `./gigi` directory.

Dynamic response mode is disabled by default in [`gigi.c`](./gigi.c)
because it is very unsafe. If you wish to live on the edge, uncomment the
`GIGI_DYNAMIC` macro.

Dynamic mode runs any and all executables located at the path `./gigi/do`, and
passes any arguments from the Finger request to the executable.

Static mode is enabled by default. A Finger request for `test` will return the
contents of `./gigi/test`. A Finger request of nothing will return the contents
of `./gigi/default`.

## Licence

Licensed under either of [Apache License, Version 2.0](LICENSE-APACHE) or
[MIT license](LICENSE-MIT) at your option.

Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in this crate by you, as defined in the Apache-2.0 license, shall
be dual licensed as above, without any additional terms or conditions.