docs: Update README.md
This commit is contained in:
parent
0317ff26d5
commit
1c4ec1e5bd
1 changed files with 16 additions and 6 deletions
22
README.md
22
README.md
|
|
@ -1,6 +1,6 @@
|
||||||
# OmniSearch
|
# OmniSearch
|
||||||
|
|
||||||
A modern lightweight metasearch engine with a clean design written in C. [You can try using it here!](https://search.bwaaa.monster/)
|
A modern lightweight metasearch engine with a clean design written in C.
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
Create a config.ini, there is an example included in the root.
|
Create a config.ini, there is an example included in the root.
|
||||||
|
|
@ -10,12 +10,22 @@ Create a config.ini, there is an example included in the root.
|
||||||
- libcurl (may be replaced in the future with curl-impersonate)
|
- libcurl (may be replaced in the future with curl-impersonate)
|
||||||
- beaker [(source)](https://git.bwaaa.monster/beaker/)
|
- beaker [(source)](https://git.bwaaa.monster/beaker/)
|
||||||
|
|
||||||
## Running
|
# First Setup
|
||||||
```bash
|
Firstly, install libbeaker:
|
||||||
git clone https://git.bwaaa.monster/omnisearch/
|
|
||||||
cd omnisearch
|
|
||||||
make run
|
|
||||||
```
|
```
|
||||||
|
$ git clone https://git.bwaaa.monster/beaker
|
||||||
|
$ cd beaker
|
||||||
|
$ make
|
||||||
|
# make install
|
||||||
|
```
|
||||||
|
And then install omnisearch:
|
||||||
|
```
|
||||||
|
$ git clone https://git.bwaaa.monster/omnisearch
|
||||||
|
$ cd omnisearch
|
||||||
|
$ make
|
||||||
|
# make install-<init>
|
||||||
|
```
|
||||||
|
Replace `<init>` with your init system (openrc,systemd,runit,s6)
|
||||||
|
|
||||||
## Hosting
|
## Hosting
|
||||||
Run it normally behind a reverse proxy (like nginx)
|
Run it normally behind a reverse proxy (like nginx)
|
||||||
|
|
|
||||||
Loading…
Add table
Reference in a new issue