diff --git a/Docker-usage-instructions.md b/Docker-usage-instructions.md index 3ac4708..2cb3b8c 100644 --- a/Docker-usage-instructions.md +++ b/Docker-usage-instructions.md @@ -1,32 +1,45 @@ ### Pulling -To pull the [latest version](https://hub.docker.com/r/tyrrrz/discordchatexporter): +This will download the [Docker image from the registry](https://hub.docker.com/r/tyrrrz/discordchatexporter) to your computer. You can run this command again when a new version is released in order to update. -```$ docker pull tyrrrz/discordchatexporter``` +``` +docker pull tyrrrz/discordchatexporter +``` -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. - -_Note: for obvious reasons, only the CLI version is available in Docker._ +_Note: Only the CLI version is available in Docker._ ### Usage To run the CLI in Docker and render help text: -```$ docker run --rm tyrrrz/discordchatexporter``` +``` +docker run --rm tyrrrz/discordchatexporter +``` +
To export a channel: -```$ docker run --rm -v path/on/your/machine:/app/out tyrrrz/discordchatexporter export -t TOKEN -c CHANNEL``` +``` +docker run --rm -v /path/on/machine:/app/out tyrrrz/discordchatexporter 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/your/machine:/app/out tyrrrz/discordchatexporter export -t TOKEN -c CHANNEL``` +``` +docker run --rm -it -v /path/on/machine:/app/out tyrrrz/discordchatexporter export -t TOKEN -c CHANNELID +``` +
-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. +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. -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. +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 +
-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/). +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/).
+To get your Token and Channel IDs, please refer to [this page](https://github.com/Tyrrrz/DiscordChatExporter/wiki/Obtaining-Token-and-Channel-IDs). ## Special thanks to [@simnalamburt](https://github.com/simnalamburt) (dockerize) and [@Nimja](https://github.com/nimja) (better instructions) \ No newline at end of file