yogthos / mastodon-bot

a bot for mirroring Twitter/Tumblr accounts and RSS feeds on Mastodon

This Repository has been moved to https://gitlab.com/yogthos/mastodon-bot

please follow and find current development there

description

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

installation

1. prerequisits: should be installed: Node.js, npm
2. install mastodon-bot with: sudo npm install mastodon-bot -g
3. run with: mastodon-bot <path to config>

usage

• create a Mastodon API key following the instructions here
• create a Twitter API key following the instructions here
• create a Tumblr API key following the instructions here
• create a file called config.edn with the following contents:

NOTE: the bot checks the specified Mastodon account to see the timestamp of the last post, and only posts content with later timestamps to avoid duplicate posts. On the first run the timestamp will default to current time.

{:auth {;; add Twitter config to mirror Twitter accounts
        :twitter {:consumer_key "XXXX"
                  :consumer_secret "XXXX"
                  :access_token_key "XXXX"
                  :access_token_secret "XXXX"}
        :mastodon {:access_token "XXXX"
                   ;; account number you see when you log in and go to your profile
                   ;; e.g: https://mastodon.social/web/accounts/294795
                   :account-id "XXXX"
                   :api_url "https://botsin.space/api/v1/"}
        :tumblr {:consumer_key "XXXX"
                 :consumer_secret "XXXX"
                 :token "XXXX"
                 :token_secret "XXXX"}}
 
:transform [{:source {:source-type :twitter
                       ;; optional, defaults to false
                       :include-replies? false
                       ;; optional, defaults to false
                       :include-rts? false
                       ;; Replace Twitter links by Nitter
                       :nitter-urls? false
                       ;; accounts you wish to mirror
                       :accounts ["arstechnica" "WIRED"]}
             :target {:target-type :mastodon
                      ;; optional flag specifying wether the name of the account
                      ;; will be appended in the post, defaults to false
                      :append-screen-name? false
                      ;; optional visibility flag: direct, private, unlisted, public
                      ;; defaults to public
                      :visibility "unlisted"
                      ;; optional boolean to mark content as sensitive. Defaults to true.
                      :sensitive? true
                      ;; optional boolean defaults to false
                      ;; only sources containing media will be posted when set to true
                      :media-only? true
                      ;; optional limit for the post length. Defaults to 300.
                      :max-post-length 300
                      ;; optional signature for posts. Defaults to "not present".
                      :signature "#newsbot"}
             ;; optionally try to resolve URLs in posts to skip URL shorteners
             ;; defaults to false
             :resolve-urls? true
             ;; optional content filter regexes
             ;; any posts matching the regexes will be filtered out
             :content-filters [".*bannedsite.*"]
             ;; optional keyword filter regexes
             ;; any posts not matching the regexes will be filtered out
             :keyword-filters [".*clojure.*"]
             ;; optional replacements
             ;; When the strings on the left side of this map are encountered in the source,
             ;; they are replaced with the string on the right side of the map:
             :replacements {
               "@openSUSE" "@[e-mail]",
               "@conservancy" "@[e-mail]"}}

             {:source {:source-type :rss
                       ;; add RSS config to follow feeds
                       :feeds [["Hacker News" "https://hnrss.org/newest"]
                               ["r/Clojure" "https://www.reddit.com/r/clojure/.rss"]]}
             :target {:target-type :mastodon
                      ...}
             :resolve-urls? ...}

             {:source {:source-type :tumblr
                       ;; optional limit for number of posts to retrieve, default: 5
                       :limit 10
                       :accounts ["cyberpunky.tumblr.com" "scipunk.tumblr.com"]
             :target {:target-type :mastodon
                      ...}
             :resolve-urls? ...}}
             ]
}

• 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

• transformations have source (s/def ::source-type #{:twitter :rss :tumblr}) und target (s/def ::target-type #{:mastodon}) you can combine freely. Multiple transformations for same source-target combination are possible. Source and targets refer to the auth section for their credentials.

• install NPM modules: npm install

• compile: npx shadow-cljs release app

• run the bot: npm start

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

  */30 * * * * npm start /path/to/config.edn > /dev/null 2>&1

License

Copyright © 2018 Dmitri Sotnikov

Distributed under the MIT License.