Go to file
Štěpán Škorpil 945c9495f5 Added pleroma 2022-01-08 02:16:16 +01:00
application Added pleroma 2022-01-08 02:16:16 +01:00
.dockerignore Initial crawler commit 2021-12-23 15:14:06 +01:00
.gitignore Initial crawler commit 2021-12-23 15:14:06 +01:00
Dockerfile Added more env configs 2022-01-03 13:26:17 +01:00
LICENSE Initial crawler commit 2021-12-23 15:14:06 +01:00
README.md Added more env configs 2022-01-03 13:26:17 +01:00

README.md

FediCrawl

Collect feeds to follow on Fediverse nodes.

App crawls from node to node (starting from the seed node) and searches for feeds (accounts or channels) and for other peered nodes.

Discovered nodes are added to database and are queued for next search. New nodes are processed preferentially. If there is no new node, data of oldest node are refreshed.

Node data are retrieved using node info api.

Node's public feeds and peering nodes are retrieved only on several supported softwares using thier's public APIs.

Supported Fediverse software

For now only two fediverse apps are supported:

Data providers for more apps will be probably added soon (Pull requests are welcomed)

Config

Configuration is done using environmental variables:

Variable Description Default value / Example value
POSTGRES_URL Postgres database uri postgresql://fedisearch:passwd@postgres:5432/fedisearch?schema=public
SEED_NODE_DOMAIN Domain of the first node to search users and other nodes on mastodon.social
REATTEMPT_MINUTES Optional, How many minutes should be waited for next node refresh attempt if the refresh fails 60
REFRESH_HOURS Optional, How often (in hours) should be node info refreshed 120
WAIT_FOR_JOB_MINUTES Optional, How many minutes should the thread sleep if there are no nodes to refresh 60
DEFAULT_TIMEOUT_MILLISECONDS Optional, How many milliseconds should http wait for node api response on refresh 10000
TZ Optional, Timezone UTC

Deploy

App is designed to be run in docker container and deployed using docker-compose. More info can be found in FediSearch example docker-compose project

For searching in collected feeds there is a companion server app FediSearch