whoops

[fba.git] / README.md

diff --git a/README.md b/README.md
index e90aa5b390b51114fc984ff9c6df98f5bbee3d99..cc20c3b57747a9c34362b9bdb88c7c737560a932 100644 (file)
--- a/README.md
+++ b/README.md
@@ -3,28 +3,40 @@
 Used to see which instances block yours.
 
 ## software used:
-- python 3.10.2
-- node v17.6.0
-- yarn 1.22.17
 
-## how to use:
+- python 3.10.2
 
-Copy the preloaded database to the live database
+## Installation
+
+```bash
+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 https://gitlab.com/EnjuAihara/fedi-block-api.git /opt/fedi-block-api
+cd /opt/fedi-block-api
+sudo -Hu fba pip3 install -r requirements.txt
+sudo -Hu fba cp blocks_preloaded.db blocks.db
+sudo -Hu fba cp config.defaults.json config.json
+```
 
-`cp blocks_preloaded.db blocks.db`
 
-Start the mastodon API
+### Install the services
 
+```bash
+sudo cp services/* /etc/systemd/system
 ```
-cd mastodon_api
-yarn install
-node .
+
+### start the services
+
+```bash
+systemctl enable --now fetch_blocks
+systemctl enable --now fedi_block_api
 ```
 
-Fill the database with blocks.
+## Try it out
 
-`python fetch_blocks.py`
+https://fba.ryona.agency/fedi-block-api
 
 ## License
 
-[AGPLv3+NIGGER](https://plusnigger.autism.exposed/)
\ No newline at end of file
+[AGPLv3+NIGGER](https://plusnigger.autism.exposed/)