masto-rss-ex/README.md

21 lines
913 B
Markdown
Raw Normal View History

2023-12-05 02:11:43 +00:00
# Masto-rss
2023-12-05 02:38:37 +00:00
A simple Mastodon bot written in python that posts updates from an RSS feed to a Mastodon account.
2023-12-05 02:11:43 +00:00
This project is meant to be built to a docker container, so all of the options need to be set as environment variables:
2023-12-05 02:39:10 +00:00
2023-12-05 02:48:36 +00:00
MASTODON_CLIENT_ID = Mastodon client ID
2023-12-05 02:39:10 +00:00
2023-12-05 02:48:36 +00:00
MASTODON_CLIENT_SECRET = Mastodon client secret
2023-12-05 02:39:10 +00:00
2023-12-05 02:48:36 +00:00
MASTODON_ACCESS_TOKEN = Mastodon access token
2023-12-05 02:39:10 +00:00
2023-12-05 02:48:36 +00:00
MASTODON_INSTANCE_URL = Mastodon instance URL
2023-12-05 02:39:10 +00:00
2023-12-05 02:48:36 +00:00
RSS_FEED_URL = URL of RSS/xml feed
2023-12-05 02:39:10 +00:00
2024-01-03 10:28:31 +00:00
TOOT_VISIBILITY = 'public', 'unlisted', 'private', or 'direct'
2023-12-05 02:38:37 +00:00
The best way to use this project is by using [its docker container](https://hub.docker.com/r/amitserper/masto-rss)
2023-12-06 18:00:04 +00:00
When using docker, make a bind mount between /state on the container to whatever directory you want on your machine in order to keep the state of the feeds that were already posted
2023-12-05 02:39:10 +00:00
![image](https://github.com/aserper/masto-rss/actions/workflows/masto-rss.yml/badge.svg)