This repository has been archived on 2023-07-28. You can view files and clone it, but cannot push or open issues or pull requests.
mastodon-bot/README.md
2018-08-17 20:02:35 -04:00

2.8 KiB

description

the bot will post the timeline from the specified Twitter/Tumblr accounts and RSS feeds to Mastodon

installation

  1. install Node.js
  2. run npm install to install Node modules
  3. run npm start to, well, start

If you wish to run the script directly, you will need to have Lumo available on the shell path. Lumo can be installed globally via NPM by running:

npm install -g lumo-cljs

If you get a permission failure, try this:

npm install -g lumo-cljs --unsafe-perm

usage

  • create a Mastodon API key following the instructions here
  • create a Twitter API key follwing the instructions here
  • create a Tumblr API key following the instructions here
  • create a file called config.edn with the following contents:
{;; add Twitter config to mirror Twitter accounts
 :twitter {:access-keys
           {:consumer_key "XXXX"
            :consumer_secret "XXXX"
            :access_token_key "XXXX"
            :access_token_secret "XXXX"}
           :accounts ["arstechnica" "WIRED"]} ;; accounts you wish to mirror
 ;; add Tumblr config to mirror Tumblr accounts
 :tumblr {:access-keys
          {:consumer_key "XXXX"
           :consumer_secret "XXXX"
           :token "XXXX"
           :token_secret "XXXX"}
          :accounts ["cyberpunky.tumblr.com" "scipunk.tumblr.com"]}
 ;; add RSS config to follow feeds
 :rss {"Hacker News" "https://hnrss.org/newest"
       "r/Clojure" "https://www.reddit.com/r/clojure/.rss"}
 :mastodon {:access_token "XXXX"
            :api_url "https://botsin.space/api/v1/"
            ;; optional limit for the post length
            :max-post-length 300
            ;; optional flag specifying wether the name of the account
            ;; will be appended in the post, defaults to false
            :append-screen-name? false
            ;; optional signature for posts
            :signature "#newsbot"
            ;; optional content filter regexes
            ;; any posts matching the regexes will be filtered out
            :content-filters [".*bannedsite.*"]}}
  • the bot looks for config.edn at its relative path by default, an alternative location can be specified either using the MASTODON_BOT_CONFIG environment variable or passing the path to config as an argument

  • run the bot: ./mastodon-bot.cljs

  • to poll at intervals setup a cron job such as:

    */30 * * * * mastodon-bot.cljs /path/to/config.edn > /dev/null 2>&1

License

Copyright © 2018 Dmitri Sotnikov

Distributed under the MIT License.