README.md

   1 # Fedi block API
   2
   3 Used to see which instances block yours.
   4
   5 ## software used:
   6
   7 - python 3.10.2
   8
   9 ## Installation
  10
  11 ```bash
  12 sudo useradd -m fba
  13 sudo mkdir -p /opt/fedi-block-api
  14 sudo chown -R fba:fba /opt/fedi-block-api
  15 sudo -Hu fba git clone https://git.kiwifarms.net/mint/fedi-block-api.git /opt/fedi-block-api
  16 cd /opt/fedi-block-api
  17 sudo -Hu fba pip3 install -r requirements.txt
  18 sudo -Hu fba cp blocks_empty.db blocks.db
  19 sudo -Hu fba python3 fetch_instances.py mastodon.social # try a bunch of large servers here
  20 sudo -Hu fba cp config.defaults.json config.json
  21 ```
  22
  23 ### Alter configuration file
  24 You maybe wish to change the configuration file, e.g. log_level is set to "info" which is the
  25 default but invates privacy of your users, but your choice:
  26
  27 ```
  28     "critical"
  29     "error"
  30     "warning"
  31     "info"
  32     "debug"
  33     "trace"
  34 ```
  35
  36 ### Install the services
  37
  38 ```bash
  39 sudo cp services/* /etc/systemd/system
  40 ```
  41
  42 ### start the services
  43
  44 ```bash
  45 systemctl enable --now fetch_blocks
  46 systemctl enable --now fedi_block_api
  47 ```
  48
  49 ## Try it out
  50
  51 https://fba.ryona.agency/
  52
  53 ## License
  54
  55 [AGPLv3](https://gnu.org)