docs/fix: Updated README.md and install.sh

README.md

@@ -15,13 +15,15 @@ The remaining imports should all be part of the standard Python install.
 
 ## Important Notes
 
-As it currently is written, the script uses the hash of the post title to prevent sending duplicates. However, a recent change to check for the publish time was added, only because some feeds are not in reverse chronological order (latest post at top of feed, ie, entry index 0). Because of this, we do actually need to check the publish times. This still needs some testing and things might be a bit broken because of it. If you see any issues please let me know.
-
-Logging was recently enabled. Make sure that the user running the script (especially when using systemd timers) has write access to the /var/log/discorss directory. The app will try and create the directory for you, but if your user doesn't have permissions to create directories in /var/log this will fail and this will probably crash the script as is. I will try and remember to catch that exception and exit gracefully with an error message to stdout. If you want the logs to go somewhere else, just edit the log_dir variable near the top of discorss.py. Choose a directory that makes sense. Unfortunately, as far as I know, the XDG standards don't have an equivalent to the /var/log directory in the user directory, so I wasn't sure what the best default was. In the future, we may switch to logging using systemd and journald directly, though it is nice to have a separate file.
+The logger will try and put the logs in `/var/log/discorss`. Make sure to create this directory and give the user running the script write permissions there. If you want the logs to go somewhere else, just edit the log_dir variable near the top of discorss.py. Choose a directory that makes sense. Unfortunately, as far as I know, the XDG standards don't have an equivalent to the /var/log directory in the user directory, so I wasn't sure what the best default was. In the future, we may switch to logging using systemd and journald directly, though it is nice to have a separate file.
 
 ## How to setup
 
-To configure the script, create ~/.config/discorss/discorss.conf with the following structure:
+Note: see the Automation section below for info about using the `install.sh` script to help get all the files in the right places.
+
+### Config file format
+
+To configure the script, create `~/.config/discorss/discorss.conf` using JSON formatting like this:
 
 ```json
 {
@@ -50,6 +52,13 @@ The offset should only be required if feeds aren't showing up. This is because f
 
 ## Automation
 
+**New**: There is now `install.sh` in the repo which will automatically help you set up both the config file and the systemd unit files for the service and timer, using essentially the exact text below. It will copy them to the user systemd unit folder, `~/.config/systemd/user` and optionally enable the timer. It's a good idea to edit the configuration file at `~/.config/discorss/discorss.conf` and paste in your webhook URLs and add any other feeds you want before starting the timer, unless you can do it really quickly before the next 5 minute spot on the clock :)
+Of course, if it fires with an invalid config, the script will just crash, and you'll probably just have to manually start the timer once the config is fixed, so not a big deal.
+
+_Remember to create `/var/log/discorss` and change it to be writeable by the user running the service!_
+
+### Manual method
+
 To automate feed posting, create a systemd service and timer to execute the script.
 
 Use the command `systemctl --user edit --full --force discorss.service` and then paste in something like this:
@@ -61,13 +70,14 @@ Wants=discorss.timer
 
 [Service]
 Type=oneshot
+TimeoutStartSec=120
 ExecStart=/path/to/discorss.py
 
 [Install]
 WantedBy=default.target
 ```
 
-Make sure to edit the ExecStart to point to the correct location. Then we need a systemd timer to automatically fire the script. Run `systemctl --user edit --full --force discorss.timer` and then paste in this:
+The TimeoutStartSec will catch any issues with the script locking up due to, e.g., DNS failures or RSS feeds being slow/unavailable. 2 minutes should be more than enough time unless you are running hundreds of feeds. Also make sure to edit the ExecStart to point to the correct location. Then we need a systemd timer to automatically fire the script. Run `systemctl --user edit --full --force discorss.timer` and then paste in this:
 ```systemd
 [Unit]
 Description=Timer for DiscoRSS

install.sh

@@ -16,6 +16,7 @@ Wants=discorss.timer
 
 [Service]
 Type=oneshot
+TimeoutStartSec=120
 ExecStart=/home/amr/workspace/python/discorss/discorss.py
 
 [Install]