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

123 lines
5.4 KiB
Markdown
Raw Normal View History

2018-03-11 21:05:25 +00:00
### description
2018-03-20 12:57:25 +00:00
the bot will post the timeline from the specified Twitter/Tumblr accounts and RSS feeds to Mastodon
2018-03-11 21:05:25 +00:00
### installation
1. install [Node.js](https://nodejs.org/en/)
2018-03-14 18:23:05 +00:00
2. run `npm install` to install Node modules
2018-03-11 21:05:25 +00:00
2018-05-10 22:46:38 +00:00
If you wish to run the script directly, you will need to have [Lumo](https://github.com/anmonteiro/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](https://github.com/anmonteiro/lumo/issues/206), try this:
npm install -g lumo-cljs --unsafe-perm
2018-03-11 21:05:25 +00:00
### usage
* create a Mastodon API key following the instructions [here](https://tinysubversions.com/notes/mastodon-bot/)
2019-11-29 11:25:03 +00:00
* create a Twitter API key following the instructions [here](https://developer.twitter.com/en/docs/basics/authentication/guides/access-tokens)
2018-03-15 05:01:53 +00:00
* create a Tumblr API key following the instructions [here](http://www.developerdrive.com/2014/05/how-to-get-started-with-the-tumblr-api-part-1/)
2018-03-11 21:05:25 +00:00
* create a file called `config.edn` with the following contents:
2020-06-09 06:18:15 +00:00
**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.
2018-03-11 21:05:25 +00:00
```clojure
2020-05-30 15:14:49 +00:00
{: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"
2020-06-08 17:47:04 +00:00
:api_url "https://botsin.space/api/v1/"}
:tumblr {:consumer_key "XXXX"
:consumer_secret "XXXX"
:token "XXXX"
:token_secret "XXXX"}}
2020-05-30 15:14:49 +00:00
2020-06-08 17:47:04 +00:00
:transform [{:source {:source-type :twitter
2020-05-29 13:54:32 +00:00
;; optional, defaults to false
:include-replies? false
;; optional, defaults to false
:include-rts? false
2020-05-29 20:16:23 +00:00
;; Replace Twitter links by Nitter
:nitter-urls? false
2020-05-29 13:54:32 +00:00
;; accounts you wish to mirror
:accounts ["arstechnica" "WIRED"]}
2020-06-08 18:44:25 +00:00
:target {:target-type :mastodon
2020-05-29 18:12:37 +00:00
;; optional flag specifying wether the name of the account
;; will be appended in the post, defaults to false
:append-screen-name? false
2020-05-29 19:13:43 +00:00
;; optional visibility flag: direct, private, unlisted, public
;; defaults to public
:visibility "unlisted"
2020-05-29 19:19:43 +00:00
;; 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
2020-05-29 17:48:48 +00:00
;; optional signature for posts
:signature "#newsbot"}
;; optionally try to resolve URLs in posts to skip URL shorteners
;; defaults to false
2020-05-30 12:49:47 +00:00
: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
2020-05-30 13:07:11 +00:00
:keyword-filters [".*clojure.*"]
;; TODO: Description & example missing here
2020-05-31 17:59:20 +00:00
:replacements nil}
2020-06-08 17:47:04 +00:00
{:source {:source-type :rss
2020-05-31 17:59:20 +00:00
;; add RSS config to follow feeds
:feeds [["Hacker News" "https://hnrss.org/newest"]
["r/Clojure" "https://www.reddit.com/r/clojure/.rss"]]}
2020-06-08 18:44:25 +00:00
:target {:target-type :mastodon
2020-06-08 17:47:04 +00:00
...}
: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"]
2020-06-08 18:44:25 +00:00
:target {:target-type :mastodon
2020-05-31 17:59:20 +00:00
...}
2020-06-08 18:44:25 +00:00
:resolve-urls? ...}}
2020-05-31 17:59:20 +00:00
]
2020-05-29 13:54:32 +00:00
}
2018-03-11 21:05:25 +00:00
```
2018-03-15 05:01:53 +00:00
2018-03-11 21:05:25 +00:00
* 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
2020-06-09 06:18:15 +00:00
* 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.
2020-02-27 22:12:07 +00:00
* run the bot: `npm start`
2018-03-11 21:05:25 +00:00
* to poll at intervals setup a cron job such as:
2020-02-27 22:12:07 +00:00
*/30 * * * * npm start /path/to/config.edn > /dev/null 2>&1
2018-03-25 21:23:09 +00:00
2020-02-28 01:30:24 +00:00
### compiling to Js
Alternatively, the bot can be compiled directly to JavaScript using the following command:
```
npx shadow-cljs release app
```
2018-03-25 21:23:09 +00:00
## License
Copyright © 2018 Dmitri Sotnikov
Distributed under the [MIT License](http://opensource.org/licenses/MIT).