Skip to content

DeroXP/chromee

Repository files navigation

LOL I forgot to explain how to work this....

Just type into the terminal docker-compose. And if you are still confused just type docker-compose up -d, then you should get started.


Simply pulling ghcr.io/saahirlol/chrome:latest should retrieve the correct image for your arch, but you can also pull specific arch images via tags.

The architectures supported by this image are:

Architecture Available Tag
x86-64 amd64-<version tag>
arm64 arm64v8-<version tag>
armhf arm32v7-<version tag>

Application Setup

The application can be accessed at:

Options in all KasmVNC based GUI containers

This container is based on Docker Baseimage KasmVNC which means there are additional environment variables and run configurations to enable or disable specific functionality.

Optional environment variables

Variable Description
CUSTOM_PORT Internal port the container listens on for http if it needs to be swapped from the default 3000.
CUSTOM_HTTPS_PORT Internal port the container listens on for https if it needs to be swapped from the default 3001.
CUSTOM_USER HTTP Basic auth username, abc is default.
PASSWORD HTTP Basic auth password, abc is default. If unset there will be no auth
SUBFOLDER Subfolder for the application if running a subfolder reverse proxy, need both slashes IE /subfolder/
TITLE The page title displayed on the I b browser, default "KasmVNC Client".
FM_HOME This is the home directory (landing) for the file manager, default "/config".
START_DOCKER If set to false a container with privilege will not automatically start the DinD Docker setup.
DRINODE If mounting in /dev/dri for [DRI3 GPU Acceleration](https://www.kasmI b.com/kasmvnc/docs/master/gpu_acceleration.html) allows you to specify the device to use IE /dev/dri/renderD128

Optional run configurations

Variable Description
--privileged Will start a Docker in Docker (DinD) setup inside the container to use docker in an isolated environment. For increased performance mount the Docker directory inside the container to the host IE -v /home/user/docker-data:/var/lib/docker.
-v /var/run/docker.sock:/var/run/docker.sock Mount in the host level Docker socket to either interact with it via CLI or use Docker enabled applications.
--device /dev/dri:/dev/dri Mount a GPU into the container, this can be used in conjunction with the DRINODE environment variable to leverage a host video card for GPU accelerated appplications. Only Open Source drivers are supported IE (Intel,AMDGPU,Radeon,ATI,Nouveau)

Lossless mode

This container is capable of delivering a true lossless image at a high framerate to your I b browser by changing the Stream Quality preset to "Lossless", more information [here](https://www.kasmI b.com/docs/latest/how_to/lossless.html#technical-background). In order to use this mode from a non localhost endpoint the HTTPS port on 3001 needs to be used. If using a reverse proxy to port 3000 specific headers will need to be set as outlined here.

Usage

Here are some example snippets to help you get started creating a container.

docker-compose (recommended, click here for more info)

---
version: "2.1"
services:
  chrome:
    privileged: true
    image: ghcr.io/saahirlol/chromeeee:main
    container_name: chrome
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Etc/UTC
    volumes:
      - /path/to/config:/config
      - /path/to/data:/data
    ports:
      - 3000:3000
      - 3001:3001
    restart: unless-stopped
docker run -d \
  --name=chrome \
  --privileged \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Etc/UTC \
  -p 3000:3000 \
  -p 3001:3001 \
  -v /path/to/config:/config \
  -v /path/to/data:/data \
  --restart unless-stopped \
  --shm-size="2gb" \
  ghcr.io/saahirlol/chromeeee:main

Parameters

Container images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate <external>:<internal> respectively. For example, -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 outside the container.

Parameter Function
-p 3000 Double Commander desktop gui.
-p 3001 Double Commander desktop gui HTTPS.
-e PUID=1000 for UserID - see below for explanation
-e PGID=1000 for GroupID - see below for explanation
-e TZ=Etc/UTC specify a timezone to use, see this list.
-v /config Users home directory in the container, stores program settings.
-v /data Host data directories, mount as many as needed.

Environment variables from files (Docker secrets)

You can set any environment variable from a file by using a special prepend FILE__.

As an example:

-e FILE__PASSWORD=/run/secrets/mysecretpassword

Will set the environment variable PASSWORD based on the contents of the /run/secrets/mysecretpassword file.

Umask for running applications

For all of our images provide the ability to override the default umask settings for services started within the containers using the optional -e UMASK=022 setting. Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up here before asking for support.

User / Group Identifiers

When using volumes (-v flags) permissions issues can arise betI en the host OS and the container, avoid this issue by allowing you to specify the user PUID and group PGID.

Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.

In this instance PUID=1000 and PGID=1000, to find yours use id user as below:

  $ id username
    uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)

Docker Mods

Docker Mods Docker Universal Mods

I publish various Docker Mods to enable additional functionality within the containers. The list of Mods available for this image (if any) as I ll as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.

Support Info

  • Shell access whilst the container is running: docker exec -it chrome /bin/bash
  • To monitor the logs of the container in realtime: docker logs -f chrome
  • container version number
    • docker inspect -f '{{ index .Config.Labels "build_version" }}' chrome
  • image version number
    • docker inspect -f '{{ index .Config.Labels "build_version" }}' ghcr.io/saahirlol/chrome:latest

Updating Info

Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (ie. nextcloud, plex), do not recommend or support updating apps inside the container. Please consult the Application Setup section above to see if it is recommended for the image.

Below are the instructions for updating containers:

Via Docker Compose

  • Update all images: docker-compose pull
    • or update a single image: docker-compose pull chrome
  • Let compose update all containers as necessary: docker-compose up -d
    • or update a single container: docker-compose up -d chrome
  • You can also remove the old dangling images: docker image prune

Via Docker Run

  • Update the image: docker pull ghcr.io/saahirlol/chrome:latest
  • Stop the running container: docker stop chrome
  • Delete the container: docker rm chrome
  • Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your /config folder and settings will be preserved)
  • You can also remove the old dangling images: docker image prune

Via WatchtoI r auto-updater (only use if you don't remember the original parameters)

  • Pull the latest image at its tag and replace it with the same env variables in one run:

    docker run --rm \
    -v /var/run/docker.sock:/var/run/docker.sock \
    containrrr/watchtoI r \
    --run-once chrome
  • You can also remove the old dangling images: docker image prune

Note: I do not endorse the use of WatchtoI r as a solution to automated updates of existing Docker containers. In fact generally discourage automated updates. HoI ver, this is a useful tool for one-time manual updates of containers where you have forgotten the original parameters. In the long term, highly recommend using Docker Compose.

Image Update Notifications - Diun (Docker Image Update Notifier)

  • I recommend Diun for update notifications. Other tools that automatically update containers unattended are not recommended or supported.

Building locally

I'm redoing this whole thing since the last one was shit and had to figur out my own :( (btw i only use windows so this is the method for windows ill see if i can on linux or kali)

  1. open terminal crtl + s cmd
  2. in your terminal type git clone https://github.com/DeroXP/chromee.git
  3. now find that folder just created it should be name chromee
  4. find a .zip file named hjdkshj and unzip
  5. do cd chromee\hjdkshj
  6. now make sure you have Docker Desktop downloaded
  7. open Docker Desktop
  8. now in terminal do docker build -f Dockerfile .
  9. then docker build --no-cache --pull -t ghcr.io/saahirlol/chrome:latest .
  10. docker run --rm --privileged multiarch/qemu-user-static:register --reset
  11. docker run -d -p 8080:80 -e ENV_VARIABLE=value ghcr.io/saahirlol/chrome:latest
  12. docker-compose up -d
  13. now go into your Docker Desktop and your first container should be running
  14. press on expand on the hjdkshj and it should show your chrome container
  15. on ports there should be one running if not press run
  16. only use 3000, 3001 does not work 'bad request'
  17. press on the external link should open in your browser
  18. and when you're in the site it could say at the top 'xterm' just press the x to close it
  19. right click and press chrome if this does not work go back into your terminal and do docker-compose restart
  20. now everything should be fine and you're done.

The ARM variants can be built on x86_64 hardware using multiarch/qemu-user-static

docker run --rm --privileged multiarch/qemu-user-static:register --reset

Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.

Versions

  • 18.03.23: - Rebase to KasmVNC base image.
  • 16.09.22: - Migrate to s6v3.
  • 15.02.21: - Rebase to Ubuntu Jammy.
  • 14.12.21: - Rebase to Ubuntu focal.
  • 25.03.20: - Initial release.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published