Continued:

[fba.git] / README.md

diff --git a/README.md b/README.md
index 84b1030e06716d5f8fb9b53cf902abafab673bf4..f0fb65c5d8d12fb957e41d1a6cb9da8493eceef9 100644 (file)
--- a/README.md
+++ b/README.md
@@ -5,44 +5,59 @@ Used to see which instances block yours.
 ## software used:
 
 - python 3.10.2
-- [node v17.6.0](https://github.com/nodesource/distributions/blob/master/README.md#installation-instructions)
-- [yarn 1.22.17](https://classic.yarnpkg.com/en/docs/install#debian-stable)
 
 ## Installation
 
-### Copy the preloaded database to the live database
-
 ```bash
-cp blocks_preloaded.db blocks.db
+sudo useradd -m fba
+sudo mkdir -p /opt/fedi-block-api
+sudo chown -R fba:fba /opt/fedi-block-api
+sudo -Hu fba git clone git://git.mxchange.org/fba.git /opt/fedi-block-api/
+cd /opt/fedi-block-api/
+sudo -Hu fba pip3 install -r requirements.txt
+sudo -Hu fba cp blocks_empty.db blocks.db
+sudo -Hu fba cp config.defaults.json config.json
+sudo -Hu fba ./fba.py fetch_instances --domain=mastodon.social # try a bunch of large servers here
 ```
 
-### Install the services
+### Alter configuration file
+You maybe wish to change the configuration file, e.g. log_level is set to "info" which is the default but invates privacy of your users, but your choice:
 
-Make sure to edit the `User` and `WorkingDirectory` in each service file accordingly.
+```
+    "critical"
+    "error"
+    "warning"
+    "info"
+    "debug"
+    "trace"
+```
 
-```bash
-sudo cp services/* /etc/systemd/system
+### Fetch blocklists locally (WIP)
+To save yourself bandwidth and codeberg, too, you want to clone the blocklists from some folks:
+
+```
+sudo -Hu fba git clone https://codeberg.org/oliphant/blocklists.git blocklists/oliphant/
 ```
 
-### Install node packages
+WIP notice: This feature is not implemented yet.
+
+### Install the services
 
 ```bash
-cd apis
-yarn install
+sudo cp services/* /etc/systemd/system
 ```
 
 ### start the services
 
 ```bash
-systemctl start mastodon_api
-systemctl start fetch_blocks
-systemctl start fedi_block_api
+systemctl enable --now fetch_blocks
+systemctl enable --now fedi_block_api
 ```
 
 ## Try it out
 
-https://api.chizu.love/blocked/
+https://fba.ryona.agency/ uses an older code than this one. So it doesn't reflect this code here. My FBA sub-domain is currently password-protected as I still need to fix some performance issues with large blocking lists.
 
 ## License
 
-[AGPLv3+NIGGER](https://plusnigger.autism.exposed/)
+[AGPLv3](https://gnu.org)