Skip to content

Commit c026464

Browse files
sharkymarkbpmct
andauthored
chore: add uninstall steps to remove a Coder OSS deployment from docs (#3742)
Co-authored-by: Ben <ben@coder.com>
1 parent 3610f09 commit c026464

File tree

2 files changed

+75
-2
lines changed

2 files changed

+75
-2
lines changed

docs/install/uninstall.md

+68
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
# Uninstall
2+
3+
This article walks you through how to uninstall your Coder server.
4+
5+
To uninstall your Coder server, delete the following directories.
6+
7+
## Cached Coder releases
8+
9+
```console
10+
rm -rf ~/.cache/coder
11+
```
12+
13+
## The Coder server binary and CLI
14+
15+
Debian, Ubuntu:
16+
17+
```sh
18+
sudo apt remove coder
19+
```
20+
21+
Fedora, CentOS, RHEL, SUSE:
22+
23+
```sh
24+
sudo yum remove coder
25+
```
26+
27+
Alpine:
28+
29+
```sh
30+
sudo apk del coder
31+
```
32+
33+
If you installed Coder manually or used the install script on an unsupported operating system, you can remove the binary directly:
34+
35+
```console
36+
sudo rm /usr/local/bin/coder
37+
```
38+
39+
## Coder as a system service configuration
40+
41+
```console
42+
sudo rm /etc/coder.d/coder.env
43+
```
44+
45+
## Coder settings and the optional built-in PostgreSQL database
46+
47+
> There is a `postgres` directory within the `coderv2` directory that has the
48+
> database engine and database. If you want to reuse the database, consider
49+
> not performing the following step or copying the directory to another
50+
> location.
51+
52+
### macOS
53+
54+
```console
55+
rm -rf ~/Library/Application\ Support/coderv2
56+
```
57+
58+
### Linux
59+
60+
```console
61+
rm -rf ~/.config/coderv2
62+
```
63+
64+
### Windows
65+
66+
```console
67+
C:\Users\USER\AppData\Roaming\coderv2
68+
```

docs/manifest.json

+7-2
Original file line numberDiff line numberDiff line change
@@ -33,18 +33,23 @@
3333
},
3434
{
3535
"title": "Kubernetes",
36-
"description": "Install Coder with Kubernetes via Helm",
36+
"description": "Install Coder with Kubernetes via Helm.",
3737
"path": "./install/kubernetes.md"
3838
},
3939
{
4040
"title": "Docker",
41-
"description": "Install Coder with Docker / docker-compose",
41+
"description": "Install Coder with Docker / docker-compose/",
4242
"path": "./install/docker.md"
4343
},
4444
{
4545
"title": "Standalone binaries",
4646
"description": "Download binaries for macOS, Windows, and Linux.",
4747
"path": "./install/binary.md"
48+
},
49+
{
50+
"title": "Uninstall",
51+
"description": "Learn how to uninstall Coder.",
52+
"path": "./install/uninstall.md"
4853
}
4954
]
5055
},

0 commit comments

Comments
 (0)