{"id":18561658,"url":"https://github.com/athena-os/athena-rdp-docker","last_synced_at":"2026-03-19T05:03:57.524Z","repository":{"id":242878576,"uuid":"609899511","full_name":"Athena-OS/athena-rdp-docker","owner":"Athena-OS","description":"GNOME remote desktop Docker image powered by Athena OS and xrdp.","archived":false,"fork":false,"pushed_at":"2025-11-15T15:58:56.000Z","size":139,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-12-16T11:23:46.750Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://hub.docker.com/r/athenaos/rdp","language":"Dockerfile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Athena-OS.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"github":"Athena-OS","patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"lfx_crowdfunding":null,"custom":["https://www.paypal.com/donate/?hosted_button_id=MTYRF2NQT2BWA"]}},"created_at":"2023-03-05T15:18:35.000Z","updated_at":"2025-11-15T15:59:00.000Z","dependencies_parsed_at":"2024-06-22T20:42:12.835Z","dependency_job_id":"3f18c85e-adf6-4f0a-9ed7-8e0339d00b72","html_url":"https://github.com/Athena-OS/athena-rdp-docker","commit_stats":null,"previous_names":["athena-os/athena-rdp-docker"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Athena-OS/athena-rdp-docker","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Athena-OS%2Fathena-rdp-docker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Athena-OS%2Fathena-rdp-docker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Athena-OS%2Fathena-rdp-docker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Athena-OS%2Fathena-rdp-docker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Athena-OS","download_url":"https://codeload.github.com/Athena-OS/athena-rdp-docker/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Athena-OS%2Fathena-rdp-docker/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28942916,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-31T12:10:04.904Z","status":"ssl_error","status_checked_at":"2026-01-31T12:09:58.894Z","response_time":128,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-06T22:07:33.474Z","updated_at":"2026-01-31T12:31:45.286Z","avatar_url":"https://github.com/Athena-OS.png","language":"Dockerfile","funding_links":["https://github.com/sponsors/Athena-OS","https://www.paypal.com/donate/?hosted_button_id=MTYRF2NQT2BWA"],"categories":[],"sub_categories":[],"readme":"# Athena OS Docker Image\n\n![athena-banner](https://user-images.githubusercontent.com/83867734/221656804-51b13a4f-876b-4ca8-856e-288d2209a949.png)\n\nThis repository provides the Docker image that runs a [GNOME](https://gnome.org/)\ndesktop on top of [Athena OS](https://github.com/Athena-OS/athena-iso). The desktop is accessible via\n[RDP (Remote Desktop Protocol)](https://en.wikipedia.org/wiki/Remote_Desktop_Protocol)\nclients such as [Remmina](https://remmina.org/), [FreeRDP](https://www.freerdp.com),\n[Microsoft Remote Desktop](https://www.microsoft.com/en-us/p/microsoft-remote-desktop/9wzdncrfj3ps)\n([for macOS](https://itunes.apple.com/app/microsoft-remote-desktop/id1295203466)).\n\nFind us at:\n\n* [Discord](https://discord.gg/DNjvQkb5Ad) - realtime support / chat with the community and the team.\n* [GitHub](https://github.com/Athena-OS) - view the source for all of our repositories.\n\n## Usage\n\nAthena OS container has been developed in order to be run also by podman. The choice to use podman comes from its advantages over docker, one of most important: security.\n\nAccording to your preference, install `docker` and `docker-compose` packages or `podman` package for your Linux environment.\n\nIn case you are using podman, edit `/etc/containers/registries.conf` and add:\n```\n[registries.search]\nregistries = ['docker.io']\n```\nin order to allow podman to search for images in Docker Hub.\n\n### Hack The Box API Token\n\nAthena OS container allows you to learn and play on Hack The Box platform. It is possible to access to Hack The Box by using your App Token. Retrieve your App Token from the Hack The Box website in your Profile Settings.\n\n### Docker\n\nYou can run the container by `docker-compose` (recommended) or `docker run`.\n\n#### docker-compose\n\nThe `docker-compose.yml` file should have the following content:\n```yaml\nversion: '3.4'\n\nservices:\n  athena-rdp:\n    image: athenaos/rdp\n    cap_add:\n      - cap_sys_admin\n      - ipc_lock\n      - net_admin\n    cgroup:\n      - host\n    devices:\n      - /dev/net/tun\n    ports:\n      - \"127.0.0.1:23389:3389\"\n      - \"127.0.0.1:8022:22\"\n    shm_size: '2gb'\n    sysctls:\n      - net.ipv6.conf.all.disable_ipv6=0\n    volumes:\n       - /sys/fs/cgroup:/sys/fs/cgroup\n    tmpfs:\n      - /run\n      - /tmp\n    restart: unless-stopped\n```\n\nRun the container by:\n```\nsudo docker-compose run athena-rdp\n```\n\n#### docker run\n\n```bash\ndocker run -ti \\\n  --name athena-rdp \\\n  --cap-add CAP_SYS_ADMIN \\\n  --cap-add IPC_LOCK \\\n  --cap-add NET_ADMIN \\\n  --cgroupns=host \\\n  --device /dev/net/tun \\\n  --shm-size 2G \\\n  --sysctl net.ipv6.conf.all.disable_ipv6=0 \\\n  --volume /sys/fs/cgroup:/sys/fs/cgroup \\\n  --publish 23389:3389 \\\n  --publish 8022:22 \\\n  --restart unless-stopped \\\n  docker.io/athenaos/rdp:latest\n```\nor\n```\ndocker run -ti --name athena-rdp --cap-add CAP_SYS_ADMIN --cap-add IPC_LOCK --cap-add NET_ADMIN --cgroupns=host --device /dev/net/tun --shm-size 2G --sysctl net.ipv6.conf.all.disable_ipv6=0 --volume /sys/fs/cgroup:/sys/fs/cgroup --publish 23389:3389 --publish 8022:22 --restart unless-stopped docker.io/athenaos/rdp:latest\n```\n\nIn case you exit the container and need to re-enter, run:\n```\ndocker exec --user athena -ti athena-rdp /bin/zsh\n```\nIn case the container is not running, run:\n```\ndocker start athena-rdp\n```\n\nFor stopping the container, run:\n```\ndocker stop athena-rdp\n```\n\nFor deleting the container, run:\n```\ndocker container rm athena-rdp\n```\n\n### Podman (Untested)\n\nYou can run the container by `podman run`.\n\n#### podman run\n\n```bash\npodman run -ti \\\n  --name athena-rdp \\\n  --cap-add NET_RAW \\\n  --cap-add NET_ADMIN \\\n  --device /dev/net/tun \\\n  --restart unless-stopped \\\n  docker.io/athenaos/rdp:latest\n```\nor\n```\npodman run -ti --name athena-rdp --cap-add NET_RAW --cap-add NET_ADMIN --device /dev/net/tun --restart unless-stopped docker.io/athenaos/rdp:latest\n```\n\nPodman will automatically replicate `/etc/hosts` and `/etc/hostname` files of your host. For preventing this, add `--no-hosts` argument to the `podman run` command above.\n\nIn case you exit the container and need to re-enter, run:\n```\npodman exec --user athena -ti athena-rdp /bin/zsh\n```\nIn case the container is not running, run:\n```\npodman start athena-rdp\n```\n\nFor stopping the container, run:\n```\npodman stop athena-rdp\n```\n\nFor deleting the container, run:\n```\npodman container rm athena-rdp\n```\n\n### Default Credentials\n\n```\nathena:athena\n```\n\n### Setting HTB API Token\n\nOnce you retrieved your HTB API Token from your Hack The Box website profile settings, you can set the HTB API Token in two ways:\n* By connecting by RDP to the GUI as explained in the next section, open terminal and run `htb-update` (or clicking **HTB Update** button in Athena Welcome)\n* If you don't want to connect to the GUI environment, run the following commands:\n  ```\n  sudo mkdir -p /run/secrets\n  sudo nano /run/secrets/htb-api\n  \u003cstore your HTB API Token in htb-api file and save it\u003e\n  htb-play\n  ```\n  \n## Connect to the desktop by RDP\n\nYou should now be able to access your full-featured GNOME desktop using\nthe RDP client of your choice. For example, using [Remmina](https://remmina.org) along with the install of `freerdp` package:\n\n```\nremmina -c rdp://127.0.0.1:23389\n```\n\n### Remmina features\n\nWhen you run Remmina, expand its window and on the left side press the `Toggle dynamic resolution update` icon button for automatically resizing the display.\n\nFor making the keyboard shortcut effective on the connected environment, on the left side press the `Grab all keyboard events` icon.\n\nFor copy and paste text from the host to the environment, copy a string, then, on the left side, click on `Tools` icon button and select `Keystrokes` and `Send clipboard content as keystrokes`.\n\n## Customizing and building the image\n\nClone this repository, edit `Dockerfile` and then run `docker build` as usual:\n\n```\ngit clone https://github.com/Athena-OS/athena-rdp-docker.git\ncd athena-rdp-docker\ndocker buildx build --tag 'athenaos/rdp:latest' .\n```\n\n### Invalidating cache\n\nUse `--no-cache` option:\n\n```\ndocker build --tag 'custom-athena-rdp:latest' --no-cache .\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fathena-os%2Fathena-rdp-docker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fathena-os%2Fathena-rdp-docker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fathena-os%2Fathena-rdp-docker/lists"}