2022-01-01 19:37:33 +00:00
|
|
|
# FediSearch
|
|
|
|
|
|
|
|
Search accounts and channels to follow on Fediverse
|
|
|
|
|
|
|
|
App makes queries to database of collected Fediverse feeds and nodes.
|
|
|
|
|
|
|
|
Only fulltext search is currently supported. More precise filtering is planned for one of the future releases.
|
|
|
|
|
|
|
|
## Config
|
|
|
|
|
|
|
|
Configuration is done using environmental variables:
|
|
|
|
|
2022-09-14 19:16:00 +00:00
|
|
|
| Variable | Description | Value example |
|
|
|
|
|-----------------------|--------------------------------------------------------------------------------------------------------------------|-------------------------------|
|
|
|
|
| `ELASTIC_URL` | Url address of ElasticSearch server | `http://elastic:9200` |
|
|
|
|
| `ELASTIC_USER` | Username for EalsticSearch server | `elastic` |
|
|
|
|
| `ELASTIC_PASSWORD` | Username for EalsticSearch server | empty |
|
|
|
|
| `MATOMO_URL` | Optional url of Matomo server for collecting usage statistics. Leaving it empty disables collecting analytics. | `https://matomo.myserver.tld` |
|
|
|
|
| `MATOMO_SITE_ID` | Optional Matomo site id parameter for collecting usage statistics. Leaving it empty disables collecting analytics. | `8` |
|
|
|
|
| `STATS_CACHE_MINUTES` | Optional number of minutes to cache heavily calculated stats data | `60` |
|
2022-01-01 19:37:33 +00:00
|
|
|
|
|
|
|
## 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](https://github.com/Stopka/fedisearch-compose) project
|
|
|
|
|
|
|
|
For crawling Fediverse network and collecting feeds to database there is a companion
|
|
|
|
app [FediCrawl](https://github.com/Stopka/fedicrawl)
|