Skip to content

Easily automate re-toots/re-blogs from your Mastodon account

License

Notifications You must be signed in to change notification settings

chaostreff-flensburg/superretoot

Repository files navigation

🦣 super RE-toot

build

🤷 About

With super RE-toot you can easily automate re-toots/re-blogs from your Mastodon account. It only retoots, toots from accounts which are in a List and are using a certain hashtag. Both values can be configured.

An blue children cartoon elephant doing something similar to a toot

💻 Techstack

The software is written in node.js.

🕸️ Dependencies

Name Version
dotenv ^16.0.3
masto ^4.10.0

✔️ Config

config.json

Stores all config information.

Key Description Example
instanceUrl URL of your instance account https://mastodon.social
ownAccountName Your account name without example_bot
listName Your list Name reoot
tag The tag for filtering retoot
statusesLimit Limit on the amount of statuses 2

⚙️ .env - Mastodon Application Token

Stores the TOKEN information. You can generate a TOKEN by going to: Settings -> development. Create a new app, you can choose your own name. The app needs to read and write. After that you will be able to create the Token. Keep this token a secret.

🚀 How to install and run

  • Git clone thie Repo.
  • Copy the .env.example to .env and change fill in your TOKEN.
  • Copy the config.example.json to config.json and fill in your matching values.
  • Create a cronjob like the following one runs the script every 5 minutes.
*/5 * * * * cd /your/path/to/the/repe && docker run -v "$(pwd)"/config.json:/app/config.json:ro -v "$(pwd)"/.env:/app/.env:ro ghcr.io/chaostreff-flensburg/superretoot:latest >/dev/null 2>&1

🔁 Update

To get a new version of the project just pull the new image.

docker pull ghcr.io/chaostreff-flensburg/superretoot:latest

☠️ Limitations

Rate Limit

Be aware of the Mastodon Rate limit!

Boosted toots

Does not boost boosted toots. If the account in the list has boosted a toot containing the configured hastag it won't be boosted.

Edited toots

Be aware of edited toots. A boosted toot can be edited including the hashtag. The toot is still boosted even if the hashtag is not configured.

🗺️ Real Life Example

@chaos_fl (an awesome hackspace from nothern germany) re-toots every toot from users on the list retoot with the hashtag #ctfl. For Example this toot. The goal is to make our community members more visible and engage on more content.

⚖️ License

gpl-3.0