You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
Renovate Bot 083900a1d9 Update typescript-eslint monorepo to v5.33.0 3 days ago
.vscode Update dependencies 3 months ago
.yarn Update typescript-eslint monorepo to v5.33.0 3 days ago
src revert JSON comments upgrade, make HTTP error more verbose 2 weeks ago
.drone.yml Fix pkg builds 3 months ago
.eslintignore Booru support (#1) 5 months ago
.eslintrc.json Booru support (#1) 5 months ago
.gitignore Update dependencies 3 months ago
.prettierignore Booru support (#1) 5 months ago
.yarnrc.yml Fix pkg builds 3 months ago
LICENSE Lint & Relicense 2 months ago
README.md Update dependencies 3 months ago
config.sample.jsonc Booru support (#1) 5 months ago
package.json Update typescript-eslint monorepo to v5.33.0 3 days ago
renovate.json Update dependencies 3 months ago
tsconfig.json Update dependencies 3 months ago
yarn.lock Update typescript-eslint monorepo to v5.33.0 3 days ago

README.md

fediverse-imagebot

Build Status

A bot that posts local and booru images to the Fediverse.

Compatible with Mastodon, Misskey and Pleroma!

MIGRATING MAJOR VERSIONS

See the wiki.

Boorus supported

The full list of boorus supported is found here.

Downloading the bot

There are currently two ways to do this, either with a pre-built binary or building from source. Both are listed below.

Downloading pre-built binaries

Download prebuilt binaries from here. (currently supports x86_64 and arm64 on Linux [glibc or musl], macOS and Windows)

  1. Run the bot with the -w flag to have it generate a configuration file to the local directory.

  2. Edit it for your use case.

  1. Run the bot by launching the executable!

Running from Source

  1. You need to have npm and nodejs installed.
  • Node 15 or greater is required.
  1. Install yarn:
    corepack enable
    Check https://yarnpkg.com/getting-started/install for more information.

  2. Clone the repository:
    git clone https://git.froth.zone/sam/fediverse-imagebot.git

  3. Install dependencies:
    yarn

  4. Build:
    yarn build

  5. Edit the config file:
    cp config.sample.jsonc config.jsonc

  6. Run the bot:
    yarn bot

You're done! The bot should post a local image to the fediverse instance of your choosing!

Automating the bot

TODO: Elaborate more

The bot can be automated to post images at set times using a cronjob.
Example cron configuration:

0 * * * * cd /path/to/fediverse-imagebot && /usr/local/bin/yarn bot -c ./config.sample.jsonc

This example will run the bot every hour on the hour with no message using images from the default images directory.

An example of this pleroma configuration can be found at https://froth.zone/rinbot.