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

Updated Docker usage instructions (markdown)

Yudi
2019-08-07 17:13:33 -03:00
parent 3a595397a3
commit c77bc564b4
1 changed files with 12 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
Docker-usage-instructions.md

@@ -1,7 +1,10 @@
To pull the latest version:
### Pulling
To pull the [latest version](https://hub.docker.com/r/tyrrrz/discordchatexporter):
$ docker pull tyrrrz/discordchatexporter
### Exporting
To export:
$ docker run --rm tyrrrz/discordchatexporter export -t TOKEN -c CHANNEL
@@ -10,15 +13,19 @@ To export using a Bot Token just add `-b`:
$ docker run --rm tyrrrz/discordchatexporter export -t TOKEN -c CHANNEL -b
To get help and real-time progress reporting, use interactive mode:
To get more options, information about different formats, and real-time progress reporting, use the interactive mode:
$ docker run --rm -it tyrrrz/discordchatexporter
When running in Docker, DiscordChatExporter's working directory is `/app/out`. In order to access the exported files, you need to bind the output directory to a directory on your host system.
### File output
When running in Docker, DiscordChatExporter's working directory is `/app/out`. In order to access the exported files, you need to bind the output directory to one on your host system.
In the example below, `-v ${PWD}:/app/out` sets the output to the Terminal's current directory. If you want to export to a specific folder, replace `${PWD}` with a folder's path
$ docker run --rm -v ${PWD}:/app/out tyrrrz/discordchatexporter export -t TOKEN -c CHANNEL
For more information, you can refer to the `Dockerfile` [here](https://github.com/Tyrrrz/DiscordChatExporter/blob/master/Dockerfile).
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/).
##
Special thanks to [@simnalamburt](https://github.com/simnalamburt) (Dockerize) and [@shlagevuk](https://github.com/shlagevuk) (Legacy Script)
Special thanks to [@simnalamburt](https://github.com/simnalamburt) (dockerize) and [@Nimja](https://github.com/nimja) (better instructions)