Anon/YandereLewdBot
Archived
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Updated config docs

Browse Source
This commit is contained in:
Anon 2023-05-14 23:29:33 -07:00
parent ffa6b3c5d2
commit 1ccb63a6e2
1 changed files with 2 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/configuration.md
View File

@ -37,11 +37,7 @@ Paste the generated credentials from `create_app.py` in the fields below.
## settings_behavior ## settings_behavior
This is the main configuration setting for the bot. This is the main configuration setting for the bot.
**`master_list:`** The master list(s) for the bot to post from. This should be a GNU formatted hash file. If multiple lists are specified they will be concatenated in order. **`master_list:`** The master list for the bot to post from. This should be a standard text file with a list of valid image paths. A value of `-` will read from stdin.
**`master_blacklist_r:`** The master blacklist(s) to be *read* when the bot starts. This should be a GNU formatted hash file. All hashes and paths specified in this setting will be blacklisted when the bot initializes and will not be posted.
**`master_blacklist_w:`** The master file(s) to *write* to when the bot makes a successful post. This will be a GNU formatted hash file.
**`max_size:`** The max upload size (in bytes). Files that are over will be excluded from posting. Set this to `None` if there is no limit (not recommended). If you find that the bot is continuously attempting to repost a post that is failing, and the connection is timing out, it usually signifies that you are attempting to upload a large file over a slow connection and getting dropped from the server. Reducing this value should fix the issue. **`max_size:`** The max upload size (in bytes). Files that are over will be excluded from posting. Set this to `None` if there is no limit (not recommended). If you find that the bot is continuously attempting to repost a post that is failing, and the connection is timing out, it usually signifies that you are attempting to upload a large file over a slow connection and getting dropped from the server. Reducing this value should fix the issue.
@ -57,7 +53,7 @@ This is the main configuration setting for the bot.
**`retry_seconds:`** The time to wait between post attempts (in seconds). **`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. **`multi_media_ext:`** Files ending with this extension will be treated as a multi-upload list. All valid paths 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.
**`content_type:`** The content type of the post ('text/plain' (default), 'text/markdown', 'text/html', 'text/bbcode'). **This bot has only been tested with `'text/plain'` and `'text/markdown'`**. **`content_type:`** The content type of the post ('text/plain' (default), 'text/markdown', 'text/html', 'text/bbcode'). **This bot has only been tested with `'text/plain'` and `'text/markdown'`**.
@ -69,11 +65,6 @@ This is the main configuration setting for the bot.
**`debug:`** Set this to true for testing. This will prevent Yandere Lewd Bot from logging into the mastodon instance and asking for your encryption password (meaning that nothing will actually get posted to your account, but it will still do everything else). **`debug:`** Set this to true for testing. This will prevent Yandere Lewd Bot from logging into the mastodon instance and asking for your encryption password (meaning that nothing will actually get posted to your account, but it will still do everything else).
**NOTE:** `master_list`, `master_blacklist_r`, and `master_blacklist_w` all take a tuple() of str(). Please see below for formatting help.
> To specify multiple files: `master_blacklist_r: ("./md5/blacklist.txt", "./md5/master_blacklist.txt"),`
> To specify a single file: `master_blacklist_r: ("./md5/blacklist.txt",),`
> To specify no file: `master_blacklist_r: tuple(),`
## settings_time ## settings_time
Time localization settings. Mostly unimplemented. Time localization settings. Mostly unimplemented.