update README

master
Benjamin Schieder 2017-04-23 20:51:30 +01:00
parent ea96e62f66
commit 0ccef4136d
2 changed files with 19 additions and 4 deletions

View File

@ -24,3 +24,18 @@ Example configuration for Apache:
Finally, copy the file ``rsstootalizer.conf.example.json`` to ``rsstootalizer.conf.json`` and adapt to your setup and run ``./update_db.pl`` to create your tables.
Now you can log in to your very own instance of RSSTootalizer!
## Usage
After logging in, you need to Add a new feed. Enter its complete URL and click on "Add Feed". All current entries will be pulled and marked as posted, that means the current entries in the feed are not posted.
Click on "Edit" to edit the feed settings. You will need to add at least one "Whitelist" filter or no entries will be ever be published. Also, you can change the format of the Toot. It would be nice if you kept the ``#RSSTootalizer`` tag, but it's by no means required. Then click "Save filters" to save them.
At the top of the Edit page, you see a button "Show raw entries". All current entries (at the time the page loaded) will be shown and color-coded. If they are red, they would not get posted with the current filterset, if they are green, they would get posted. Use this functionality to validate your filters. These codes are not live updated, you need to press "Save filters" in between changes.
After this is done, go back to your ``Dashboard`` and click on ``Enable`` to enable processing the feed. Then post new stuff to your RSS feed and watch the update!
## Pulling Twitter feeds
Personally, I use https://twitrss.me/ to pull my twitter feed into RSSTootalizer.

View File

@ -1,13 +1,13 @@
{
"mysql": {
"host": "mysql.example.com",
"database": "tweetodon",
"user": "tweetodon",
"database": "rsstootalizer_production",
"user": "rsstootalizer",
"pass": "secret123"
},
"app": {
"client_name": "RSSTootalizer privatehosted",
"redirect_uris": "https://www.example.com/cgi-bin/tweetodon/callback.pl",
"website": "https://www.example.com/cgi-bin/tweetodon/index.pl?mode=About"
"redirect_uris": "https://www.example.com/cgi-bin/rsstootalizer/callback.pl",
"website": "https://www.example.com/cgi-bin/rsstootalizer/index.pl?mode=About"
}
}