diff --git a/README.md b/README.md index 8f56b40..68ac9a0 100644 --- a/README.md +++ b/README.md @@ -111,7 +111,7 @@ sudo systemctl start cronie Next, run the following commands: - `crontab -e` - `25,55 * * * * /absolute/path/to/run.sh >> "/absolute/path/to/log.txt" 2>&1` - - Modify the paths above to suit your preferances + - Modify the paths above to suit your preferences - Save and exit If you followed the steps above the cron job should run every 30 minutes at 25 and 55 minutes past the hour. Tail the log file to ensure it's working correctly. diff --git a/docs/configuration.md b/docs/configuration.md index 5f0d0e8..7bb7ec8 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -53,9 +53,9 @@ This is the main configuration setting for the bot. **`uploads_per_post:`** The number of times the bot should post after `sleep_seconds` -**`max_errors:`** The max consecutive posting errors that should occur before the bot gives up and exits. This usually indicates a temporary problem with the remote server, however if the bot repetedly fails, and the server is up, it probobly means the image is too large to upload. Try reducing the `max_size` variable if this happens. Your image may also be in a format that the remote server rejects, in which case the post should be added to the master blacklist. +**`max_errors:`** The max consecutive posting errors that should occur before the bot gives up and exits. This usually indicates a temporary problem with the remote server, however if the bot repeatedly fails, and the server is up, it probably means the image is too large to upload. Try reducing the `max_size` variable if this happens. Your image may also be in a format that the remote server rejects, in which case the post should be added to the master blacklist. -**`retry_seconds:`** The time the bot should wait before attempting to re-upload a post that failed (in seconds). This value is ignored if the bot experiences a FileNotFoundError (the file was deleted after the bot was started) or encounters a 413 error (file upload size is too large). In either of the two cases the bot will continue posting the next image in the list. +**`retry_seconds:`** The time to wait between post attempts (in seconds). **`multi_media_ext:`** Files ending with this extension will be treated as a multi-upload list. All GNU formatted hashes contained within will be uploaded in a single post when picked by the bot. Setting this value to `None` or `False` will disable this behavior. @@ -81,19 +81,19 @@ This is the main configuration setting for the bot. > To specify no file: `master_blacklist_r: tuple(),` ## settings_time -Time localization settings. +Time localization settings. Mostly unimplemented. -**`time_format:`** This is used to schedule posts using the `-t` switch. Referenced in `set_pretimer_hour()` +**`time_format:`** Time format. -**`time_format_seconds:`** Unused. Should be the same as `time_format` but with a resolution in seconds. +**`time_format_seconds:`** Should be the same as `time_format` but with a resolution in seconds. -**`date_format:`** This is used to schedule posts using the `-d` switch. Referenced in `set_pretimer_day()` +**`date_format:`** Date format. -**`long_date_format:`** Time and date format. `settings_encrypt["reminder"]` Should be in this format. Referenced in `print_header_stats()` and `_sanity_warnings()` +**`long_date_format:`** Time and date format. `settings_encrypt["reminder"]` Should be in this format. CreatePleromaApp will use this value if available. -**`long_date_seconds_format:`** Unused. Should be the same as `long_date_format` but with a resolution in seconds. +**`long_date_seconds_format:`** Should be the same as `long_date_format` but with a resolution in seconds. -**`long_date_week:`** The same as `long_date_format` but with the day of the week specified. Referenced in `print_header_stats()` +**`long_date_week:`** The same as `long_date_format` but with the day of the week specified. ## settings_post Configure Yandere Lewd Bot profiles. In the default configuration, images are sorted by safe and nsfw profiles. This means that all 'safe' images should be located in `./rsc/safe/*` and all 'nsfw' images should be located in `./rsc/nsfw/*`. The bot will apply profiles based on it's file path using [Unix filename pattern matching](https://docs.python.org/3/library/fnmatch.html).