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.
 
Not Sam 315940dfff Update 'README.md' 2 days ago
src Make README show newer image folder option 2 weeks ago
.drone.yml Make README show newer image folder option 2 weeks ago
.eslintrc.json Finish token generation, add flags to bot 2 weeks ago
.gitignore Finish token generation, add flags to bot 2 weeks ago
LICENSE Add basic stuffs 3 weeks ago
README.md Update 'README.md' 2 days ago
config.sample.jsonc Change naming, make required node version obvious 2 weeks ago
package.json Make README show newer image folder option 2 weeks ago
tsconfig.json Fix NSFW directory 2 weeks ago
yarn.lock Make error messages more clear 2 weeks ago

README.md

fediverse-imagebot

Build Status

A bot that posts (currently only local) images to the Fediverse.

Should be compatible with Mastodon, Misskey and Pleroma!

Quick start guide

  1. You need to have npm and nodejs installed.
  • Node 15 or greater is required.
  1. Install yarn:
    npm install --global yarn
  • This may be need to ran with sudo depending on your installation.
  1. Clone the repository:
    git clone https://git.freecumextremist.com/NotSam/fediverse-imagebot.git

  2. Install dependencies:
    yarn

  3. Build:
    yarn build

  4. Obtain a token. This can be done with an external tool or obtained by running yarn token and following the directions.

  • yarn token will generate a configuration file located at config.json
  1. Put images in the images folder.
  • By default the bot will look for SFW images at images/sfw and NSFW images at images/nsfw. This can be configured with the -d flag.
  1. Run the bot:
    yarn local

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 local -m "Message"

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

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

Additional information

Additional help can be found by running yarn local -h or yarn token -h.