This repository has been archived by the owner on Mar 21, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
6 changed files
with
163 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,136 @@ | ||
| # Headless Ubuntu/Xfce container with VNC and Firefox | ||
|
|
||
| ## accetto/xubuntu-vnc-firefox | ||
|
|
||
| [Docker Hub][this-docker] - [Git Hub][this-github] - [Changelog][this-changelog] - [Wiki][this-wiki] | ||
|
|
||
| *** | ||
|
|
||
| This repository contains resources for building Docker images based on [Ubuntu][docker-ubuntu] with [Xfce][xfce] desktop environment, [VNC][tigervnc] server for headless use and the current [Firefox Quantum][firefox] web browser. | ||
|
|
||
| The main image is a streamlined and simplified version of my other image [accetto/ubuntu-vnc-xfce-firefox-plus][accetto-docker-ubuntu-vnc-xfce-firefox-plus]. The applicable **plus** features have been re-implemented because **Firefox v67** handles user profiles differently. | ||
|
|
||
| All the components and features of the base image [accetto/xubuntu-vnc][accetto-docker-xubuntu-vnc] are inherited and therefore not the whole description will be repeated here. | ||
|
|
||
| This image adds the current version of [Firefox Quantum][firefox] web browser and some additional **plus** features described below. | ||
|
|
||
| The history of notable changes is documented in the [CHANGELOG][this-changelog]. | ||
|
|
||
| ![container-screenshot][this-screenshot-container] | ||
|
|
||
| ### Image tags | ||
|
|
||
| The following image tags are regularly maintained and rebuilt: | ||
|
|
||
| - `latest` is based on `accetto/xubuntu-vnc:latest` and it includes the **plus** features | ||
|
|
||
| [](https://microbadger.com/images/accetto/xubuntu-vnc-firefox:latest "Get your own version badge on microbadger.com") [](https://microbadger.com/images/accetto/xubuntu-vnc-firefox:latest "Get your own image badge on microbadger.com") | ||
|
|
||
| - `default` is also based on `accetto/xubuntu-vnc:latest`, but it doesn't include the **plus** features | ||
|
|
||
| [](https://microbadger.com/images/accetto/xubuntu-vnc-firefox:default "Get your own version badge on microbadger.com") [](https://microbadger.com/images/accetto/xubuntu-vnc-firefox:default "Get your own image badge on microbadger.com") | ||
|
|
||
| ### Dockerfiles | ||
|
|
||
| The [Git Hub][this-github-xubuntu-vnc-firefox] repository contains several Dockerfiles that can be used to build the images. | ||
|
|
||
| - `Dockerfile.firefox` | ||
|
|
||
| This is the main Dockerfile for building the `latest` image tag based on the `accetto/xubuntu-vnc:latest` tag by default. | ||
|
|
||
| However, by providing the `BASETAG` build argument it is possible to build images based on other base tags, for example `accetto/xubuntu-vnc:lab`. | ||
|
|
||
| This Docker file will include also the **plus** features described below. | ||
|
|
||
| - `Dockerfile.firefox.default` | ||
|
|
||
| This Dockerfile is for building the `default` image tag, which is also based on the `accetto/xubuntu-vnc:latest`, but it does not include the **plus** features. | ||
|
|
||
| ### Ports | ||
|
|
||
| The image exposes only the TCP port **5901** and therefore the containers consume only one TCP port (per container) on the host computer. | ||
|
|
||
| ### Volumes | ||
|
|
||
| The containers do not create or use any external volumes by default. However, the following folders make good mounting points: `/home/headless/Documents/`, `/home/headless/Downloads/`, `/home/headless/Pictures/`, `/home/headless/Public/` | ||
|
|
||
| Both **named volumes** and **bind mounts** can be used. More about volumes can be found in the [Docker documentation][docker-doc] (e.g. [Manage data in Docker][docker-doc-managing-data]). | ||
|
|
||
| ### Container user | ||
|
|
||
| Containers created from these images run under the default non-root application user **headless** (ID 1001), unless overridden. For more description check the base image [accetto/xubuntu-vnc][accetto-docker-xubuntu-vnc] or [Wiki][this-wiki]. | ||
|
|
||
| ### Using headless containers | ||
|
|
||
| The containers are intended to be used through a **VNC Viewer** (e.g. [TigerVNC][tigervnc] or [TightVNC][tightvnc]). The viewer should connect to the host running the container, pointing to its TCP port mapped to the container's port **5901**. | ||
|
|
||
| ## Firefox preferences and the plus features | ||
|
|
||
| **Firefox** browser supports pre-configuration of user preferences. | ||
|
|
||
| Users can enforce their personal browser preferences if they put them into the `user.js` file and then copy it into the Firefox profile folder. The provided **plus** features make it really easy. | ||
|
|
||
| There is the `/home/headless/firefox.plus` folder containing the `user.js` file and the helper utility `copy_firefox_user_preferences.sh`. It will copy the `user.js` file into one or more existing Firefox profiles. The utility is easy to use, because it is interactive and it will also display the help, if started with the `-h` or `--help` argument. | ||
|
|
||
| To make it even more convenient, there are also desktop launchers for the utility and for the **Firefox Profile Manager**. | ||
|
|
||
| Recommended procedure for taking advantage of the **plus** features is: | ||
|
|
||
| - Start the **Firefox Profile Manager** using the desktop launcher **FF Profile Manager**. Create a new Firefox profile if there is none or you want one more. Use the button **Create Profile...** for it. | ||
|
|
||
| **Hint**: You can also check the **Work offline** check-box before creating the profile. | ||
|
|
||
| The Firefox profiles are created inside the `/home/headless/.mozilla/firefox` folder by default. Note that the `.mozilla` folder is hidden. | ||
|
|
||
| Close the **Profile Manager** by pushing the **Exit** button. | ||
|
|
||
| - Put your personal Firefox preferences into the `user.js` file which is in the `/home/headless/firefox.plus`folder. Check the Firefox documentation (e.g. [Firefox preferences][firefox-doc-preferences]) for more information about the syntax. | ||
|
|
||
| **Hint**: There is also another way. You can first start Firefox, configure it and then copy the content of the `prefs.js` file from the Firefox profile folder into the `user.js` file. Then you can check the content and to keep only the preferences you really want to enforce. It's not a quick task, but you have to do it only once or until you need an update. | ||
|
|
||
| - Start the helper utility using the desktop launcher **Copy FF Preferences**. The utility will allow you to copy the `user.js` file to any of the existing Firefox profiles. | ||
|
|
||
| Note that the actual profile content is created only after starting Firefox, but the `user.js` file can be copied also before it. | ||
|
|
||
| **Hint**: You preferences will be enforced until you delete the `user.js` file from the Firefox profile folder. | ||
|
|
||
| It is also very easy to build customized images with pre-filled `user.js` files. | ||
|
|
||
| ## Issues | ||
|
|
||
| If you have found a problem or you just have a question, please check the [Issues][this-issues] and the [Wiki][this-wiki] first. Please do not overlook the closed issues. | ||
|
|
||
| If you do not find a solution, you can file a new issue. The better you describe the problem, the bigger the chance it'll be solved soon. | ||
|
|
||
| ## Credits | ||
|
|
||
| Credit goes to all the countless people and companies, who contribute to open source community and make so many dreamy things real. | ||
|
|
||
| *** | ||
|
|
||
| [this-docker]: https://hub.docker.com/r/accetto/xubuntu-vnc-firefox/ | ||
|
|
||
| [this-github]: https://github.com/accetto/xubuntu-vnc/ | ||
| [this-changelog]: https://github.com/accetto/xubuntu-vnc/blob/master/CHANGELOG.md | ||
| [this-wiki]: https://github.com/accetto/xubuntu-vnc/wiki | ||
|
|
||
| [this-issues]: https://github.com/accetto/xubuntu-vnc/issues | ||
|
|
||
| [this-github-xubuntu-vnc-firefox]: https://github.com/accetto/xubuntu-vnc/tree/master/docker/xubuntu-vnc-firefox | ||
|
|
||
| [this-screenshot-container]: https://raw.githubusercontent.com/accetto/xubuntu-vnc/master/docker/xubuntu-vnc-firefox/xubuntu-vnc-firefox.jpg | ||
|
|
||
| [accetto-docker-xubuntu-vnc]: https://hub.docker.com/r/accetto/xubuntu-vnc/ | ||
| [accetto-docker-ubuntu-vnc-xfce-firefox-plus]: https://hub.docker.com/r/accetto/ubuntu-vnc-xfce-firefox-plus/ | ||
|
|
||
| [docker-ubuntu]: https://hub.docker.com/_/ubuntu/ | ||
|
|
||
| [docker-doc]: https://docs.docker.com/ | ||
| [docker-doc-managing-data]: https://docs.docker.com/storage/ | ||
|
|
||
| [firefox-doc-preferences]: https://developer.mozilla.org/en-US/docs/Mozilla/Preferences/A_brief_guide_to_Mozilla_preferences | ||
|
|
||
| [firefox]: https://www.mozilla.org | ||
| [tigervnc]: http://tigervnc.org | ||
| [tightvnc]: http://www.tightvnc.com | ||
| [xfce]: http://www.xfce.org |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.