Skip to content

Commit 0e34f95

Browse files
committed
update
1 parent 32f1746 commit 0e34f95

1 file changed

Lines changed: 20 additions & 21 deletions

File tree

README.org renamed to README.md

Lines changed: 20 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,56 +1,55 @@
1-
#+options: toc:nil
2-
* Aegis
1+
<center>
2+
<img src="./logo.png" alt="Aegis Logo" />
3+
</center>
34

4-
#+begin_center
5-
[[./logo.png]]
6-
#+end_center
5+
# Aegis
76

87
A web frontend for Git.
98

10-
** Build
9+
## Build
1110

1211
Requires Go v1.24+
1312

14-
#+begin_src
13+
``` sh
1514
make all
16-
#+end_src
15+
```
1716

18-
** Installation
17+
## Installation
1918

20-
(for extra details please visit [[./docs/installation.org]])
19+
(for extra details please visit [](./docs/installation.org))
2120

2221
Run the following command:
2322

24-
#+begin_src sh
25-
./aegis -init
26-
#+end_src
23+
``` sh
24+
./aegis -init
25+
```
2726

2827
And choose to start the web installer. It will guide you through the configuration process.
2928

3029
After the configuration process, run:
3130

32-
#+begin_src sh
33-
./aegis -config {config_file_path}
34-
#+end_src
31+
``` sh
32+
./aegis -config {config_file_path}
33+
```
3534

3635
This would set up everything that's required. After the setup process is completed, run the same command again to start the "main" web server.
3736

3837
This process would show you the password for the admin user, which is randomly generated. You can override this password by running:
3938

40-
#+begin_src sh
41-
./aegis -config {config_file_path} reset-admin
42-
#+end_src
39+
``` sh
40+
./aegis -config {config_file_path} reset-admin
41+
```
4342

4443
Currently Aegis only supports the following systems for its components; support for other systems are planned:
4544

4645
+ Main database:
4746
+ PostgreSQL
4847
+ SQLite3
49-
+ Receipt system (see [[./docs/receipt.org]]):
48+
+ Receipt system (see [](./docs/receipt.org)):
5049
+ PostgreSQL
5150
+ SQLite3
5251
+ Session store:
53-
+ In-memory
52+
+ In-memory
5453
+ SQLite
5554
+ Redis & Redis-like (ValKey, KeyDB)
5655
+ Memcached

0 commit comments

Comments
 (0)