From 4823ae4d6904f86ad672162ddf65b56d17cefe90 Mon Sep 17 00:00:00 2001 From: Mark Milligan Date: Mon, 29 Aug 2022 16:16:58 -0500 Subject: [PATCH 1/4] chore: add uninstall steps to remove a Coder OSS deployment --- docs/install/uninstall.md | 58 +++++++++++++++++++++++++++++++++++++++ docs/manifest.json | 5 ++++ 2 files changed, 63 insertions(+) create mode 100644 docs/install/uninstall.md diff --git a/docs/install/uninstall.md b/docs/install/uninstall.md new file mode 100644 index 0000000000000..90a8604ddf0ee --- /dev/null +++ b/docs/install/uninstall.md @@ -0,0 +1,58 @@ +# Uninstall + +This article walks you through how to uninstall your Coder server. + +
+

+ Uninstalling Coder with the built-in PostgreSQL database will delete the database engine and database. Consider backing up the database directory if you would like to reuse it with a future installation. This does not apply if you have installed your own PostgreSQL database instance. +

+
+ +To uninstall your Coder server, delete the following directories. + +## Cached Coder releases + +```console +rm -rf ~/.cache/coder +``` + +## The Coder server binary and CLI + +```console +sudo rm /usr/local/bin/coder +``` + +## Coder as a system service configuration + +```console +sudo rm /etc/coder.d/coder.env +``` + +## Coder settings and the optional built-in PostgreSQL database + +> There is a `postgres` directory within the `coderv2` directory that has the +> database engine and database. If you want to reuse the database, consider +> not performing the following step or copying the directory to another +> location + +### macOS + +```console +rm -rf ~/Library/Application\ Support/coderv2 +``` + +### Linux + +```console +rm -rf ~/.config/coderv2 +``` + +### Windows + +```console +C:\Users\USER\AppData\coderv2 +``` + +## Up Next + +- [Learn how to configure Coder](./configure.md). diff --git a/docs/manifest.json b/docs/manifest.json index 5dfd490029ee0..e4f5fefe21440 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -39,6 +39,11 @@ "title": "Upgrading", "description": "Learn how to upgrade Coder.", "path": "./install/upgrade.md" + }, + { + "title": "Uninstall", + "description": "Learn how to uninstall Coder.", + "path": "./install/uninstall.md" } ] }, From bb8f5b0bce758995a78fecc0ae65699cb202a339 Mon Sep 17 00:00:00 2001 From: Ben Date: Mon, 29 Aug 2022 21:38:32 +0000 Subject: [PATCH 2/4] add package uninstall instructions --- docs/install/uninstall.md | 24 ++++++++++++++++++++++-- 1 file changed, 22 insertions(+), 2 deletions(-) diff --git a/docs/install/uninstall.md b/docs/install/uninstall.md index 90a8604ddf0ee..75e702e6e93b5 100644 --- a/docs/install/uninstall.md +++ b/docs/install/uninstall.md @@ -18,6 +18,26 @@ rm -rf ~/.cache/coder ## The Coder server binary and CLI +Debian, Ubuntu: + +```sh +sudo apt remove coder +``` + +Fedora, CentOS, RHEL, SUSE: + +```sh +sudo yum remove coder +``` + +Alpine: + +```sh +sudo apk del coder +``` + +If you installed Coder manually or used the install script on an unsupported operating system, you can remove the binary directly: + ```console sudo rm /usr/local/bin/coder ``` @@ -33,7 +53,7 @@ sudo rm /etc/coder.d/coder.env > There is a `postgres` directory within the `coderv2` directory that has the > database engine and database. If you want to reuse the database, consider > not performing the following step or copying the directory to another -> location +> location. ### macOS @@ -50,7 +70,7 @@ rm -rf ~/.config/coderv2 ### Windows ```console -C:\Users\USER\AppData\coderv2 +C:\Users\USER\AppData\Roaming\coderv2 ``` ## Up Next From 416e2c6b760bd7d635ac76ad4c6d31fd3a9384fc Mon Sep 17 00:00:00 2001 From: Ben Date: Wed, 7 Sep 2022 21:07:56 +0000 Subject: [PATCH 3/4] remove warning --- docs/install/uninstall.md | 6 ------ 1 file changed, 6 deletions(-) diff --git a/docs/install/uninstall.md b/docs/install/uninstall.md index 75e702e6e93b5..0b0443af5e59c 100644 --- a/docs/install/uninstall.md +++ b/docs/install/uninstall.md @@ -2,12 +2,6 @@ This article walks you through how to uninstall your Coder server. -
-

- Uninstalling Coder with the built-in PostgreSQL database will delete the database engine and database. Consider backing up the database directory if you would like to reuse it with a future installation. This does not apply if you have installed your own PostgreSQL database instance. -

-
- To uninstall your Coder server, delete the following directories. ## Cached Coder releases From 7af3fd3175d630c8e0067893131af1d29befbf7f Mon Sep 17 00:00:00 2001 From: Ben Date: Thu, 8 Sep 2022 19:46:05 +0000 Subject: [PATCH 4/4] remove configure step --- docs/install/uninstall.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/docs/install/uninstall.md b/docs/install/uninstall.md index 0b0443af5e59c..b5a8a11ca26d9 100644 --- a/docs/install/uninstall.md +++ b/docs/install/uninstall.md @@ -66,7 +66,3 @@ rm -rf ~/.config/coderv2 ```console C:\Users\USER\AppData\Roaming\coderv2 ``` - -## Up Next - -- [Learn how to configure Coder](./configure.md).