sam/fediverse-imagebot
sam/fediverse-imagebot
Archived
1
0
Fork 0
Code Issues 1 Pull requests Projects Releases 4 Packages 1 Wiki Activity
A bot that posts images to the Fediverse https://blog.froth.zone/sam/the-end-of-an-era
This repository has been archived on 2023-05-27. You can view files and clone it, but cannot push or open issues or pull requests.
24 commits 1 branch 6 tags 258 MiB
TypeScript 95.5%
JavaScript 4.5%
Find a file
Renovate Bot 82bd6f1786
All checks were successful
continuous-integration/drone/push Build is passing
Details
continuous-integration/drone/pr Build is passing
Details
Add renovate.json
2022-05-03 09:46:21 +00:00
.yarn Booru support (#1) 2022-03-15 19:13:35 +00:00
src Booru support (#1) 2022-03-15 19:13:35 +00:00
.drone.yml [SKIP CI] add musl 2022-03-16 22:54:41 +01:00
.eslintignore Booru support (#1) 2022-03-15 19:13:35 +00:00
.eslintrc.json Booru support (#1) 2022-03-15 19:13:35 +00:00
.gitignore Booru support (#1) 2022-03-15 19:13:35 +00:00
.prettierignore Booru support (#1) 2022-03-15 19:13:35 +00:00
.yarnrc.yml Booru support (#1) 2022-03-15 19:13:35 +00:00
config.sample.jsonc Booru support (#1) 2022-03-15 19:13:35 +00:00
LICENSE Split token generation and the bot itself 2022-02-16 09:57:37 -06:00
package.json [SKIP CI] Update packaging 2022-03-16 22:34:37 +01:00
README.md [SKIP CI] add musl 2022-03-16 22:54:41 +01:00
renovate.json Add renovate.json 2022-05-03 09:46:21 +00:00
tsconfig.json Booru support (#1) 2022-03-15 19:13:35 +00:00
yarn.lock Booru support (#1) 2022-03-15 19:13:35 +00:00

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.