No description
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.
Find a file
2020-06-12 14:54:05 +02:00
resources/test/mastodon_bot/rss_api prepare parser-test 2020-05-31 19:59:35 +02:00
src move filter to transform only 2020-06-08 19:59:34 +02:00
testdata/twitter did some format 2020-05-25 16:57:26 +02:00
.gitignore repl now works 2020-05-13 17:41:27 +02:00
Dockerfile Added Dockerfile and poll.sh 2019-03-11 12:15:13 +01:00
mastodon-bot.js Adding support for nitter, replace twitter links by nitter links 2020-01-15 15:54:41 +00:00
package.json maybe files have also to be adjusted in package.json? 2020-06-09 08:22:12 +02:00
poll.sh clean up, updated docs 2020-02-27 17:12:07 -05:00
README.md add minimal doc for transformations 2020-06-09 08:18:15 +02:00
shadow-cljs.edn fix shadow-cljs definition. 2020-06-12 14:54:05 +02:00
test.edn reviewed & updated doc 2020-06-08 20:44:25 +02:00

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

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 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
                      :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
                      :max-post-length 300
                      ;; optional signature for posts
                      :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.*"]
             ;; TODO: Description & example missing here
             :replacements nil}

             {: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.

  • 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

compiling to Js

Alternatively, the bot can be compiled directly to JavaScript using the following command:

npx shadow-cljs release app

License

Copyright © 2018 Dmitri Sotnikov

Distributed under the MIT License.