Skip to content

Commit 38c915c

Browse files
josephcardillo-akamaiMagda Suliknmelehan-akamai
authored
[Update] Kali Linux Marketplace OCA Documentation (#7331)
* update kali linux marketplace oca guide with updated deployment instructions * editorial review * copy edit --------- Co-authored-by: Magda Sulik <[email protected]> Co-authored-by: Nathan Melehan <[email protected]>
1 parent e1b2d19 commit 38c915c

File tree

1 file changed

+29
-21
lines changed
  • docs/marketplace-docs/guides/kali-linux

1 file changed

+29
-21
lines changed

docs/marketplace-docs/guides/kali-linux/index.md

Lines changed: 29 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,13 @@
22
title: "Deploy Kali Linux through the Linode Marketplace"
33
description: "Deploy Kali Linux, a popular Linux distribution for penetration testing and security research, on a Linode Compute Instance."
44
published: 2022-07-05
5+
modified: 2025-08-22
56
keywords: ['kali','security','pentest']
67
tags: ["marketplace", "linode platform", "cloud manager"]
8+
external_resources:
9+
- '[What is Kali Linux?](https://www.kali.org/docs/introduction/what-is-kali-linux/)'
10+
- '[Should I Use Kali Linux?](https://www.kali.org/docs/introduction/should-i-use-kali-linux/)'
11+
- '[Kali Linux official documentation](https://www.kali.org/docs/)'
712
aliases: ['/products/tools/marketplace/guides/kali-linux/','/products/tools/marketplace/guides/kalilinux/']
813
authors: ["Akamai"]
914
contributors: ["Akamai"]
@@ -12,10 +17,7 @@ marketplace_app_id: 1017300
1217
marketplace_app_name: "Kali Linux"
1318
---
1419

15-
[Kali Linux](https://www.kali.org/) is a specialized Debian-based Linux distribution that has become an industry-standard tool for penetration testing. Kali Linux includes hundreds of free tools for reverse engineering, penetration testing, computer forensics, security audits, and more. It is open source and prioritizes simplicity. To learn more about Kali Linux and determine if its a viable solution for your workloads, see the following resources from its official documentation site:
16-
17-
- [What is Kali Linux?](https://www.kali.org/docs/introduction/what-is-kali-linux/)
18-
- [Should I Use Kali Linux?](https://www.kali.org/docs/introduction/should-i-use-kali-linux/)
20+
[Kali Linux](https://www.kali.org/) is a specialized Debian-based Linux distribution that has become an industry-standard tool for penetration testing. Kali Linux includes hundreds of free tools for reverse engineering, penetration testing, computer forensics, security audits, and more. It is open source and prioritizes simplicity.
1921

2022
{{< note >}}
2123
This Marketplace App extends Linode's Kali Linux distribution image by allowing the user to preinstall one of the available metapackages.
@@ -28,7 +30,7 @@ This Marketplace App extends Linode's Kali Linux distribution image by allowing
2830
{{% content "marketplace-verify-standard-shortguide" %}}
2931

3032
{{< note >}}
31-
**Estimated deployment time:** Kali Linux should be fully installed within 45-60 minutes after the Compute Instance has finished provisioning.
33+
**Estimated deployment time:** Kali Linux should be fully installed within 5-10 minutes (Core), 15-20 minutes (Default), and 45-60 minutes (Everything) after the Compute Instance has finished provisioning. VNC installation takes approximately 5-10 additional minutes.
3234
{{< /note >}}
3335

3436
## Configuration Options
@@ -38,47 +40,53 @@ This Marketplace App extends Linode's Kali Linux distribution image by allowing
3840

3941
### Kali Options
4042

41-
- **Kali Headless Package** *(required)*: This installs the [kali-linux-headless](https://www.kali.org/tools/kali-meta/#kali-linux-headless) metapackage, which includes all non-GUI packages.
42-
- **Kali Everything Package** *(required)*: This installs the [kali-linux-everything](https://www.kali.org/tools/kali-meta/#kali-linux-everything) metapackage, which includes all available Kali packages.
43+
- **Kali Linux Package** *(required)*: Select the Kali Linux metapackage to install:
44+
- **Core**. Installs the [kali-linux-core](https://www.kali.org/tools/kali-meta/#kali-linux-core) metapackage, which includes essential penetration testing tools.
45+
- **Default**. Installs the [kali-linux-default](https://www.kali.org/tools/kali-meta/#kali-linux-default) metapackage, which includes commonly used tools and utilities.
46+
- **Everything**. Installs the [kali-linux-everything](https://www.kali.org/tools/kali-meta/#kali-linux-everything) metapackage, which includes all available Kali packages.
47+
48+
- **Setup VNC Remote Desktop?** *(required)*. Choose whether to install and configure [TigerVNC](https://tigervnc.org/) with [XFCE Desktop](https://www.xfce.org/) for remote desktop access. This is recommended for the *Everything* package and adds desktop functionality to the Default and Core packages.
4349

44-
{{< note >}}
45-
If both packages are selected, only the [kali-linux-everything](https://www.kali.org/tools/kali-meta/#kali-linux-everything) package is installed (which includes everything in [kali-linux-headless](https://www.kali.org/tools/kali-meta/#kali-linux-headless)).
46-
{{< /note >}}
50+
{{% content "marketplace-required-limited-user-fields-shortguide" %}}
4751

48-
- **VNC Installation** *(required)*: This option installs and starts [TigerVNC](https://tigervnc.org/) and [XFCE Desktop package](https://www.xfce.org/).
49-
- **Sudo/VNC Username** *(required)*: The VNC username you wish to create for this Compute Instance. This is used for your VNC session and will have elevated privileges (`sudo`).
50-
- **Sudo/VNC User Password** *(required)*: The password you wish to use for your VNC user.
52+
- **VNC Username:** *(Required only if VNC is enabled)*. It's the VNC username for this Compute Instance. This username has elevated privileges (`sudo`) and can access the VNC session.
5153

5254
{{% content "marketplace-custom-domain-fields-shortguide" %}}
5355

5456
{{% content "marketplace-special-character-limitations-shortguide" %}}
5557

5658
## Getting Started after Deployment
5759

58-
After Kali Linux has been fully deployed, you can log in through an SSH session as the `root` user and perform your workloads as needed. See the [Kali Linux documentation](https://www.kali.org/docs/) to learn how to further use your instance.
60+
After Kali Linux is deployed, you can log in through an SSH session as the `root` user and perform your workloads as needed. Your deployment credentials are stored in `/home/{{< placeholder "USERNAME" >}}/.credentials` for reference. To learn more, See the [Kali Linux documentation](https://www.kali.org/docs/) to learn how to further use your instance.
5961

6062
### Remote Desktop Connection with VNC
6163

62-
If you selected the VNC installation option, [TigerVNC](https://tigervnc.org/) is installed. This lets you connect remotely to the desktop environment and access Kali's GUI tools. Perform the steps below to access your Kali Linux desktop through a VNC client. While there are many options for OS X and Windows, this guide will use [RealVNC Viewer](https://www.realvnc.com/en/connect/download/viewer/).
64+
If you enabled VNC during deployment, [TigerVNC](https://tigervnc.org/) and the XFCE desktop environment are installed. This allows you to connect remotely to the desktop environment and access Kali's GUI tools.
65+
66+
To access your Kali Linux desktop through a VNC client:
67+
68+
{{< note >}}
69+
There are many options for macOS and Windows, but this guide uses [RealVNC Viewer](https://www.realvnc.com/en/connect/download/viewer/).
70+
{{< /note >}}
6371

64-
1. From your desktop, create an SSH tunnel to your Compute Instance with the following command. Be sure to replace *[username]* with the VNC username you created and *[ip]* with the IPv4 address of your Compute Instance. See the [Managing IP Addresses](/docs/products/compute/compute-instances/guides/manage-ip-addresses/) guide for information on viewing IP addresses.
72+
1. From your desktop, create an SSH tunnel to your Compute Instance with the command below replacing `{{< placeholder "USERNAME" >}}` with the VNC username you created and `[ip]` with the IPv4 address of your Compute Instance. To learn more on viewing IP addresses, see [Managing IP Addresses](/docs/products/compute/compute-instances/guides/manage-ip-addresses/).
6573

6674
```output
67-
ssh -L 61000:localhost:5901 -N -l [username] [ip]
75+
ssh -L 61000:localhost:5901 -N -l {{< placeholder "USERNAME" >}} [ip]
6876
```
6977
70-
2. Open your preferred VNC viewer application and connect to your Compute Instance through the SSH tunnel you created. The format is `localhost:61000`
78+
2. Open your preferred VNC viewer application and connect to your Compute Instance through the SSH tunnel you created. The format is `localhost:61000`.
7179
7280
![Screenshot of RealVNC connection detail](realvnc-connection.jpg)
7381
74-
3. A warning may appear notifying you that the connection is unencrypted. Since you are using an SSH tunnel, your connection is encrypted over the internet. You can safely ignore this warning and continue.
82+
A warning may appear notifying you that the connection is unencrypted. Since you're using an SSH tunnel, your connection is encrypted over the internet. You can safely ignore this warning and continue.
7583
7684
![Screenshot of RealVNC unencrypted connection warning](realvnc-warning.jpg)
7785
78-
4. You are then prompted to enter the password you created for the VNC user.
86+
4. Enter the password you created for the VNC user.
7987
8088
![Screenshot of RealVNC password prompt](realvnc-password.jpg)
8189
82-
After connecting, the Kali Linux desktop should appear.
90+
After connecting, the Kali Linux desktop appears.
8391
8492
{{% content "marketplace-update-note-shortguide" %}}

0 commit comments

Comments
 (0)