From 87e1bb9c82ad4d7bb6879b1072c77c1a54eaab4e Mon Sep 17 00:00:00 2001 From: Alexey Golub Date: Wed, 12 Sep 2018 21:48:54 +0300 Subject: [PATCH] Created Docker usage instructions (markdown) --- Docker-usage-instructions.md | 74 ++++++++++++++++++++++++++++++++++++ 1 file changed, 74 insertions(+) create mode 100644 Docker-usage-instructions.md diff --git a/Docker-usage-instructions.md b/Docker-usage-instructions.md new file mode 100644 index 0000000..171baac --- /dev/null +++ b/Docker-usage-instructions.md @@ -0,0 +1,74 @@ +The GUI version doesn't work on non-Windows OS. + +**Installing Docker CE** +* [Debian](https://github.com/RenanYudi/DiscordChatExporter/wiki/Docker-usage-instructions#debian) +* [Ubuntu](https://github.com/RenanYudi/DiscordChatExporter/wiki/Docker-usage-instructions#ubuntu) +* [macOS](https://github.com/RenanYudi/DiscordChatExporter/wiki/Docker-usage-instructions#macos) + +**[Using DiscordChatExporter](https://github.com/RenanYudi/DiscordChatExporter/wiki/Docker-usage-instructions#using-discordchatexporter-with-docker)** + +# Installing Docker CE +## [Debian](https://docs.docker.com/install/linux/docker-ce/debian/) + **OS Requirements** + - Debian 8 (64-bit) or latest version + +**Installation** + +1. Open Terminal, type `su` and hit ENTER. You'll be prompted for your password. +2. `apt update` +3. `apt -y install sudo apt-transport-https ca-certificates curl gnupg2 software-properties-common` +4. `curl -fsSL https://download.docker.com/linux/debian/gpg | apt-key add -` +5. `add-apt-repository + "deb [arch=amd64] https://download.docker.com/linux/debian + $(lsb_release -cs) + stable"` +6. `apt update` +7. `apt -y install docker-ce` +8. Verify if Docker was installed successfully by running the `hello-world` image: + - `docker run hello-world` + +## [Ubuntu](https://docs.docker.com/install/linux/docker-ce/ubuntu/) + **OS Requirements** + - Ubuntu 16 (64-bit) or latest version + +**Installation** + +1. Open Terminal and type `sudo apt update` +2. `sudo apt -y install apt-transport-https ca-certificates curl software-properties-common` +3. `curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -` +4. `sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable"` +5. `sudo apt update` +6. `sudo apt -y install docker-ce` +7. Verify if Docker was installed successfully by running the `hello-world` image: + - `docker run hello-world` + +## [macOS](https://docs.docker.com/docker-for-mac/install/) + **System Requirements** + - 2010 Mac hardware or newer + - macOS El Capitan 10.11 or latest version + - 4 GB of RAM + +**Installation** + +1. [Download latest Docker CE macOS here](https://download.docker.com/mac/stable/Docker.dmg) +2. Open `Docker.dmg`, then drag `Docker.app` to the Applications folder + +![](https://i.imgur.com/Yyi9eFx.png) + +3. Open `Docker` on your Applications folder and follow the instructions on-screen +4. The whale (![](https://docs.docker.com/docker-for-mac/images/whale-x.png)) in the status bar indicates that Docker is running. + +![](https://i.imgur.com/VvbKj7p.png) + +![](https://i.imgur.com/tgTDzlL.png) + +5. Verify if Docker was successfully installed by searching and opening `Terminal.app` in Spotlight (⌘+SPACE), and pasting: + - `docker run hello-world` + +# Using DiscordChatExporter with Docker +Open Terminal, replace `TOKEN` and `CHANNEL`, and execute this command to export the chat: + +`sudo docker run "-v${PWD}:/a" simnalamburt/discordchatexporter export -t TOKEN -c CHANNEL` + +## +Credits to [@simnalamburt](https://github.com/simnalamburt) and [@RenanYudi](https://github.com/RenanYudi) \ No newline at end of file