mirrors/DiscordChatExporter
1
0
Fork 0
mirror of https://github.com/Tyrrrz/DiscordChatExporter.git synced 2025-05-27 13:14:17 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Clean up the docs more

Browse source
This commit is contained in:
Tyrrrz 2023-01-27 09:59:02 +02:00
parent 7e2c78eabf
commit 374c7af48d
11 changed files with 215 additions and 219 deletions
Download patch file Download diff file Expand all files Collapse all files

70
.docs/Scheduling-Linux.md
View file

@ -4,13 +4,14 @@ Make sure you already have **DiscordChatExporter.CLI** and **.NET Core** properl
You can use Cron on macOS, but [this method](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/scheduling-MacOS.md) is preferred.
#
---
**1.** Open Terminal and create a new text file with `nano /path/to/DiscordChatExporter/cron.sh`<br/>
1. Open Terminal and create a new text file with `nano /path/to/DiscordChatExporter/cron.sh`
> For beginners: You can't use your mouse in nano, use the arrow keys to control the cursor (caret).
> **Note**:
> You can't use your mouse in nano, use the arrow keys to control the cursor (caret).
**2.** Paste the following into the text file:
2. Paste the following into the text file:
```bash
#!/bin/bash
@ -63,51 +64,49 @@ fi
exit 0
```
**3.** Replace:
3. Replace:
`tokenhere` with your [Token](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Token-and-IDs.md).
- `tokenhere` with your [Token](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Token-and-IDs.md).
- `channelhere` with a [Channel ID](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Token-and-IDs.md).
- `dceFOLDERpathhere` with DCE's **directory path** (e.g. `/path/to/folder`, NOT `/path/to/folder/DiscordChatExporter.dll`).
- `filenamehere` with the exported channel's filename, without spaces.
- `dirhere` with the export directory (e.g. /home/user/Documents/Discord\ Exports).
- `formathere` with one of the available export formats.
`channelhere` with a [Channel ID](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/.docs/Token-and-IDs.md).
> **Note**:
> Remember to escape spaces (add `\` before them) or to quote (") the paths (`"/home/my user"`)!
`dceFOLDERpathhere` with DCE's **directory path** (e.g. `/path/to/folder`, NOT `/path/to/folder/DiscordChatExporter.dll`).
> **Note**:
> To save, hold down CTRL and then press O, if asked for a filename, type it and press ENTER. Hit CTRL+X to exit the text editor.
> [Check out this page](https://wiki.gentoo.org/wiki/Nano/Basics_Guide) if you want to know more about nano.
`filenamehere` with the exported channel's filename, without spaces.
4. Make your script executable with `chmod +x /path/to/DiscordChatExporter/cron.sh`
`dirhere` with the export directory (e.g. /home/user/Documents/Discord\ Exports).
5. Let's edit the cron file. If you want to run the script with your user privileges, edit it by running `crontab -e`. If you want to run the script as root, edit it with `sudo crontab -e`. If this is your first time running this command, you might be asked to select a text editor. Nano is easier for beginners.
`formathere` with one of the available export formats.
6. Add the following to the end of the file `* * * * * /path/to/DiscordChatExporter/cron.sh >/tmp/discordchatexporter.log 2>/tmp/discordchatexportererror.log`. Don't forget to replace the `/path/to/DiscordChatExporter/cron.sh`!
**Remember to escape spaces** (add `\` before them) or to quote (") the paths (`"/home/my user"`)!<br/>
> For beginners: To save, hold down CTRL and then press O, if asked for a filename, type it and press ENTER. Hit CTRL+X to exit the text editor.<br/> > [Check out this page](https://wiki.gentoo.org/wiki/Nano/Basics_Guide) if you want to know more about nano.
**4.** Make your script executable with `chmod +x /path/to/DiscordChatExporter/cron.sh`
**5.** Let's edit the cron file. If you want to run the script with your user privileges, edit it by running `crontab -e`. If you want to run the script as root, edit it with `sudo crontab -e`.<br/>
If this is your first time running this command, you might be asked to select a text editor. Nano is easier for beginners.
**6.** Add the following to the end of the file `* * * * * /path/to/DiscordChatExporter/cron.sh >/tmp/discordchatexporter.log 2>/tmp/discordchatexportererror.log`<br/>
Don't forget to replace the `/path/to/DiscordChatExporter/cron.sh`!
> 💡 Tip: If you don't want logs to be created, replace both `/tmp/discordchatexporter.log` with `/dev/null`
> **Note**:
> If you don't want logs to be created, replace both `/tmp/discordchatexporter.log` with `/dev/null`.
Then replace the \*s according to:
![](https://i.imgur.com/RY7USM6.png)
#
---
**Examples**<br/>
If you want to execute the script at minute 15 of every hour: `15 * * * *`<br/>
Every 30 minutes `*/30 * * * *`<br/>
Everyday at midnight `0 0 * * *`<br/>
Everyday at noon `0 12 * * *`<br/>
Everyday at 3, 4 and 6 PM `0 15,16,18 * * *`<br/>
Every Wednesday at 9 AM `0 9 * * 3`
**Examples**:
- If you want to execute the script at minute 15 of every hour: `15 * * * *`
- Every 30 minutes `*/30 * * * *`
- Every day at midnight `0 0 * * *`
- Every day at noon `0 12 * * *`
- Every day at 3, 4 and 6 PM `0 15,16,18 * * *`
- Every Wednesday at 9 AM `0 9 * * 3`
Verify your cron time [here](https://crontab.guru).
#
---
**Extra information**
@ -115,12 +114,13 @@ The week starts on Sunday. 0 = SUN, 1 = MON ... 7 = SUN.
Be aware that if you set the day to '31', the script will only run on months that have the 31st day.
> 💡 Tip: [Learn more about running a cron job on the last day of the month here](https://stackoverflow.com/questions/6139189/cron-job-to-run-on-the-last-day-of-the-month) (expert).
> **Note**:
> [Learn more about running a cron job on the last day of the month here](https://stackoverflow.com/questions/6139189/cron-job-to-run-on-the-last-day-of-the-month) (expert).
The default filename for the exported channel is `YYYY-MM-DD-hh-mm-ss-yourfilename`. You can change it if you'd like.
Don't forget to update your token in the script after it has been reset!
#
---
Special thanks to [@Yudi](https://github.com/Yudi)