2
0
Fork
You've already forked Altbot
0
Accessibility bot designed to enhance the Fediverse by generating alt-text descriptions for images, video, and audio.
  • Go 73.8%
  • JavaScript 10.2%
  • CSS 8.6%
  • HTML 4%
  • Python 3.2%
  • Other 0.2%
2025年03月18日 22:16:20 -04:00
.github/workflows add dockerfile, compose, gh actions builds 2025年01月31日 09:20:37 -05:00
assets TM on banner 2025年03月15日 16:58:20 -04:00
dashboard lang on metrics 2025年03月18日 20:11:37 -04:00
.gitignore all of the cool things, gdpr, power stuff, its so cool 2025年03月06日 15:28:19 -05:00
docker-compose.yml add dockerfile, compose, gh actions builds 2025年01月31日 09:20:37 -05:00
Dockerfile golan version 2025年03月18日 20:14:45 -04:00
example.config.toml video processing 2025年03月18日 21:16:54 -04:00
gdpr_consent.go OWL v2 2025年03月14日 19:31:50 -04:00
go.mod brand identity, trademark policy 2025年03月11日 00:32:06 -04:00
go.sum tweaks 2025年03月02日 23:56:28 -05:00
LICENSE OWL v2 2025年03月14日 19:31:50 -04:00
llm_provider.go no more moviepy (it sucked ass) 2025年03月18日 22:15:05 -04:00
locales.go Instructions additions for llms 2025年02月20日 21:44:45 -05:00
localizations.json tweaks 2025年03月18日 21:34:25 -04:00
main.go version num 2025年03月18日 22:16:20 -04:00
metrics.go OWL v2 2025年03月14日 19:31:50 -04:00
PRIVACY.md privacy fix 2025年03月14日 14:12:38 -04:00
README.md Update README.md 2025年03月17日 11:58:01 -04:00
setup.go OWL v2 2025年03月14日 19:31:50 -04:00
TRADEMARK.md privacy fix 2025年03月14日 14:12:38 -04:00
transformers_server.py no more moviepy (it sucked ass) 2025年03月18日 22:15:05 -04:00
translation_layer.go video processing 2025年03月18日 21:16:54 -04:00
videoprocessor.go no more moviepy (it sucked ass) 2025年03月18日 22:15:05 -04:00
weekly_summary.go OWL v2 2025年03月14日 19:31:50 -04:00

A decorative banner featuring a repeating pattern of small purple robot icons against a light background, creating a retro-tech wallpaper effect

AltbotTM アクセシビリティロボット

Making the Fediverse more inclusive, one image at a time

Latest Release Mastodon Follow License: OWL v2.0 Go Version Status Environment

About

AltbotTM is an open-source accessibility bot designed to enhance the Fediverse by generating alt-text descriptions for images, video, and audio. This helps make content more accessible to users with visual impairments.

Privacy & GDPR Compliance

AltbotTM 2.0 now processes everything 100% locally with zero data retention! Mastodon Follow

In compliance with GDPR, AltbotTM requires explicit informed consent before processing any user requests. When you interact with AltbotTM for the first time, you'll receive a consent request with information about data collection practices and a link to our Privacy Policy.

  • What we collect: Request timestamps, processing times, language preferences, media type
  • What we don't collect: Images, personal information, content of your posts
  • How to revoke consent: Simply block the bot account

Your post content is never saved or shared. Only images without existing alt-text will be processed, and all processing happens privately on our local server.

Disclaimer

Alt-texts are generated using a Large Language Model (LLM). While we strive for accuracy, results may sometimes be factually incorrect. Always double-check the alt-text before using it.

How It Works

AltbotTM listens for mentions and follows on Mastodon. When it detects a mention or a new post from a followed user, it checks for images without alt-text. If it finds any, it uses a Large Language Model (LLM) to generate descriptive alt-text and replies with the generated text.

Features

  • Mention-Based Alt-Text Generation: Mention @Altbot in a reply to any post containing an image, video, or audio, and AltbotTM will generate an alt-text description for it.
  • Automatic Alt-Text for Followers: Follow @Altbot, and it will monitor your posts. If you post an image, video, or audio without alt-text, AltbotTM will automatically generate one for you.
  • Local LLM Support: Use local LLMs via Ollama for generating alt-text descriptions.
  • GDPR Compliance: Explicit informed consent system that requires users to provide consent before processing their requests, with clear information about data usage.
  • Consent Requests: Ask for consent from the original poster before generating alt-text when mentioned by non-OP users.
  • Configurable Settings: Easily configure the bot using a TOML file.

Setup

Standard

  1. Clone the repository:

    git clone https://github.com/micr0-dev/Altbot.git
cd Altbot

  2. Run the setup wizard:

    go run .

    The setup wizard will guide you through configuring the essential values required for the bot, including:

    • Your Mastodon server URL, client secret, access token, and bot username.
    • The admin contact handle for moderation notifications.
    • Enabling optional features like metrics and alt-text reminders.

    Alternatively, copy the example configuration file and edit it manually:

    cp example.config.toml config.toml

  3. Run the bot:

    go run .

Docker

  1. Clone the repository:

    git clone https://github.com/micr0-dev/Altbot.git
cd Altbot

  2. Run the setup wizard:

    docker run -it -v ./:/data --rm ghcr.io/micr0-dev/altbot:latest

    The setup wizard will guide you through configuring the essential values required for the bot, including:

    • Your Mastodon server URL, client secret, access token, and bot username.
    • The admin contact handle for moderation notifications.
    • Enabling optional features like metrics and alt-text reminders.

    Alternatively, copy the example configuration file and edit it manually:

    cp example.config.toml config.toml

  3. Run the bot:

    docker compose up -d

Contributing

We welcome contributions! Please open an issue or submit a pull request with your improvements.

Thank You

Special Thanks

I would like to express my deepest gratitude to Henrik Schönemann (@Schoeneh) who motivated me throughout this journey. His help with handling criticism and transforming it into constructive feedback has been invaluable. I truly would not be where I am today without his support and guidance.

Kofi Supporters

A heartfelt thank you to all my Ko-fi supporters! Your generous contributions help keep AltbotTM running and continually improving. Your support means the world to me and helps make the Fediverse a more accessible place for everyone.

Trademark Notice

"Altbot" is an unregistered trademark. While the code is open source under the OWL license, the name "Altbot" is protected. If you deploy your own instance, please refer to our Trademark Policy for naming guidelines.

License

This project is licensed under the OVERWORKED LICENSE (OWL) v2.0. See the LICENSE file for details.

Join us in making the Fediverse a more inclusive place for everyone!