Merge pull request #52 from linuxserver/kasm-readme
This commit is contained in:
14
README.md
14
README.md
@@ -57,6 +57,15 @@ The architectures supported by this image are:
|
||||
| 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 | ✅ | Latest releases using the selkies base |
|
||||
| kasm | ✅ | Latest releases using the kasmvnc base |
|
||||
|
||||
## Application Setup
|
||||
|
||||
The application can be accessed at:
|
||||
@@ -132,7 +141,7 @@ services:
|
||||
- TZ=Etc/UTC
|
||||
- CHROME_CLI=https://www.linuxserver.io/ #optional
|
||||
volumes:
|
||||
- /path/to/config:/config
|
||||
- /path/to/chromium/config:/config
|
||||
ports:
|
||||
- 3000:3000
|
||||
- 3001:3001
|
||||
@@ -152,7 +161,7 @@ docker run -d \
|
||||
-e CHROME_CLI=https://www.linuxserver.io/ `#optional` \
|
||||
-p 3000:3000 \
|
||||
-p 3001:3001 \
|
||||
-v /path/to/config:/config \
|
||||
-v /path/to/chromium/config:/config \
|
||||
--shm-size="1gb" \
|
||||
--restart unless-stopped \
|
||||
lscr.io/linuxserver/chromium:latest
|
||||
@@ -336,6 +345,7 @@ Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64
|
||||
|
||||
## Versions
|
||||
|
||||
* **01.07.25:** - Add Kasm branch.
|
||||
* **24.06.25:** - Rebase to Selkies.
|
||||
* **03.04.25:** - Update chromium launch options to improve performance.
|
||||
* **10.02.24:** - Update Readme with new env vars and ingest proper PWA icon.
|
||||
|
||||
@@ -13,16 +13,16 @@ available_architectures:
|
||||
- {arch: "{{ arch_x86_64 }}", tag: "latest"}
|
||||
- {arch: "{{ arch_arm64 }}", tag: "arm64v8-latest"}
|
||||
# development version
|
||||
development_versions: false
|
||||
development_versions: true
|
||||
development_versions_items:
|
||||
- {tag: "latest", desc: "Latest releases using the selkies base"}
|
||||
- {tag: "kasm", desc: "Latest releases using the kasmvnc base"}
|
||||
# container parameters
|
||||
common_param_env_vars_enabled: true
|
||||
param_container_name: "{{ project_name }}"
|
||||
param_usage_include_env: true
|
||||
param_env_vars:
|
||||
- {env_var: "TZ", env_value: "Europe/London", desc: "Specify a timezone to use EG Europe/London."}
|
||||
param_usage_include_vols: true
|
||||
param_volumes:
|
||||
- {vol_path: "/config", vol_host_path: "/path/to/config", desc: "Users home directory in the container, stores local files and settings"}
|
||||
- {vol_path: "/config", vol_host_path: "/path/to/{{ project_name }}/config", desc: "Users home directory in the container, stores local files and settings"}
|
||||
param_usage_include_ports: true
|
||||
param_ports:
|
||||
- {external_port: "3000", internal_port: "3000", port_desc: "HTTP Chromium desktop gui, must be proxied."}
|
||||
@@ -146,6 +146,7 @@ init_diagram: |
|
||||
"chromium:latest" <- Base Images
|
||||
# changelog
|
||||
changelogs:
|
||||
- {date: "01.07.25:", desc: "Add Kasm branch."}
|
||||
- {date: "24.06.25:", desc: "Rebase to Selkies."}
|
||||
- {date: "03.04.25:", desc: "Update chromium launch options to improve performance."}
|
||||
- {date: "10.02.24:", desc: "Update Readme with new env vars and ingest proper PWA icon."}
|
||||
|
||||
Reference in New Issue
Block a user