diff --git a/images/docker-foldingathome/index.html b/images/docker-foldingathome/index.html index 1a6b727714..1e6d2f92a0 100644 --- a/images/docker-foldingathome/index.html +++ b/images/docker-foldingathome/index.html @@ -1,4 +1,4 @@ - foldingathome - LinuxServer.io
Skip to content

linuxserver/foldingathome

Scarf.io pulls GitHub Stars GitHub Release GitHub Package Repository GitLab Container Registry Quay.io Docker Pulls Docker Stars Jenkins Build LSIO CI

Folding@home is a distributed computing project for simulating protein dynamics, including the process of protein folding and the movements of proteins implicated in a variety of diseases. It brings together citizen scientists who volunteer to run simulations of protein dynamics on their personal computers. Insights from this data are helping scientists to better understand biology, and providing new opportunities for developing therapeutics.

foldingathome

Supported Architectures

We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.

Simply pulling lscr.io/linuxserver/foldingathome: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 ❌

Application Setup

This image sets up the Folding@home client. The interface is available at https://app.foldingathome.org.

Before setting up this container, please register for an account on https://app.foldingathome.org and retrieve the account token shown in the account settings. That value should be populated in the ACCOUNT_TOKEN env var.

Once the container is created with the token and the machine name, the instance should be listed in the web app and can be controlled there.

Afterwards, the ACCOUNT_TOKEN and the MACHINE_NAME vars can be removed as the instance will already be associated with the online account and the info stored in the config folder.

Migration from version 7.6

Version 8 of fah-client has been rewritten and has some breaking changes that we can't automatically mitigate in this container.

Unlike v7, v8 no longer bundles a local webgui. The web app is loaded from an online source and can only auto-detect instances that are running on the same machine (bare metal) as the browser. This is not possible in a docker container. Therefore, upgrading to v8 requires registering for an online account, retrieving the account token and setting it in the new env var ACCOUNT_TOKEN, along with a friendly name in MACHINE_NAME.

GPU Hardware Acceleration

Nvidia

Hardware acceleration users for Nvidia will need to install the container runtime provided by Nvidia on their host, instructions can be found here: https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/install-guide.html We automatically add the necessary environment variable that will utilise all the features available on a GPU on the host. Once nvidia container toolkit is installed on your host you will need to re/create the docker container with the nvidia container runtime --runtime=nvidia and add an environment variable -e NVIDIA_VISIBLE_DEVICES=all (can also be set to a specific gpu's UUID, this can be discovered by running nvidia-smi --query-gpu=gpu_name,gpu_uuid --format=csv ). NVIDIA automatically mounts the GPU and drivers from your host into the foldingathome docker container.

Read-Only Operation

This image can be run with a read-only container filesystem. For details please read the docs.

Usage

To help you get started creating a container from this image you can either use docker-compose or the docker cli.

---
+ foldingathome - LinuxServer.io      
 
 
  
 
  
 
 
 
 
  
 
 
 
 
 
  
 
 
 
 
   
linuxserver/foldingathome
 
Scarf.io pulls GitHub Stars GitHub Release GitHub Package Repository GitLab Container Registry Quay.io Docker Pulls Docker Stars Jenkins Build LSIO CI
 
Folding@home is a distributed computing project for simulating protein dynamics, including the process of protein folding and the movements of proteins implicated in a variety of diseases. It brings together citizen scientists who volunteer to run simulations of protein dynamics on their personal computers. Insights from this data are helping scientists to better understand biology, and providing new opportunities for developing therapeutics.
 
foldingathome
 
Supported Architectures
 
We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.
 
Simply pulling lscr.io/linuxserver/foldingathome: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 ❌  
  
 
Application Setup
 
This image sets up the Folding@home client. The interface is available at https://app.foldingathome.org.
 
Before setting up this container, please register for an account on https://app.foldingathome.org and retrieve the account token shown in the account settings. That value should be populated in the ACCOUNT_TOKEN env var.
 
Once the container is created with the token and the machine name, the instance should be listed in the web app and can be controlled there.
 
Afterwards, the ACCOUNT_TOKEN and the MACHINE_NAME vars can be removed as the instance will already be associated with the online account and the info stored in the config folder.
 
Migration from version 7.6
 
Version 8 of fah-client has been rewritten and has some breaking changes that we can't automatically mitigate in this container.
 
Unlike v7, v8 no longer bundles a local webgui. The web app is loaded from an online source and can only auto-detect instances that are running on the same machine (bare metal) as the browser. This is not possible in a docker container. Therefore, upgrading to v8 requires registering for an online account, retrieving the account token and setting it in the new env var ACCOUNT_TOKEN, along with a friendly name in MACHINE_NAME.
 
GPU Hardware Acceleration
 
Nvidia
 
Hardware acceleration users for Nvidia will need to install the container runtime provided by Nvidia on their host, instructions can be found here: https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/install-guide.html We automatically add the necessary environment variable that will utilise all the features available on a GPU on the host. Once nvidia container toolkit is installed on your host you will need to re/create the docker container with the nvidia container runtime --runtime=nvidia and add an environment variable -e NVIDIA_VISIBLE_DEVICES=all (can also be set to a specific gpu's UUID, this can be discovered by running nvidia-smi --query-gpu=gpu_name,gpu_uuid --format=csv ). NVIDIA automatically mounts the GPU and drivers from your host into the foldingathome docker container.
 
Read-Only Operation
 
This image can be run with a read-only container filesystem. For details please read the docs.
 
Usage
 
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
 
 
Info
 
Unless a parameter is flaged as 'optional', it is mandatory and a value must be provided.
 
  
---
 services:
   foldingathome:
     image: lscr.io/linuxserver/foldingathome:latest
@@ -27,7 +27,7 @@
   -v /path/to/foldingathome/data:/config \
   --restart unless-stopped \
   lscr.io/linuxserver/foldingathome:latest
-
 
Parameters
 
Containers 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.
 
Ports (-p)
 
  
 Parameter Function 
   
 7396 Folding@home web gui (redirects to https://app.foldingathome.org). 
  
 
Environment Variables (-e)
 
  
 Env Function 
   
 PUID=1000 for UserID - see below for explanation 
 
 PGID=1000 for GroupID - see below for explanation 
 
 TZ=Etc/UTC specify a timezone to use, see this list. 
 
 ACCOUNT_TOKEN= Register for an account on https://app.foldingathome.org and retrieve account token in settings. Required on first start. 
 
 MACHINE_NAME= Assign a friendly name to this instance (no spaces). Required on first start. 
 
 CLI_ARGS= Optionally pass additional cli arguments to fah-client on container start. 
  
 
Volume Mappings (-v)
 
  
 Volume Function 
   
 /config Where Folding@home should store its database and config. 
  
 
Miscellaneous Options
 
  
 Parameter Function 
   
   
  
 
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__MYVAR=/run/secrets/mysecretvariable
+
 
Parameters
 
Containers 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.
 
Ports (-p)
 
  
 Parameter Function 
   
 7396:7396 Folding@home web gui (redirects to https://app.foldingathome.org). 
  
 
Environment Variables (-e)
 
  
 Env Function 
   
 PUID=1000 for UserID - see below for explanation 
 
 PGID=1000 for GroupID - see below for explanation 
 
 TZ=Etc/UTC specify a timezone to use, see this list. 
 
 ACCOUNT_TOKEN= Register for an account on https://app.foldingathome.org and retrieve account token in settings. Required on first start. 
 
 MACHINE_NAME= Assign a friendly name to this instance (no spaces). Required on first start. 
 
 CLI_ARGS= Optionally pass additional cli arguments to fah-client on container start. 
  
 
Volume Mappings (-v)
 
  
 Volume Function 
   
 /config Where Folding@home should store its database and config. 
  
 
Miscellaneous Options
 
  
 Parameter Function 
   
 --read-only=true Run container with a read-only filesystem. Please read the docs. 
  
 
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__MYVAR=/run/secrets/mysecretvariable
 
 
Will set the environment variable MYVAR based on the contents of the /run/secrets/mysecretvariable file.
 
Umask for running applications
 
For all of our images we 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 between the host OS and the container, we 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 your_user as below:
 
id your_user
 
 
Example output:
 
uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)
 
 
Docker Mods
 
Docker Mods Docker Universal Mods
 
We publish various Docker Mods to enable additional functionality within the containers. The list of Mods available for this image (if any) as well 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 foldingathome /bin/bash
@@ -50,4 +50,4 @@
   --pull \
   -t lscr.io/linuxserver/foldingathome:latest .
 
     
    The ARM variants can be built on x86_64 hardware and vice versa using lscr.io/linuxserver/qemu-static
     
    docker run --rm --privileged lscr.io/linuxserver/qemu-static --reset
-
     
    Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.
     
    Versions
     
       
    • 10.08.24: - Add libexpat1 for Nvidia support.
      •  
    • 25.06.24: - Breaking Changes - Please see the Application Setup section for more details. Restructure image for F@H v8.
      •  
    • 15.06.24: - Rebase to Ubuntu Noble, add optional cli args.
      •  
    • 14.12.22: - Rebase to Ubuntu Jammy, migrate to s6v3.
      •  
    • 15.01.22: - Rebase to Ubuntu Focal. Add arm64v8 builds (cpu only). Increase verbosity about gpu driver permission settings.
      •  
    • 09.01.21: - Add nvidia.icd.
      •  
    • 14.04.20: - Add Folding@home donation links.
      •  
    • 20.03.20: - Initial release.
      •  
      
 
  
  
  
 
 
 
      
\ No newline at end of file
+

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

Versions

  • 10.08.24: - Add libexpat1 for Nvidia support.
  • 25.06.24: - Breaking Changes - Please see the Application Setup section for more details. Restructure image for F@H v8.
  • 15.06.24: - Rebase to Ubuntu Noble, add optional cli args.
  • 14.12.22: - Rebase to Ubuntu Jammy, migrate to s6v3.
  • 15.01.22: - Rebase to Ubuntu Focal. Add arm64v8 builds (cpu only). Increase verbosity about gpu driver permission settings.
  • 09.01.21: - Add nvidia.icd.
  • 14.04.20: - Add Folding@home donation links.
  • 20.03.20: - Initial release.
\ No newline at end of file diff --git a/images/docker-series-troxide/index.html b/images/docker-series-troxide/index.html index 019165f525..5541c8512a 100644 --- a/images/docker-series-troxide/index.html +++ b/images/docker-series-troxide/index.html @@ -48,4 +48,4 @@ --pull \ -t lscr.io/linuxserver/series-troxide:latest .

The ARM variants can be built on x86_64 hardware and vice versa using lscr.io/linuxserver/qemu-static

docker run --rm --privileged lscr.io/linuxserver/qemu-static --reset
-

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

Versions

\ No newline at end of file +

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

Versions

\ No newline at end of file diff --git a/images/docker-thelounge/index.html b/images/docker-thelounge/index.html index 5affdcd8a7..2f67f00b65 100644 --- a/images/docker-thelounge/index.html +++ b/images/docker-thelounge/index.html @@ -1,4 +1,4 @@ - thelounge - LinuxServer.io
Skip to content

linuxserver/thelounge

Scarf.io pulls GitHub Stars GitHub Release GitHub Package Repository GitLab Container Registry Quay.io Docker Pulls Docker Stars Jenkins Build LSIO CI

Thelounge (a fork of shoutIRC) is a web IRC client that you host on your own server.

thelounge

Supported Architectures

We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.

Simply pulling lscr.io/linuxserver/thelounge: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 ❌

Version Tags

This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.

Tag Available Description
latest ✅ Stable releases.
next ✅ Next Pre-Releases.
nightly ✅ Nightly images from commits in master.

Application Setup

  • When the application first runs, it will populate its /config

  • Stop the container

  • Now from the host, edit /config/config.js, wherever you've mapped it

  • In most cases you want the value public: false to allow named users only

  • Setting the two prefetch values to true improves usability, but uses more storage

  • Once you have the configuration you want, save it and start the container again

  • For each user, run the command

  • docker exec -it thelounge s6-setuidgid abc thelounge add <user>

  • You will be prompted to enter a password that will not be echoed.

  • Saving logs to disk is the default, this consumes more space but allows scrollback.

  • To log in to the application, browse to http://<hostip>:9000

  • You should now be prompted for a username and password on the web interface.

  • Once logged in, you can add an IRC network. Some defaults are preset for Freenode

Read-Only Operation

This image can be run with a read-only container filesystem. For details please read the docs.

Usage

To help you get started creating a container from this image you can either use docker-compose or the docker cli.

---
+ thelounge - LinuxServer.io      
 
 
  
 
  
 
 
 
 
  
 
 
 
 
 
  
 
 
 
 
   
linuxserver/thelounge
 
Scarf.io pulls GitHub Stars GitHub Release GitHub Package Repository GitLab Container Registry Quay.io Docker Pulls Docker Stars Jenkins Build LSIO CI
 
Thelounge (a fork of shoutIRC) is a web IRC client that you host on your own server.
 
thelounge
 
Supported Architectures
 
We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.
 
Simply pulling lscr.io/linuxserver/thelounge: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 ❌  
  
 
Version Tags
 
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
 
  
 Tag Available Description 
   
 latest ✅ Stable releases. 
 
 next ✅ Next Pre-Releases. 
 
 nightly ✅ Nightly images from commits in master. 
  
 
Application Setup
 
     
  •  
    When the application first runs, it will populate its /config
     
    •  
  •  
    Stop the container
     
    •  
  •  
    Now from the host, edit /config/config.js, wherever you've mapped it
     
    •  
  •  
    In most cases you want the value public: false to allow named users only
     
    •  
  •  
    Setting the two prefetch values to true improves usability, but uses more storage
     
    •  
  •  
    Once you have the configuration you want, save it and start the container again
     
    •  
  •  
    For each user, run the command
     
    •  
  •  
    docker exec -it thelounge s6-setuidgid abc thelounge add <user>
     
    •  
  •  
    You will be prompted to enter a password that will not be echoed.
     
    •  
  •  
    Saving logs to disk is the default, this consumes more space but allows scrollback.
     
    •  
  •  
    To log in to the application, browse to http://<hostip>:9000
     
    •  
  •  
    You should now be prompted for a username and password on the web interface.
     
    •  
  •  
    Once logged in, you can add an IRC network. Some defaults are preset for Freenode
     
    •  
 
Read-Only Operation
 
This image can be run with a read-only container filesystem. For details please read the docs.
 
Usage
 
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
 
 
Info
 
Unless a parameter is flaged as 'optional', it is mandatory and a value must be provided.
 
  
---
 services:
   thelounge:
     image: lscr.io/linuxserver/thelounge:latest
@@ -21,7 +21,7 @@
   -v /path/to/thelounge/config:/config \
   --restart unless-stopped \
   lscr.io/linuxserver/thelounge:latest
-
 
Parameters
 
Containers 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.
 
Ports (-p)
 
  
 Parameter Function 
   
 9000 Application WebUI 
  
 
Environment Variables (-e)
 
  
 Env Function 
   
 PUID=1000 for UserID - see below for explanation 
 
 PGID=1000 for GroupID - see below for explanation 
 
 TZ=Etc/UTC specify a timezone to use, see this list. 
  
 
Volume Mappings (-v)
 
  
 Volume Function 
   
 /config Persistent config files 
  
 
Miscellaneous Options
 
  
 Parameter Function 
   
   
  
 
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__MYVAR=/run/secrets/mysecretvariable
+
 
Parameters
 
Containers 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.
 
Ports (-p)
 
  
 Parameter Function 
   
 9000:9000 Application WebUI 
  
 
Environment Variables (-e)
 
  
 Env Function 
   
 PUID=1000 for UserID - see below for explanation 
 
 PGID=1000 for GroupID - see below for explanation 
 
 TZ=Etc/UTC specify a timezone to use, see this list. 
  
 
Volume Mappings (-v)
 
  
 Volume Function 
   
 /config Persistent config files 
  
 
Miscellaneous Options
 
  
 Parameter Function 
   
 --read-only=true Run container with a read-only filesystem. Please read the docs. 
  
 
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__MYVAR=/run/secrets/mysecretvariable
 
 
Will set the environment variable MYVAR based on the contents of the /run/secrets/mysecretvariable file.
 
Umask for running applications
 
For all of our images we 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 between the host OS and the container, we 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 your_user as below:
 
id your_user
 
 
Example output:
 
uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)
 
 
Docker Mods
 
Docker Mods Docker Universal Mods
 
We publish various Docker Mods to enable additional functionality within the containers. The list of Mods available for this image (if any) as well 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 thelounge /bin/bash
@@ -44,4 +44,4 @@
   --pull \
   -t lscr.io/linuxserver/thelounge:latest .
 
     
    The ARM variants can be built on x86_64 hardware and vice versa using lscr.io/linuxserver/qemu-static
     
    docker run --rm --privileged lscr.io/linuxserver/qemu-static --reset
-
     
    Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.
     
    Versions
     
       
    • 06.06.24: - Rebase to Alpine 3.20.
      •  
    • 23.12.23: - Rebase to Alpine 3.19.
      •  
    • 25.05.23: - Rebase to Alpine 3.18, deprecate armhf.
      •  
    • 18.12.22: - Rebasing master to alpine 3.17.
      •  
    • 24.10.22: - Fix sqlite3 build.
      •  
    • 12.04.22: - Install from source using yarn.
      •  
    • 11.04.22: - Rebasing to alpine 3.15 and switching from python2-dev to python3-dev for building node sqlite on arm.
      •  
    • 23.01.21: - Rebasing to alpine 3.13.
      •  
    • 02.06.20: - Rebasing to alpine 3.12.
      •  
    • 19.12.19: - Rebasing to alpine 3.11.
      •  
    • 28.06.19: - Rebasing to alpine 3.10.
      •  
    • 15.05.19: - Update Arm variant images to build sqlite3 module.
      •  
    • 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
      •  
    • 22.02.19: - Rebasing to alpine 3.9.
      •  
    • 28.01.19: - Add pipeline logic and multi arch.
      •  
    • 25.08.18: - Use global install, simplifies adding users.
      •  
    • 20.08.18: - Rebase to alpine 3.8.
      •  
    • 06.01.18: - Rebase to alpine 3.7.
      •  
    • 26.05.17: - Rebase to alpine 3.6.
      •  
    • 06.02.17: - Rebase to alpine 3.5.
      •  
    • 14.10.16: - Bump to pickup 2.10 release.
      •  
    • 14.10.16: - Add version layer information.
      •  
    • 11.09.16: - Add layer badges to README.
      •  
    • 31.08.16: - Initial Release.
      •  
      
 
  
  
  
 
 
 
      
\ No newline at end of file
+

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

Versions

  • 06.06.24: - Rebase to Alpine 3.20.
  • 23.12.23: - Rebase to Alpine 3.19.
  • 25.05.23: - Rebase to Alpine 3.18, deprecate armhf.
  • 18.12.22: - Rebasing master to alpine 3.17.
  • 24.10.22: - Fix sqlite3 build.
  • 12.04.22: - Install from source using yarn.
  • 11.04.22: - Rebasing to alpine 3.15 and switching from python2-dev to python3-dev for building node sqlite on arm.
  • 23.01.21: - Rebasing to alpine 3.13.
  • 02.06.20: - Rebasing to alpine 3.12.
  • 19.12.19: - Rebasing to alpine 3.11.
  • 28.06.19: - Rebasing to alpine 3.10.
  • 15.05.19: - Update Arm variant images to build sqlite3 module.
  • 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
  • 22.02.19: - Rebasing to alpine 3.9.
  • 28.01.19: - Add pipeline logic and multi arch.
  • 25.08.18: - Use global install, simplifies adding users.
  • 20.08.18: - Rebase to alpine 3.8.
  • 06.01.18: - Rebase to alpine 3.7.
  • 26.05.17: - Rebase to alpine 3.6.
  • 06.02.17: - Rebase to alpine 3.5.
  • 14.10.16: - Bump to pickup 2.10 release.
  • 14.10.16: - Add version layer information.
  • 11.09.16: - Add layer badges to README.
  • 31.08.16: - Initial Release.
\ No newline at end of file diff --git a/images/docker-ungoogled-chromium/index.html b/images/docker-ungoogled-chromium/index.html index db01eb2762..bff4181ea4 100644 --- a/images/docker-ungoogled-chromium/index.html +++ b/images/docker-ungoogled-chromium/index.html @@ -17,7 +17,7 @@

PRoot Apps is included in all KasmVNC based containers, a list of linuxserver.io supported applications is located HERE.

Native Apps

It is possible to install extra packages during container start using universal-package-install. It might increase starting time significantly. PRoot is preferred.

  environment:
     - DOCKER_MODS=linuxserver/mods:universal-package-install
     - INSTALL_PACKAGES=libfuse2|git|gdb
-

Usage

To help you get started creating a container from this image you can either use docker-compose or the docker cli.

---
+

Usage

To help you get started creating a container from this image you can either use docker-compose or the docker cli.

Info

Unless a parameter is flaged as 'optional', it is mandatory and a value must be provided.

---
 services:
   ungoogled-chromium:
     image: lscr.io/linuxserver/ungoogled-chromium:latest
@@ -49,7 +49,7 @@
   --shm-size="1gb" \
   --restart unless-stopped \
   lscr.io/linuxserver/ungoogled-chromium:latest
-

Parameters

Containers 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.

Ports (-p)

Parameter Function
3000 Ungoogled Chromium desktop gui.
3001 HTTPS Ungoogled Chromium desktop gui.

Environment Variables (-e)

Env Function
PUID=1000 for UserID - see below for explanation
PGID=1000 for GroupID - see below for explanation
TZ=Etc/UTC specify a timezone to use, see this list.
CHROME_CLI=https://www.linuxserver.io/ Specify one or multiple Chromium CLI flags, this string will be passed to the application in full.

Volume Mappings (-v)

Volume Function
/config Users home directory in the container, stores local files and settings

Miscellaneous Options

Parameter Function
--shm-size= This is needed for any modern website to function like youtube.
--security-opt seccomp=unconfined For Docker Engine only, many modern gui apps need this to function on older hosts as syscalls are unknown to Docker. Ungoogled Chromium runs in no-sandbox test mode without it.

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__MYVAR=/run/secrets/mysecretvariable
+

Parameters

Containers 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.

Ports (-p)

Parameter Function
3000:3000 Ungoogled Chromium desktop gui.
3001:3001 HTTPS Ungoogled Chromium desktop gui.

Environment Variables (-e)

Env Function
PUID=1000 for UserID - see below for explanation
PGID=1000 for GroupID - see below for explanation
TZ=Etc/UTC specify a timezone to use, see this list.
CHROME_CLI=https://www.linuxserver.io/ Specify one or multiple Chromium CLI flags, this string will be passed to the application in full.

Volume Mappings (-v)

Volume Function
/config Users home directory in the container, stores local files and settings

Miscellaneous Options

Parameter Function
--shm-size= This is needed for any modern website to function like youtube.
--security-opt seccomp=unconfined For Docker Engine only, many modern gui apps need this to function on older hosts as syscalls are unknown to Docker. Ungoogled Chromium runs in no-sandbox test mode without it.

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__MYVAR=/run/secrets/mysecretvariable

Will set the environment variable MYVAR based on the contents of the /run/secrets/mysecretvariable file.

Umask for running applications

For all of our images we 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 between the host OS and the container, we 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 your_user as below:

id your_user

Example output:

uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)

Docker Mods

Docker Mods Docker Universal Mods

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

Support Info