Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Uninstall Gateway #4966

Merged
merged 16 commits into from
May 15, 2024
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions website/src/app/kb/administer/uninstall/_page.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
"use client";
import Content from "./readme.mdx";

export default function _Page() {
return <Content />;
}
17 changes: 17 additions & 0 deletions website/src/app/kb/administer/uninstall/page.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
import _Page from "./_page";
import { Metadata } from "next";
import LastUpdated from "@/components/LastUpdated";

export const metadata: Metadata = {
title: "Uninstall Firezone • Firezone Docs",
description: "How to uninstall Firezone",
};

export default function Page() {
return (
<>
<_Page />
<LastUpdated dirname={__dirname} />
</>
);
}
77 changes: 77 additions & 0 deletions website/src/app/kb/administer/uninstall/readme.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
import SupportOptions from "@/components/SupportOptions";
import { TabsGroup, TabsItem } from "@/components/DocsTabs";
import Alert from "@/components/DocsAlert";

# Uninstall Firezone Gateway

This guide covers how to uninstall the Firezone Gateway from your server(s).

{/* TODO: add Alert and link to client uninstall docs when that's complete */}

## Step 1: Stop the Gateway and remove relevant files

Use the appropriate instructions below to stop and remove the Gateway depending
on how it was installed:

<TabsGroup>
<TabsItem title="Docker" active>

1. Stop the container:

```
docker stop firezone-gateway
```

1. Remove the container its volumes:
jamilbk marked this conversation as resolved.
Show resolved Hide resolved

```
docker rm --volumes firezone-gateway
```

1. Remove the image:

```
docker rmi ghcr.io/firezone/gateway:1
```

1. Remove the cache directory:

```
sudo rm -rf /var/lib/firezone
```

</TabsItem>
<TabsItem title="systemd">

1. Stop the service:

```
sudo systemctl stop firezone-gateway
```

1. Disable the service:

```
sudo systemctl disable firezone-gateway
```

1. Remove all relevant files:

```
sudo rm -rf /etc/systemd/system/firezone-gateway.service \
/usr/local/bin/firezone-gateway \
/usr/local/bin/firezone-gateway-init \
/var/lib/firezone
```

</TabsItem>
</TabsGroup>

## Step 2 (optional): Delete the data from the admin portal

If you want to remove the Gateway's data from the admin portal as well, navigate
to the Site where the Gateway was running, click `(see all)` next
`Online Gateways`, and then delete the offline Gateway corresponding to the
jamilbk marked this conversation as resolved.
Show resolved Hide resolved
Gateway you just uninstalled.

<SupportOptions />
2 changes: 1 addition & 1 deletion website/src/app/kb/administer/upgrading/readme.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import Image from "next/image";
import Alert from "@/components/DocsAlert";
import SupportOptions from "@/components/SupportOptions";

# Upgrading Gateways
# Upgrade Gateways

Firezone Gateways are designed to be easily upgraded with little or no planned
downtime for your organization. This guide will walk you through the steps to
Expand Down
8 changes: 7 additions & 1 deletion website/src/components/KbSidebar/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ export default function KbSidebar() {
<li>
<Item
href="/kb/administer/upgrading"
label="Upgrading Gateways"
label="Upgrade Gateways"
/>
</li>
<li>
Expand All @@ -148,6 +148,12 @@ export default function KbSidebar() {
label="Troubleshooting"
/>
</li>
<li>
<Item
href="/kb/administer/uninstall"
label="Uninstall Firezone"
/>
</li>
</Collapse>
</li>
<li>
Expand Down
Loading