README.md 1.32 KB
Newer Older
M33's avatar
M33 committed
1
# Radiobot get solar data images from popular hamradio websites and toots to Mastodon
M33's avatar
M33 committed
2

M33's avatar
M33 committed
3
### Usage
M33's avatar
M33 committed
4
python3 radiobot.py [full path to config file] [--with-hashtags OR --without-hashtags]
M33's avatar
M33 committed
5
6

Example
M33's avatar
M33 committed
7
python3 radiobot.py /home/bot/radiobot@my_bot@my_instance.conf --without-hashtags
M33's avatar
M33 committed
8

M33's avatar
M33 committed
9
### Configuration file
M33's avatar
M33 committed
10
11
12
13
The configuration file should be placed in a safe directory (not world or group readable), and contains the instance and authentication credentials.
You must complete the config file and provide authentication credentials to your desired mastodon account.
A sample config file 'radiobot@my_bot@my_instance.conf' is provided as a starting point.

M33's avatar
M33 committed
14
### Authentication methods
M33's avatar
M33 committed
15
16
17
This app support both email and application token authentication.
You are strongly encouraged to create an application with dedicated app id, secret and access token for this bot.
See the "Development" and "New application" pannel in your mastodon account settings.
M33's avatar
M33 committed
18
19
20
21
22
23
24

### Using hashtags
Hashtags are usefull for showing up toots in Mastodon's search results, currently Masdoton
doesn't do full search texts in toots like your average web search engine.
Using specific hashtags to your instance is recommended.
When using well known hashtags (like #CQ, #HAMRADIO) it is strongly advised to keep it low frequency,
to avoid flooding the search results of Operators, and Fediverse users.