diff --git a/firefox_dev/README.md b/firefox_dev/README.md new file mode 100644 index 0000000..7da211d --- /dev/null +++ b/firefox_dev/README.md @@ -0,0 +1,62 @@ +# Firefox + +## Overview + +Access the application's full graphical interface directly from any modern web browser - no downloads, installs, or setup required on the client side - or connect with any VNC client. + +The web interface also offers audio playback, seamless clipboard sharing, an integrated file manager and terminal for accessing the container's files and shell, desktop notifications, and more. + +## Project Details + +- **Project Repository:** [Link](https://github.com/jlesage/docker-firefox) +- **Container Image:** [Docker Hub](https://hub.docker.com/r/jlesage/firefox) +- **Reverse Proxy Port:** `5800` + +## Getting Started + +1. Start the container: `docker compose up -d` +2. Open http://localhost:5800 in your browser +3. Follow the initial setup wizard to configure the application + +## Environment Variable Notes + +FIREFOX_IMAGE=jlesage/firefox:latest + +Used for securing online: +``` +FIREFOX_WEB_AUTHENTICATION=1 +FIREFOX_WEB_AUTHENTICATION_USERNAME=user +FIREFOX_WEB_AUTHENTICATION_PASSWORD=password +FIREFOX_SECURE_CONNECTION=1 +``` + +## Network Notes + +Requires proxy network + +## Docker Run + +```bash +docker run -d \ + --name firefox \ + -p 5800:5800 \ + -v /data/firefox/config:/config \ + jlesage/firefox +``` + +See compose.yaml for the full set of environment variables. + +## Additional Notes / Gotchas + +GUI app streamed to the browser — unauthenticated by default aside from the web password, keep it behind the proxy. + +## Dockhand Stack, Deploy from Git + +Cookbooks Repository +stackname: NAME_HERE +Compose file path: firefox/compose.yaml +Additional env file (optional): firefox/sample.env + +Then "Load" firefox/sample.env into the Environmental variables in dockhand + +Create the Stack diff --git a/firefox_dev/compose.yaml b/firefox_dev/compose.yaml new file mode 100644 index 0000000..3e1bd2c --- /dev/null +++ b/firefox_dev/compose.yaml @@ -0,0 +1,21 @@ +# Firefox +services: + firefox: + image: ${FIREFOX_IMAGE:-jlesage/firefox} + restart: ${FIREFOX_RESTART:-unless-stopped} + volumes: + - ${VOL_PATH:-/data}/firefox/config:/config + environment: + - TZ=${FIREFOX_TZ:-America/Vancouver} + - WEB_AUTHENTICATION=${FIREFOX_WEB_AUTHENTICATION:-1} + - WEB_AUTHENTICATION_USERNAME=${FIREFOX_WEB_AUTHENTICATION_USERNAME:-user} + - WEB_AUTHENTICATION_PASSWORD=${FIREFOX_WEB_AUTHENTICATION_PASSWORD:-ChangeThisPassword} + - SECURE_CONNECTION=${FIREFOX_SECURE_CONNECTION:-1} + ports: + - ${FIREFOX_PORT:-5800}:5800 + networks: + - proxy + +networks: + proxy: + external: true diff --git a/firefox_dev/sample.env b/firefox_dev/sample.env new file mode 100644 index 0000000..6caf797 --- /dev/null +++ b/firefox_dev/sample.env @@ -0,0 +1,10 @@ +VOL_PATH=/data +TZ=America/Vancouver +FIREFOX_IMAGE=jlesage/firefox:latest +FIREFOX_PORT=5800 +FIREFOX_RESTART=unless-stopped +FIREFOX_WEB_AUTHENTICATION=1 +FIREFOX_WEB_AUTHENTICATION_USERNAME=user +FIREFOX_WEB_AUTHENTICATION_PASSWORD=ChangeThisPassword +FIREFOX_SECURE_CONNECTION=1 +FIREFOX_TZ=America/Vancouver