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

Updated to reflect scheduling posts with cron

Browse Source
This commit is contained in:
Anon 2022-10-09 13:05:40 -07:00
parent 7b18d525d1
commit d6c851b1f2
2 changed files with 32 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
README.md
View File

@ -52,7 +52,6 @@ cd CreatePleromaApp/
# Follow the interactive prompts. # Follow the interactive prompts.
``` ```
If you did everything correctly you should see `Success! :)` at the end of the terminal, as well as your credentials in the format below: If you did everything correctly you should see `Success! :)` at the end of the terminal, as well as your credentials in the format below:
```text ```text
settings_server = OrderedDict([ settings_server = OrderedDict([
@ -68,10 +67,10 @@ settings_reminder = "09/20/2020 02:58PM"
settings_encrypt = { settings_encrypt = {
"encrypt": False, "encrypt": False,
"salt": "", "salt": "",
"keyfile": None
} }
``` ```
If you used encryption, everything in the `settings_server` dictionary will be encrypted and you will have to enter your password every time you start the bot. Copy and paste these values from the terminal into your `src/cfg.py` file. **Make sure you paste over or delete the placeholder values with the same names.** If you used encryption, everything in the `settings_server` dictionary will be encrypted. If you used encryption and did not specify a keyfile, you will have to enter your password every time you start the bot. Copy and paste these values from the terminal into your `src/cfg.py` file. **Make sure you paste over or delete the placeholder values with the same names.**
## Posting ## Posting
To begin posting: To begin posting:
@ -80,7 +79,6 @@ To begin posting:
- Enter your password if you encrypted your OAuth tokens. - Enter your password if you encrypted your OAuth tokens.
- If you symlinked the file in the [Installing](#installing) section you can simply run `miraiNikkiBot` instead of changing directories and starting the bot with `./run.sh` - If you symlinked the file in the [Installing](#installing) section you can simply run `miraiNikkiBot` instead of changing directories and starting the bot with `./run.sh`
- If everything worked correctly, you should see your first image posted to your account. - If everything worked correctly, you should see your first image posted to your account.
- Hit Ctrl+C to stop the bot.
- Keep in mind that the bot's default visibility setting is set to unlisted for testing. You may want to update it to public. - Keep in mind that the bot's default visibility setting is set to unlisted for testing. You may want to update it to public.
# Donate # Donate
@ -89,29 +87,25 @@ XMR: 493HynLQA4z71b3j9ZDXRNQudpdFW8GxeBGD8ahRctKn97RRurMVd35DqVqdAdjv68TcXTJWUwm
BAT: [Basic Attention Token](https://basicattentiontoken.org/) BAT: [Basic Attention Token](https://basicattentiontoken.org/)
# Useful Tips # Useful Tips
## Installing Screen ## Scheduling posts with cron
Most likely, you will want this bot to run over a long period of time. It is probably best to install the `screen` package for your distro so you don't have to have a terminal window constantly open (especially if you are running it from a remote machine such as a Raspberry Pi or server). Most likely you will want this bot to run over a long period of time. There are a several ways to automate calling a script at regular intervals on Linux. For brevity I will be covering the cron way.
First off, install cron if it's not already installed:
``` ```
sudo pacman -Syu sudo pacman -Syu
sudo pacman -S --needed screen sudo pacman -S --needed cronie
sudo systemctl enable cronie
# Screen cheatsheet sudo systemctl start cronie
# To create a new screen session named 'miraiNikkiBot'
screen -S miraiNikkiBot
# To detach from the screen session
Ctrl+a d
# To reconnect to the screen session
screen -r miraiNikkiBot
# List screen sessions
screen -ls
# Kill the screen session
Ctrl+a k y
# Scroll back
Ctrl+a ESC Page Up
# Cancel scroll back
ESC
``` ```
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 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.
## Quickly Create Configuration Files ## Quickly Create Configuration Files
Configuration files for Mirai Nikki Bot are just python files. Because of this we can easily create multiple configurations by importing the main configuration file, and overriding the values we need. This is useful for creating holiday and debug configurations without needing to create a new configuration file from scratch. Configuration files for Mirai Nikki Bot are just python files. Because of this we can easily create multiple configurations by importing the main configuration file, and overriding the values we need. This is useful for creating holiday and debug configurations without needing to create a new configuration file from scratch.
``` ```

24
docs/configuration.md
View File

@ -39,6 +39,8 @@ Paste the generated credentials from `create_app.py` in the fields below.
**`salt:`** The salt value generated by `create_app.py` **`salt:`** The salt value generated by `create_app.py`
**`keyfile:`** The keyfile used for decryption.
## settings_behavior ## settings_behavior
This is the main configuration setting for the bot. This is the main configuration setting for the bot.
@ -46,11 +48,11 @@ This is the main configuration setting for the bot.
**`feature_set:`** The feature set of the instance you are connecting to ('mainline', 'fedibird', or 'pleroma'). **This bot has only been tested with 'pleroma'.** **`feature_set:`** The feature set of the instance you are connecting to ('mainline', 'fedibird', or 'pleroma'). **This bot has only been tested with 'pleroma'.**
**`sleep_seconds:`** The time between posts (in seconds)
**`uploads_per_post:`** The number of times the bot should post after `sleep_seconds` **`uploads_per_post:`** The number of times the bot should post after `sleep_seconds`
**`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. **`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 to wait between post attempts (in seconds).
**`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'`**.
@ -61,19 +63,19 @@ This is the main configuration setting for the bot.
**`debug:`** Set this to true for testing. This will prevent Mirai Nikki 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 Mirai Nikki 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).
## settings_time ## 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.
**`datetime:`** A custom time to be printed by the bot if ${datetime} substitution is used in the profile output path. **`datetime:`** A custom time to be printed by the bot if ${datetime} substitution is used in the profile output path.
@ -93,7 +95,7 @@ Below is an explanation of each keyword:
* **`skip:`** A tuple of tuples of time ranges to skip. * **`skip:`** A tuple of tuples of time ranges to skip.
* **`nsfw:`** A tuple of tuples of time ranges to mark as sensative (nsfw) * **`nsfw:`** A tuple of tuples of time ranges to mark as sensitive (nsfw)
* **`output_name:`** The output path of the string. This string can include the following shell-like variables that the bot will automatically substitute: * **`output_name:`** The output path of the string. This string can include the following shell-like variables that the bot will automatically substitute: