From 750fd69a50da764cccc2fb15803c47e2f72834e1 Mon Sep 17 00:00:00 2001 From: Oleksii Holub <1935960+Tyrrrz@users.noreply.github.com> Date: Sat, 11 Nov 2023 17:10:43 +0200 Subject: [PATCH] Update Docker instructions --- .docs/Docker.md | 17 +++++++---------- 1 file changed, 7 insertions(+), 10 deletions(-) diff --git a/.docs/Docker.md b/.docs/Docker.md index 848eabc..8c8c658 100644 --- a/.docs/Docker.md +++ b/.docs/Docker.md @@ -2,7 +2,8 @@ Docker distribution of DiscordChatExporter provides a way to run the app in a virtualized and isolated environment. Due to the nature of Docker, you also don't need to install any prerequisites otherwise required by DCE. -Note that only the CLI flavor of DiscordChatExporter is available for use with Docker. +> **Note**: +> Only the CLI flavor of DiscordChatExporter is available for use with Docker. ## Pulling @@ -14,9 +15,9 @@ 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`: 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 automation scenarios. +- `stable` — latest stable version release. This tag is updated with each release of a new project version. Recommended for personal use. +- `x.y.z` (e.g. `2.30.1`) — specific stable version release. This tag is pushed when the corresponding version is released and never updated thereafter. Recommended for use in automation scenarios. +- `latest` — latest (potentially unstable) build. This tag is updated with each new commit to the `master` branch. Not recommended, unless you want to test a new feature that has not been released in a stable version yet. You can see all available tags [here](https://hub.docker.com/r/tyrrrz/discordchatexporter/tags?ordering=name). @@ -34,13 +35,13 @@ To export a channel: docker run --rm -v /path/on/machine:/out tyrrrz/discordchatexporter:stable export -t TOKEN -c CHANNELID ``` -If you want colored output and real-time progress reporting, pass the `-it` (interactive) option: +If you want colored output and real-time progress reporting, pass the `-it` (interactive + pseudo-terminal) option: ```console docker run --rm -it -v /path/on/machine:/out tyrrrz/discordchatexporter:stable export -t TOKEN -c CHANNELID ``` -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. +The `-v /path/on/machine:/out` option 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. > **Note**: > If you are running SELinux, you will need to add the `:z` option after `/out`, e.g.: @@ -65,7 +66,3 @@ To get your Token and Channel IDs, please refer to [this page](https://github.co DiscordChatExpoter CLI accepts the `DISCORD_TOKEN` environment variable as a fallback for the `--token` option. You can set this variable 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](https://docs.docker.com/engine/reference/commandline/run/#set-environment-variables--e---env---env-file) for more information. - -## Permission issues with Linux hosts - -When bounding volumes between the container and the host, files mirrored from the Docker container will be owned by the Docker user (in most setups this is `root`). Please refer to this [issue comment](https://github.com/Tyrrrz/DiscordChatExporter/issues/800#issuecomment-1030471970) for instructions on how to override this behavior.