farhan/fedilogue
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updating README.md

Browse Source
This commit is contained in:
Farhan Khan 2021-10-01 05:08:32 +00:00
parent 6098ca0ce1
commit 16809ed535
1 changed files with 13 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@ -24,28 +24,27 @@ pull from instances that use the Mastodon API, which includes Pleroma.
### Go version ### Go version
Requires at least Go 1.5 or above This code was written on Go 1.16.
### Install Go Dependencies
Install the following requirements
```
go get muzzammil.xyz/jsonc
go get github.com/jackc/pgx/pgxpool
go get github.com/microcosm-cc/bluemonday
```
### Build Fedilogue ### Build Fedilogue
``` ```
git clone https://gitlab.com/khanzf/fedilogue git clone https://gitlab.com/khanzf/fedilogue
cd fedilogue cd fedilogue/fedilogue
make go build
``` ```
There should now be a `fedilogue` executable in the project directory. There should now be a `fedilogue` executable in the project directory.
### Fedilogue Control
```
cd fedilogue/fedictl
go build
```
Using the executable `fedictl`, you can now view the running state of instances or manually add a new instance for polling.
### Configuration ### Configuration
Fedilogue is configured by the `config.jsonc` file. Start by copying the `config.jsonc.sample` file to Fedilogue is configured by the `config.jsonc` file. Start by copying the `config.jsonc.sample` file to
@ -54,4 +53,4 @@ has enclosed explanations that should be self-explanatory.
## Contact ## Contact
Ping me at [@fikran@islamicate.space](https://islamicate.space/fikran) Ping me at [@fikran@thebag.social](https://thebag.social/@fikran)