Skip to main content

A Fediverse bot framework

Project description

Roboherd

Roboherd is a framework for building Fediverse bots using the Cattle Drive Protocol.

For more information, see the documentation or the repository.

Developping with cattle_grid

In your catle_grid config directory add a roboherd user, e.g. a file testing.toml with content

[testing]
enable = true

[[testing.accounts]]
name = "herd"
password = "pass"
permissions = ["admin"]

Configure roboherd via roboherd.toml, e.g.

base_url = "http://abel"
connection_string = "ws://herd:pass@localhost:3000/ws/"

[cow.rooster]
bot = "roboherd.examples.rooster:bot"

This will trigger a periodic message to cattle_grid.

nginx for cattle_grid

The nginx in the cattle_grid configuration should forward the path /ws/ to rabbitmq (supporting mqtt over websockets)

server {
    listen 80;
    
    location /ws/ {
        proxy_pass http://rabbitmq:15675;
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection $connection_upgrade;
        proxy_read_timeout 86400; # neccessary to avoid websocket timeout disconnect
        proxy_send_timeout 86400; # neccessary to avoid websocket timeout disconnect
        proxy_redirect off;
        proxy_buffering off;
    }
}

similarly nginx should forward port 80 to 3000 (in the docker compose file).

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

roboherd-0.1.9.tar.gz (257.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

roboherd-0.1.9-py3-none-any.whl (27.0 kB view details)

Uploaded Python 3

File details

Details for the file roboherd-0.1.9.tar.gz.

File metadata

  • Download URL: roboherd-0.1.9.tar.gz
  • Upload date:
  • Size: 257.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.14

File hashes

Hashes for roboherd-0.1.9.tar.gz
Algorithm Hash digest
SHA256 2f1010f6cce8d24d7cdd1a4a80eab7c5effa108fd489d31ba5e3936db106dc31
MD5 fd166debab5fd225ca939bcd5601124f
BLAKE2b-256 a75a3f14beb93d2ac20789bbf7587b2faa01671bd72fb2a0a09e9d8fbb9c4aca

See more details on using hashes here.

File details

Details for the file roboherd-0.1.9-py3-none-any.whl.

File metadata

  • Download URL: roboherd-0.1.9-py3-none-any.whl
  • Upload date:
  • Size: 27.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.14

File hashes

Hashes for roboherd-0.1.9-py3-none-any.whl
Algorithm Hash digest
SHA256 62d5b3a641bbbc7348f2df37574205771b47800bb65ff76280998b0a638e01aa
MD5 d170084712bcb47fc2ac9b464176fac9
BLAKE2b-256 4b34d3b3ef2101873728b49e5690a069603ea005cbb448b81e0bdd8360994919

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page