reviewed & updated doc

This commit is contained in:
jem 2020-06-08 20:44:25 +02:00
parent fc0e6eaede
commit b169c5c2b3
2 changed files with 68 additions and 65 deletions

View file

@ -51,7 +51,7 @@ with later timestamps to avoid duplicate posts. On the first run the timestamp w
:nitter-urls? false :nitter-urls? false
;; accounts you wish to mirror ;; accounts you wish to mirror
:accounts ["arstechnica" "WIRED"]} :accounts ["arstechnica" "WIRED"]}
:target {:target-type :mastodon-target :target {:target-type :mastodon
;; optional flag specifying wether the name of the account ;; optional flag specifying wether the name of the account
;; will be appended in the post, defaults to false ;; will be appended in the post, defaults to false
:append-screen-name? false :append-screen-name? false
@ -83,7 +83,7 @@ with later timestamps to avoid duplicate posts. On the first run the timestamp w
;; add RSS config to follow feeds ;; add RSS config to follow feeds
:feeds [["Hacker News" "https://hnrss.org/newest"] :feeds [["Hacker News" "https://hnrss.org/newest"]
["r/Clojure" "https://www.reddit.com/r/clojure/.rss"]]} ["r/Clojure" "https://www.reddit.com/r/clojure/.rss"]]}
:target {:target-type :mastodon-target :target {:target-type :mastodon
...} ...}
:resolve-urls? ...} :resolve-urls? ...}
@ -91,9 +91,9 @@ with later timestamps to avoid duplicate posts. On the first run the timestamp w
;; optional limit for number of posts to retrieve, default: 5 ;; optional limit for number of posts to retrieve, default: 5
:limit 10 :limit 10
:accounts ["cyberpunky.tumblr.com" "scipunk.tumblr.com"] :accounts ["cyberpunky.tumblr.com" "scipunk.tumblr.com"]
:target {:target-type :mastodon-target :target {:target-type :mastodon
...} ...}
:resolve-urls? ...} :resolve-urls? ...}}
] ]
} }
``` ```

125
test.edn
View file

@ -1,69 +1,72 @@
{;; add Twitter config to mirror Twitter accounts {:auth {;; add Twitter config to mirror Twitter accounts
:twitter {:access-keys :twitter {:consumer_key "XXXX"
{:consumer_key "XXXX" :consumer_secret "XXXX"
:consumer_secret "XXXX" :access_token_key "XXXX"
:access_token_key "XXXX" :access_token_secret "XXXX"}
:access_token_secret "XXXX"} :mastodon {:access_token "XXXX"
;; optional, defaults to false ;; account number you see when you log in and go to your profile
:include-replies? false ;; e.g: https://mastodon.social/web/accounts/294795
;; optional, defaults to false :account-id "XXXX"
:include-rts? false :api_url "https://botsin.space/api/v1/"}
;; accounts you wish to mirror :tumblr {:consumer_key "XXXX"
:accounts ["arstechnica" "WIRED"]} :consumer_secret "XXXX"
;; add Tumblr config to mirror Tumblr accounts :token "XXXX"
:tumblr {:access-keys :token_secret "XXXX"}}
{:consumer_key "XXXX" :transform
:consumer_secret "XXXX" [{:source {:source-type :twitter
:token "XXXX" ;; optional, defaults to false
:token_secret "XXXX"} :include-replies? false
;; optional limit for number of posts to retrieve, default: 5 ;; optional, defaults to false
:limit 10 :include-rts? false
:accounts ["cyberpunky.tumblr.com" "scipunk.tumblr.com"]} ;; Replace Twitter links by Nitter
;; add RSS config to follow feeds :nitter-urls? false
:rss {"Hacker News" "https://hnrss.org/newest" ;; accounts you wish to mirror
"r/Clojure" "https://www.reddit.com/r/clojure/.rss"} :accounts ["arstechnica" "WIRED"]}
:mastodon {:access_token "XXXX" :target {:target-type :mastodon
;; account number you see when you log in and go to your profile ;; optional flag specifying wether the name of the account
;; e.g: https://mastodon.social/web/accounts/294795 ;; will be appended in the post, defaults to false
:account-id "XXXX" :append-screen-name? false
:api_url "https://botsin.space/api/v1/" ;; optional visibility flag: direct, private, unlisted, public
;; defaults to public
:visibility "unlisted"
;; optional boolean to mark content as sensitive ;; optional boolean to mark content as sensitive
:sensitive? true :sensitive? true
;; optional boolean defaults to false ;; optional boolean defaults to false
;; only sources containing media will be posted when set to true ;; only sources containing media will be posted when set to true
:media-only? true :media-only? true
;; optional visibility flag: direct, private, unlisted, public
;; defaults to public
:visibility "unlisted"
;; optional limit for the post length ;; optional limit for the post length
:max-post-length 300 :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 ;; optional signature for posts
:signature "#newsbot" :signature "#newsbot"}
;; optionally try to resolve URLs in posts to skip URL shorteners ;; optionally try to resolve URLs in posts to skip URL shorteners
;; defaults to false ;; defaults to false
:resolve-urls? true :resolve-urls? true
;; optional content filter regexes ;; optional content filter regexes
;; any posts matching the regexes will be filtered out ;; any posts matching the regexes will be filtered out
:content-filters [".*bannedsite.*"] :content-filters [".*bannedsite.*"]
;; optional keyword filter regexes ;; optional keyword filter regexes
;; any posts not matching the regexes will be filtered out ;; any posts not matching the regexes will be filtered out
:keyword-filters [".*clojure.*"] :keyword-filters [".*clojure.*"]
;; optional replacements ;; TODO: Description & example missing here
:replacements {"@openSUSE " "@opensuse@fosstodon.org ", :replacements nil}
"@archlinux " "",
"@lolamby " "", {:source {:source-type :rss
"@conservancy " "@conservancy@mastodon.technology ", ;; add RSS config to follow feeds
"@prototypefund " "@PrototypeFund@mastodon.social ", :feeds [["Hacker News" "https://hnrss.org/newest"]
"@coreboot_org " "", ["r/Clojure" "https://www.reddit.com/r/clojure/.rss"]]}
"@OpenTechFund " "", :target {:target-type :mastodon
"@OpenWrtSummit " "", :append-screen-name? false
"@OpenMirage " "", :signature "#rssbot"}
"@debian " "@debian@fosstodon.org ", :resolve-urls? true
"@nixos_org " "", :content-filters [".*bannedsite.*"]
"@lwnnet " "", :keyword-filters [".*clojure.*"]
"@guixhpc" ""} :replacements nil}
;; Replace Twitter links by Nitter
:nitter-urls? false}} {: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
:signature "#tumblrbot"}}
]}