alpcentaur/fdb-spider-interface
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

added further documentation to README.md

Browse source
This commit is contained in:
alpcentaur 2024-01-21 14:45:57 +00:00
parent 192bdb5441
commit 80ef983824
1 changed files with 56 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

59
README.md
View file

@ -14,9 +14,24 @@ MM88MMM ,adPPYb,88 88,dPPYba, ,adPPYba, 8b,dPPYba, 88 ,adPPYb,88 ,a
88 88
``` ```
1. [Introduction](#introduction)
2. [Installation](#installation)
3. [Usage](#usage)
* [Important commands](#important-commands)
# Introduction
The fdb-spider-interface is an interface for the fdb-spider.
It is based on rocketchat, and displaying entries such as
programming tag search can be done within any rocketchat client.
In future, the bot based code will migrate from rocketchat to
matrix.
# Installation
To use this spider, u need to have a Rocketchat Server. To use this spider, you need to have a Rocketchat Server.
On your Rocketchat Server, create a new user with the role bot. On your Rocketchat Server, create a new user with the role bot.
Put the right password and username in config.ini. Put the right password and username in config.ini.
@ -34,6 +49,7 @@ From there, copy the room_id to
``` ```
config.ini config.ini
``` ```
which you want to be the room in which you talk to the interface bot.
For the bot_user_id run the commands For the bot_user_id run the commands
``` ```
@ -42,5 +58,42 @@ print(myinfo)
``` ```
Information: It is important to change the settings for bots, otherwise with the standard conf Information: It is important to change the settings for bots, otherwise with the standard rocketchat configuration
the fdb-spider-interface does too many requests the fdb-spider-interface will get too many requests errors and stop
working eventually.
# Usage
## Important Commands
There is actually only one important command to remember and that is
```
printcommands
```
That will output all available commands with explanations.
Generally, you can create new tag search "rooms" where the interface
will run updates.
```
createroom
```
will create a room where you can monitor your custom tag based
search outputs.
```
printrooms
```
will print all configured rooms,
```
addtags
```
will add tags to the tag search of a specific room, etc.
Specify the update interval and time in config.ini, and choose it
appropriate to your updates you give to the fdb-spider output (by running
the fdb-spider for example once a week with cron)