blob: ec8ee174a283c4aae815b5c99f1a7b8095542f0a (
plain)
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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
|
### Cerrado
Self host single user mail based forge.
You can find a running instance here:
https://beta.gabrielgio.me
### Goals
Keep it simple and lightweight, that includes the application itself,
development process and the deployment.
The application requires no javascript to run, and it is light and fast to
render.
This project is also easy to iterate on. There are only two dev dependencies: go
and sassc so it compiles fast. Codewise it strives for easy to understand.
Easy to read code is better than clever.
The deployment process should be easy to wrap the head around and
straightforward to set up. To achieve that it uses a simple file format[^1] to
configure everything. Also to reduce the moving parts the whole application,
including its statics file, is bundled into a single binary.
To run the project you just need to do a make run.
### Installations
One installation process available is through my apk repository[^2][^3].
You could also run:
```sh
make
make install
```
Or you could also pick another prefix:
```sh
PREFIX=$HOME/.local/ make install
```
You can check openrc files for the details how it is run with a init system,
but in general you'd need the cerrado binary and scfg file, which can easily be
integrated with systemd.
### Contributing
To discuss about the project send me a email or write an issue on codeberg[^4].
To avoid duplicated work or to work something I might not take in, I'd
recommend to reach me before doing something.
To contribute code feel free to create a PR on codeberg or send me an
email-patch[^5].
My email:
mail@gabrielgio.me
### TODO
- Impove diff display
- Add log pagination
### Milestone
- Mail patch / mailing list
- Code snippet support
- Setup manual (man feature perhaps?)
- Add authentication
- Enforce public property
- Add metrics
- Add reference based cache system. Cerrado should be able to cache the whole
page based on its reference hash.
[^1]: https://git.sr.ht/~emersion/scfg
[^2]: https://apkdoc.gabrielgio.me/
[^3]: https://git.gabrielgio.me/apkbuilds/
[^4]: https://codeberg.org/gabrielgio/cerrado/issues
[^5]: https://git-send-email.io/
|
