fediblock-instance/README.md
ale 33b42beb5b
All checks were successful
continuous-integration/drone/push Build is passing
README.md
2024-09-18 00:58:34 +02:00

42 lines
1.1 KiB
Markdown

# Fediblock Instance [![Build Status](https://drone.manalejandro.com/api/badges/ale/fediblock-instance/status.svg)](https://drone.manalejandro.com/ale/fediblock-instance) [![Quality Gate Status](https://sonar.manalejandro.com/api/project_badges/measure?project=fediblock-instance&metric=alert_status&token=sqb_748f7401d83ff11dc7f36ec805b1c9a73c41f1e5)](https://sonar.manalejandro.com/dashboard?id=fediblock-instance)
## Another instance to search public blocks and do stats and more, like one FBA but with NodeJS powers.
## We need one mongodb instance for federation and one elasticsearch node to storage data.
## Install
```
$ yarn or npm i
```
## Build frontend
```
$ yarn build or npm run build
```
## Configuration
- edit `lib/constant.js` with your environment preferences
## Start
```
$ yarn start or npm run start
```
## Docker
```
$ docker compose build or docker pull registry.manalejandro.com/fediblock-instance
$ docker compose pull
$ docker compose up -d
```
### Best deploy with subdomain in one HTTPS proxy like nginx or apache throught 4000/tcp port
## License
MIT