# xrDebug

Generated on 29 Feb 2024 from [the xrDebug catalog page](https://marketplace.digitalocean.com/apps/xrdebug)

[xrDebug](https://xrdebug.com) is a lightweight web-based debug utility server.

## Overview

This is the xrDebug DigitalOcean Marketplace application, it provides xrDebug ready to be used.

## Software Included

| Package | Version | License |
|---|---|---|
| [xrDebug](https://xrdebug.com) | [latest](https://github.com/xrdebug/xrdebug/releases/latest) | [Apache-2.0](https://github.com/xrdebug/xrdebug/?tab=Apache-2.0-1-ov-file#readme) |

## Creating an App using the Control Panel

Click the **Deploy to DigitalOcean** button to create a Droplet based on this 1-Click App. If you aren’t logged in, this link will prompt you to log in with your DigitalOcean account.

[![Deploy to DO](https://www.deploytodo.com/do-btn-blue.svg)](https://cloud.digitalocean.com/droplets/new?image=chevereto-xrdebug)

## Creating an App using the API

In addition to creating a Droplet from the xrDebug 1-Click App using the control panel, you can also use the [DigitalOcean API](https://docs.digitalocean.com/reference/api). As an example, to create a 4GB xrDebug Droplet in the SFO2 region, you can use the following `curl` command. You need to either save your [API access token](https://docs.digitalocean.com/reference/api/create-personal-access-token/index.html.md) to an environment variable or substitute it in the command below.

```shell
curl -X POST -H 'Content-Type: application/json' \
         -H 'Authorization: Bearer '$TOKEN'' -d \
        '{"name":"choose_a_name","region":"sfo2","size":"s-2vcpu-4gb","image":"chevereto-xrdebug"}' \
        "https://api.digitalocean.com/v2/droplets"
```

## Getting Started After Deploying xrDebug

To keep this server secure, the UFW firewall is enabled.

All ports are BLOCKED except 27420, 22 (SSH), 80 (HTTP) and 443 (HTTPS).

In a web browser, you can view:

- The default xrDebug site: http://your\_droplet\_public\_ipv4:27420

On the server:

- xrDebug binary is located at /usr/local/bin/xrdebug
- View xrDebug help `xrdebug -h`
- Stop xrDebug server running on port 27420 `kill $(lsof -t -i:27420)`
- Allow TCP port 27420 `ufw allow 27420/tcp`
- Disable the firewall `ufw disable`

For help and more information, visit [https://xrdebug.com](https://xrdebug.com)