calvin.erfmann/DiscordChatExporter
1
0
Fork 0
mirror of https://github.com/Tyrrrz/DiscordChatExporter.git synced 2026-02-19 15:57:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updated Docker usage instructions (markdown)

Oleksii Holub
2022-07-10 02:38:23 -07:00
parent f393919e9f
commit 5844b54f5f
1 changed files with 9 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
Docker-usage-instructions.md

@@ -13,7 +13,7 @@ docker pull tyrrrz/discordchatexporter:stable
Note the `:stable` tag. DiscordChatExporter images are tagged according to the following patterns:
- `stable`: Latest stable version release and maps to the latest GitHub release. This tag is updated with release of each new version. Recommended for personal use.
- `latest`: Build from latest commit and maps to the latest CI build on GitHub. This tag is updated with each new commit to `master` branch. Not recommended for everyday use, but you can use it if you want to try out some features that haven't been officially released yet.
- `latest`: Built from the latest commit and maps to the latest CI build on GitHub. This tag is updated with each new commit to `master` branch. Not recommended for everyday use, but you can use it if you want to try out some features that haven't been officially released yet.
- `x.y.z` (e.g. `2.30.1`): Fixed version release and maps to the corresponding tag on GitHub. This tag is never updated once that version has been released. Recommended for use in various automation scenarios.
You can see all available tags [here](https://hub.docker.com/r/tyrrrz/discordchatexporter/tags?page=1&ordering=name).
@@ -29,29 +29,29 @@ docker run --rm tyrrrz/discordchatexporter:stable
To export a channel:
```
docker run --rm -v /path/on/machine:/app/out tyrrrz/discordchatexporter:stable export -t TOKEN -c CHANNELID
docker run --rm -v /path/on/machine:/out tyrrrz/discordchatexporter:stable export -t TOKEN -c CHANNELID
```
If you want colored output, real-time progress reporting, and some other stuff, pass `-it` (interactive) option:
```
docker run --rm -it -v /path/on/machine:/app/out tyrrrz/discordchatexporter:stable export -t TOKEN -c CHANNELID
docker run --rm -it -v /path/on/machine:/out tyrrrz/discordchatexporter:stable export -t TOKEN -c CHANNELID
```
Note the `-v /path/on/machine:/app/out` option which instructs Docker to bind the `/app/out` directory inside the container to a path on your host machine. Replace `/path/on/machine` with the directory you want the files to be saved at.
Note the `-v /path/on/machine:/out` option, which instructs Docker to bind the `/out` directory inside the container to a path on your host machine. Replace `/path/on/machine` with the directory you want the files to be saved at.
**If you are running SELinux, you will need to add the `:z` option after `/app/out`, e.g.:**
**If you are running SELinux, you will need to add the `:z` option after `/out`, e.g.:**
```
docker run --rm -v /path/on/machine:/app/out:z tyrrrz/discordchatexporter:stable export -t TOKEN -c CHANNELID
docker run --rm -v /path/on/machine:/out:z tyrrrz/discordchatexporter:stable export -t TOKEN -c CHANNELID
```
For more information, refer to the [Docker docs SELinux labels for bind mounts page](https://docs.docker.com/storage/bind-mounts/#configure-the-selinux-label).
You can also use the current working directory as the output directory by specifying:
* `-v $PWD:/app/out` in Mac/Linux
* `-v $pwd.Path:/app/out` in PowerShell
* `-v $PWD:/out` in Mac/Linux
* `-v $pwd.Path:/out` in PowerShell
For more information, please refer to the [Dockerfile](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/Dockerfile) and [Docker documentation](https://docs.docker.com/engine/reference/run/).<br>
To get your Token and Channel IDs, please refer to [this page](https://github.com/Tyrrrz/DiscordChatExporter/wiki/Obtaining-Token-and-Channel-IDs).
@@ -93,7 +93,7 @@ mcr.microsoft.com/dotnet/sdk 5.0 72af6071941e 4 days ago
mcr.microsoft.com/dotnet/runtime 3.1 6229bebd5a11 4 days ago 197MB
```
Among these, two images (`tyrrrz/discordchatexporter:latest` and `mcr.microsoft.com/dotnet/runtime:3.1`) are required so you may delete the other two images.
Among these, two images (`tyrrrz/discordchatexporter:latest` and `mcr.microsoft.com/dotnet/runtime:3.1`) are required, so you may delete the other two images.
Now you can execute DiscordChatExporter: