From db370c247bdddaf73a12f81389243bd156d51b48 Mon Sep 17 00:00:00 2001 From: Yudi Date: Mon, 26 Apr 2021 09:48:07 -0300 Subject: [PATCH] Formatting --- Docker-usage-instructions.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/Docker-usage-instructions.md b/Docker-usage-instructions.md index bb5c21c..9a11e13 100644 --- a/Docker-usage-instructions.md +++ b/Docker-usage-instructions.md @@ -1,6 +1,6 @@ ### Pulling -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. +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 to update when a new version is released. ``` docker pull tyrrrz/discordchatexporter:stable @@ -16,21 +16,21 @@ To run the CLI in Docker and render help text: ``` 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 ``` -
+
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 ``` -
+
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. @@ -45,9 +45,9 @@ For more information, refer to the [Docker docs SELinux labels for bind mounts p 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). ### Environment variables (advanced) @@ -57,9 +57,9 @@ DCE.CLI accepts environment variables as fallbacks for the `--token` and `--bot` - `DISCORD_TOKEN` to set the token - `DISCORD_TOKEN_BOT` to set whether it's a bot token (`true` or `false`) -You can use these variables either with the `--env` Docker option or with a combination of the `--env-file` Docker option and a `.env` file.
-Please refer to the Docker documentation for more information:
-* [Docker run - Set environment variables](https://docs.docker.com/engine/reference/commandline/run/#set-environment-variables--e---env---env-file)
+You can use these variables either with the `--env` Docker option or with a combination of the `--env-file` Docker option and a `.env` file. +Please refer to the Docker documentation for more information:
+* [Docker run - Set environment variables](https://docs.docker.com/engine/reference/commandline/run/#set-environment-variables--e---env---env-file) ## Special thanks to [@simnalamburt](https://github.com/simnalamburt) (dockerize) and [@Nimja](https://github.com/nimja) (better instructions) \ No newline at end of file