workspaces-images/docs/redroid/README.md

21 lines
988 B
Markdown
Raw Normal View History

# About This Image
This Image contains a browser-accessible version of [Redroid](https://github.com/remote-android/redroid-doc).
![Screenshot][Image_Screenshot]
[Image_Screenshot]: https://f.hubspotusercontent30.net/hubfs/5856039/dockerhub/image-screenshots/redroid.png "Image Screenshot"
2023-12-29 01:13:07 +01:00
## Important !!
This image requires host level kernel modules to be installed and loaded.
See [Redroid Docs](https://github.com/remote-android/redroid-doc?tab=readme-ov-file#getting-started) for more details
# Environment Variables
2023-12-29 01:13:07 +01:00
* `REDROID_GPU_GUEST_MODE` - Used to instruct redroid to utilize GPU rendering. Options are `auto`, `guest`, and `host`
* `REDROID_FPS` - Set the maximum FPS for redroid and scrcpy
* `REDROID_WIDTH` - Set the desired width of the redroid device
* `REDROID_HEIGHT` - Set the desired height of the redroid device
* `REDROID_DPI` - Set the desired DPI of the redroid device
* `REDROID_SHOW_CONSOLE` - Display the scrcpy console after launching the redroid device.