fedi-block-api/README.md

48 lines
840 B
Markdown
Raw Normal View History

2022-03-04 17:18:11 +00:00
# Fedi block API
Used to see which instances block yours.
## software used:
2022-03-06 13:46:43 +00:00
2022-03-04 17:18:11 +00:00
- python 3.10.2
2022-03-11 21:43:10 +00:00
- [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)
2022-03-04 17:18:11 +00:00
2022-03-06 13:46:43 +00:00
## Installation
2022-03-04 17:18:11 +00:00
2022-03-06 13:46:43 +00:00
### Copy the preloaded database to the live database
2022-03-04 17:18:11 +00:00
2022-03-06 13:46:43 +00:00
```bash
cp blocks_preloaded.db blocks.db
```
2022-03-04 17:18:11 +00:00
2022-03-06 13:46:43 +00:00
### Install the services
2022-03-04 17:18:11 +00:00
2022-03-06 13:46:43 +00:00
Make sure to edit the `User` and `WorkingDirectory` in each service file accordingly.
2022-03-04 17:45:23 +00:00
2022-03-06 13:46:43 +00:00
```bash
sudo cp services/* /etc/systemd/system
2022-03-04 17:18:11 +00:00
```
2022-03-06 13:46:43 +00:00
### Install node packages
```bash
cd apis
2022-03-04 17:18:11 +00:00
yarn install
```
2022-03-06 13:46:43 +00:00
### start the services
2022-03-04 18:25:29 +00:00
2022-03-06 13:46:43 +00:00
```bash
2022-03-04 18:25:29 +00:00
systemctl start fetch_blocks
2022-03-06 13:46:43 +00:00
systemctl start fedi_block_api
2022-03-04 18:25:29 +00:00
```
2022-03-04 17:18:11 +00:00
2022-03-11 21:43:10 +00:00
## Try it out
2022-03-23 21:52:46 +00:00
https://chizu.love/fedi-block-api/api
2022-03-11 21:43:10 +00:00
2022-03-04 17:18:11 +00:00
## License
2022-03-11 21:43:10 +00:00
[AGPLv3+NIGGER](https://plusnigger.autism.exposed/)