https://github.com/v411e/hype

Mastodon bot that boosts trending posts from other instances into your timeline
https://github.com/v411e/hype

bot mastodon trends

Last synced: 28 days ago
JSON representation

Mastodon bot that boosts trending posts from other instances into your timeline

• Host: GitHub
• URL: https://github.com/v411e/hype
• Owner: v411e
• Created: 2023-01-29T14:39:59.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-10-19T08:16:11.000Z (about 1 year ago)
• Last Synced: 2024-04-13T12:57:49.749Z (8 months ago)
• Topics: bot, mastodon, trends
• Language: Python
• Homepage: https://mastodon.keks.club/@hype
• Size: 57.6 KB
• Stars: 11
• Watchers: 1
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
![](./res/hype_header.png)

# hype

This Mastodon bot transfers the trends from other instances directly to your personal timeline. You decide which instances it fetches and how much you want to see per instance.

## Why

For smaller instances the local timeline is rather empty. This is why trends simply do not work on those instances: There is just not enough activity. Instead of manually checking out other instances this bot allows to subscribe to a multitude of different mastodon compatible servers to fetch trending posts and repost them to your current server helping discoverability of accounts, people and topics within the federated social web.

## Installation

Deploy with docker-compose

```yaml

version: "3"

services:

  hype:

    image: valentinriess/hype:latest

    volumes:

      - ./config:/app/config

```

## Configuration

Create a `config.yaml` and a `auth.yaml` file in `./config/`. Enter the credentials of your bot-account into `auth.yaml`. You can define which servers to follow and how often to fetch new posts as well as how to automatically change your profile in config.yaml. See the examples below:

`auth.yaml`:

```yaml

# Credentials for your bot account

bot_account:

  server: "mastodon.example.com"

  email: "[email protected]"

  password: "averylongandsecurepassword"

```

`config.yaml`

```yaml

# Refresh interval in minutes

interval: 60

# Text to add to the bot profile befor the list of subscribed servers

profile_prefix: "I am boosting trending posts from:"

# profile fields to fill in

fields:

  code: https://github.com/tante/hype

  operator: "YOUR HANDLE HERE"

# Define subscribed instances and

# their individual limit (top n trending posts)

# which is again limited by the API to max 20

subscribed_instances:

  chaos.social:

    limit: 20

  mastodon.social:

    limit: 5

# Filter posts from specific instances

filtered_instances:

  - example.com

```

## Features

- Boost trending posts from other Mastodon instances

- Update bot profile with list of subscribed instances

---