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

67 lines
2.6 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
3. run `npm start` to, well, start
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/)
* create a Twitter API key follwing 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:
```clojure
2018-03-15 05:01:53 +00:00
{;; add Twitter config to mirror Twitter accounts
:twitter {:access-keys
2018-03-11 21:05:25 +00:00
{:consumer_key "XXXX"
:consumer_secret "XXXX"
:access_token_key "XXXX"
:access_token_secret "XXXX"}
:accounts ["arstechnica" "WIRED"]} ;; accounts you wish to mirror
2018-03-15 05:01:53 +00:00
;; 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"]}
2018-03-20 12:57:25 +00:00
;; add RSS config to follow feeds
:rss {"Hacker News" "https://hnrss.org/newest"
"r/Clojure" "https://www.reddit.com/r/clojure/.rss"}
2018-03-11 21:05:25 +00:00
:mastodon {:access_token "XXXX"
2018-03-23 13:14:26 +00:00
:api_url "https://botsin.space/api/v1/"
2018-04-01 02:12:31 +00:00
:max-post-length 300
;; optional signature for posts
:signature "#newsbot"
;; optional content filter regexes
;; any posts matching the regexes will be filtered out
:content-filters [".*bannedsite.*"]}}
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
* 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
2018-03-25 21:23:09 +00:00
## License
Copyright © 2018 Dmitri Sotnikov
Distributed under the [MIT License](http://opensource.org/licenses/MIT).