https://github.com/rahuldhole/openbox

Codespaces RDP connection to OpenBox for DEVaaS platforms
https://github.com/rahuldhole/openbox

chrome codespaces devaas gitpod microsoft-edge openbox openshift rdp vdi xrdp

Last synced: 28 days ago
JSON representation

Codespaces RDP connection to OpenBox for DEVaaS platforms

• Host: GitHub
• URL: https://github.com/rahuldhole/openbox
• Owner: rahuldhole
• Created: 2024-09-07T14:16:46.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2025-01-04T19:38:47.000Z (about 2 months ago)
• Last Synced: 2025-01-04T20:19:10.800Z (about 2 months ago)
• Topics: chrome, codespaces, devaas, gitpod, microsoft-edge, openbox, openshift, rdp, vdi, xrdp
• Language: Shell
• Homepage:
• Size: 121 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Openbox: Minimal Remote Desktop Environment

**Setup a private remote desktop environment** with Openbox, XRDP, Kitty, Diodon, and Tailscale for secure remote access.

[![Open in Codespaces](https://github.com/codespaces/badge.svg)](https://github.com/codespaces/new?hide_repo_select=true&ref=main&repo=rahuldhole/openbox)

**Note:** Gitpod and OpenShift currently use raw scripts. Contributions to update these to packaged solutions are welcome.

[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/new#https://github.com/rahuldhole/openbox)



     Open in OpenShift (Currently not stable)



---

## Free Remote Desktop Hours

- **GitHub Codespaces:** 60 hours/month (2 cores) = 120 CPU hours

- **Gitpod:** 50 hours/month

**Total:** 110 hours/month (~15.7 working days at 7 hours/day)

---

## Sample installation for customizing your private dev container

```json

{

  "name": "Openbox",

  "image": "mcr.microsoft.com/devcontainers/base:ubuntu",

  "runArgs": [

    "--device=/dev/net/tun", // needed for Tailscale

    "--shm-size=2g" // needed for browsers

  ],

  "features": {

    "ghcr.io/tailscale/codespace/tailscale:latest": {},

    "ghcr.io/rahuldhole/openbox/xrdp:latest": {},

    "ghcr.io/rahuldhole/openbox/google-chrome:latest": {},

    "ghcr.io/rahuldhole/openbox/microsoft-edge:latest": {},

    "ghcr.io/rahuldhole/openbox/vscode:latest": {}

  },

  "postCreateCommand": "/bin/bash -c 'echo \"vscode:vscode\" | sudo chpasswd'",

  "postStartCommand": "/usr/local/sbin/xrdp-entrypoint",

  "remoteUser": "vscode"

}

```

---

## Steps to Connect via RDP

### 1. Verify Status

```sh

sudo service xrdp status

sudo tailscale status

```

### 2. Log In and Connect to Tailscale

```sh

sudo tailscale up

```

### 3. Connect Using RDP Client

- Use the Tailscale VPN IP of the Codespaces or Gitpod instance.

- **RDP User Credentials:**

  - Codespaces: `vscode:vscode`

  - Gitpod: `gitpod:gitpod`

### 4. Openbox Navigation

- Right-click on the blue screen to access more options.

---

## Openbox Shortcuts

| Shortcut                      | Action                                      |

|-------------------------------|---------------------------------------------|

| `Alt + T`                     | Switch between windows in the current workspace |

| `Alt + D`                     | Show or hide the desktop                   |

| `Alt + `    | Switch between adjacent workspaces         |

| `Alt + Shift + `  | Move current window to adjacent workspaces |

| `Alt + `              | Jump to the nth workspace (non-numpad keys)|

---

## Application Shortcuts

| Shortcut            | Application                        |

|---------------------|------------------------------------|

| `Alt + Ctrl + K`    | Open Kitty terminal (`kitty`)      |

| `Alt + Ctrl + G`    | Open Google Chrome (`--no-sandbox`)|

| `Alt + Ctrl + E`    | Open Microsoft Edge (`--no-sandbox`)|

| `Alt + Ctrl + V`    | Open VS Code (`code --no-sandbox .`)|

| `Alt + V`           | Open Diodon clipboard manager     |

**Note:** Customize shortcuts in `~/.config/openbox/rc.xml`.

---

## Warnings

1. **Do not open the Codespaces repository inside RDP.**

   - This may trigger excessive network traffic and system hangs.

2. **Resource Usage:**

   - 2 cores are sufficient for most development tasks.

---

## Troubleshooting

1. In Gitpod, if Tailscale is not started:

    ```sh

    sudo tailscaled

    sudo -E tailscale up --hostname "gitpod-${GITPOD_GIT_USER_NAME// /-}-$(echo ${GITPOD_WORKSPACE_CONTEXT} | jq -r .repository.name)"

    ```

Contributions are welcome! Feel free to submit pull requests to enhance functionality or improve documentation.