diff --git a/Docker-usage-instructions.md b/Docker-usage-instructions.md index 9e6700a..3ac4708 100644 --- a/Docker-usage-instructions.md +++ b/Docker-usage-instructions.md @@ -1,29 +1,30 @@ - ### Pulling +### Pulling + To pull the [latest version](https://hub.docker.com/r/tyrrrz/discordchatexporter): - $ docker pull tyrrrz/discordchatexporter +```$ docker pull tyrrrz/discordchatexporter``` - ### Exporting +This will download the Docker image from the registry to your computer. You can run this command again when a new version is released in order to update. -To export: +_Note: for obvious reasons, only the CLI version is available in Docker._ - $ docker run --rm tyrrrz/discordchatexporter export -t TOKEN -c CHANNEL +### Usage -To export using a Bot Token just add `-b`: +To run the CLI in Docker and render help text: - $ docker run --rm tyrrrz/discordchatexporter export -t TOKEN -c CHANNEL -b +```$ docker run --rm tyrrrz/discordchatexporter``` -To get more options, information about different formats, and real-time progress reporting, use the interactive mode: +To export a channel: - $ docker run --rm -it tyrrrz/discordchatexporter +```$ docker run --rm -v path/on/your/machine:/app/out tyrrrz/discordchatexporter export -t TOKEN -c CHANNEL``` -### File output +If you want colored output, real-time progress reporting, and some other stuff, pass `-it` (interactive) option: -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. +```$ docker run --rm -it -v path/on/your/machine:/app/out tyrrrz/discordchatexporter export -t TOKEN -c CHANNEL``` -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 +Note the `-v path/on/your/machine:/app/out` option which instructs Docker to bind `/app/out` directory inside container to `path/on/your/machine` on your host machine. This is where the exported files are saved, so make sure to specify this option. - $ docker run --rm -v ${PWD}:/app/out tyrrrz/discordchatexporter export -t TOKEN -c CHANNEL +You can also use current working directory as output directory by specifying `-v PWD:/app/out` in Bash or `-v $pwd.Path:/app/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/).