From 99ae7e0ea6c432cf8b0bcb08b72d464ac5cab335 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Roland=20H=C3=A4der?= Date: Mon, 1 Apr 2024 05:12:17 +0200 Subject: [PATCH] Continued: - updated README file to reflect virtual environment for Python 3.11 - README file is a bit better --- docs/README.md | 42 +++++++++++++++++++++++++++++++++++------- 1 file changed, 35 insertions(+), 7 deletions(-) diff --git a/docs/README.md b/docs/README.md index 8c08479..cd7c52d 100644 --- a/docs/README.md +++ b/docs/README.md @@ -8,16 +8,44 @@ Used to see which instances block yours. ## Installation +Create role-based user: + ```bash sudo useradd --home-dir=/opt/fedi-block-api --comment "Fedi Block API" --user-group --create-home 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 software: + +```bash +# Change to role-based user 'fba' +sudo -Hu fba su - + +# Clone code +git clone git://git.mxchange.org/fba.git + +# You MUST create a virtual environment: +python3 -m venv venv + +# Add this to your ~/.bashrc file +source "${HOME}/fba/venv/bin/activate" + +# Install all requirements +pip3 install -r requirements.txt + +# Create blocks.db +cp blocks_empty.db blocks.db + +# Create configuration file +cp config.defaults.json config.json +``` + +Run commands, they should not fail! + +```bash +# Run commands, they should not fail! +./fba.py fetch_instances --domain=mastodon.social # try a bunch of large servers here ``` ### Alter configuration file @@ -36,7 +64,7 @@ You maybe wish to change the configuration file, e.g. log_level is set to "info" 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/ +git clone https://codeberg.org/oliphant/blocklists.git blocklists/oliphant/ ``` WIP notice: This feature is not implemented yet. -- 2.39.5