From e74982d5a46c3f912591a32f9ea77e0a0c82ecae Mon Sep 17 00:00:00 2001 From: simp Date: Mon, 20 Jan 2025 18:02:23 -0500 Subject: [PATCH] readme update --- README.md | 43 +++++++++++++++++++++++-------------------- 1 file changed, 23 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index b202151..00cd957 100755 --- a/README.md +++ b/README.md @@ -8,13 +8,13 @@ The webapp displays a page that shows the ping times and last seen for each feed ### Todo The bot was built first, and the webapp built around the irc bot. It'd be better if they were seperate with the webapp functioning independently and puppeting the ircbot through api, i think. -cap per feed per update: simple max of x number new posts on the irc bot so its not a wall of text +[DONE] **Cap per feed per update:** simple max of x number new posts on the irc bot so its not a wall of text. Feeds are capped at 5 in IRC for the live bot now. -i2p urls: The feed links are all over the place, some point to clearnet, or localhost, or not the post. Have the links point to valid i2p only links. +[WIP] **I2p urls:** The feed links are all over the place, some point to clearnet, or localhost, or not the post. Have the links point to valid i2p only links. Localhost is corrected and some site specific corrections. -cleanup, a lot has been copied from other projects, it's messy +[X] **Cleanup:** a lot has been copied from other projects, it's messy -Optimization: this could be leaner, it runs around 85MB now. If we keep the feeds in memory it can run faster, it's not doing that now. +[X] **Optimization:** this could be leaner, it runs around 85MB now. If we keep the feeds in memory it can run faster, it's not doing that now. ### Install If for some reason you want to install this, that's probably a mistake on your part but, clone the repo using your i2p http proxy, cd into it, then make a python venv. @@ -51,26 +51,29 @@ Listens in on the socket on `/path/to/newsbot/newsbot.sock` so make sure you cha ### Settings Most settings are in website.ini file -[proxy] -`hostname = 127.0.0.1` -`http_tunnel = 4444` setup a seperate http tunnel under java to close after idling x minutes and open with new keys on activity + [proxy] + hostname = 127.0.0.1 + http_tunnel = 4444 - setup a seperate http tunnel under java to close after idling x minutes and open with new keys on activity -[rss] -`news_bot = botname` -`news_pass = botpassword` -`news_irc_port = 6667` -`news_rss_flask_port = 5001` port to serve flask. not used if using wsgi like gunicorn -`news_rss_ah = addresshelperlink` -`news_email = nobody@mail.i2p` -`auth_users = nobody, anothernick` irc nicks authed to do \$admin commands -`channel = #i2p-news` original channel to join, changed with \$admin main_channel #channel1 #channel2 or \$admin join/part #channel -`primary = nobody` sends msgs to this nicks memoserv on admin commands -`gunicorn_port = 5000` for running production with wsgi + [rss] + news_bot = botname + news_pass = botpassword + news_irc_port = 6667 + news_rss_flask_port = 5001 - port to serve flask. not used if using wsgi like gunicorn + news_rss_ah = addresshelperlink + news_email = nobody@mail.i2p + auth_users = nobody, anothernick - irc nicks authed to do $admin commands + channel = #i2p-news - original channel to join, changed with $admin main_channel #channel1 #channel2 or $admin join/part #channel + primary = nobody - sends msgs to this nicks memoserv on admin commands + gunicorn_port = 5000 - for running production with wsgi ### Add feeds feed list is `rsslist.txt`, format is url category categories: news, blog, forum, developer, torrents example: -`http://zzz.i2p/topics.rss forum` -Then do `$admin refresh` in irc \ No newline at end of file + http://zzz.i2p/topics.rss forum + +Then in IRC do: + + $admin refresh \ No newline at end of file