fdb-spider-interface/README.md

```
  __     _ _                     _     _                _       _            
 / _| __| | |__        ___ _ __ (_) __| | ___ _ __     (_)_ __ | |_ ___ _ __ 
| |_ / _` | '_ \ _____/ __| '_ \| |/ _` |/ _ \ '__|____| | '_ \| __/ _ \ '__|
|  _| (_| | |_) |_____\__ \ |_) | | (_| |  __/ | |_____| | | | | ||  __/ |   
|_|  \__,_|_.__/      |___/ .__/|_|\__,_|\___|_|       |_|_| |_|\__\___|_|   
                          |_|                                                
  __                
 / _| __ _  ___ ___ 
| |_ / _` |/ __/ _ \
|  _| (_| | (_|  __/
|_|  \__,_|\___\___|
                    
```

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, you need to have a Rocketchat Server.

On your Rocketchat Server, create a new user with the role bot.
Put the right password and username in config.ini.
Create a private channel, add the bot to the channel, then run the code 

```
api = RocketChatAPI(settings={'username': botname, 'password': botpassword, 'domain': server_url})

rooms = api.get_private_rooms()

print(rooms)
```

From there, copy the room_id to
``` 
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
```
myinfo = api.get_my_info()
print(myinfo)
```


Information: It is important to change the settings for bots, otherwise with the standard rocketchat configuration
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.