mirror of
https://github.com/linuxserver/docker-webtop.git
synced 2025-07-27 15:44:29 +02:00
Fix a couple of readme typos
This commit is contained in:
TheSpad
parent
8de307d433
commit
98fda6ee10
14
.github/CONTRIBUTING.md
vendored
14
.github/CONTRIBUTING.md
vendored
@ -1,4 +1,4 @@
|
||||
# Contributing to webtop
|
||||
# Contributing to Webtop
|
||||
|
||||
## Gotchas
|
||||
|
||||
@ -24,10 +24,10 @@
|
||||
## Readme
|
||||
|
||||
If you would like to change our readme, please __**do not**__ directly edit the readme, as it is auto-generated on each commit.
|
||||
Instead edit the [readme-vars.yml](https://github.com/linuxserver/docker-webtop/edit/master/readme-vars.yml).
|
||||
Instead edit the [readme-vars.yml](https://github.com/linuxserver/docker-Webtop/edit/master/readme-vars.yml).
|
||||
|
||||
These variables are used in a template for our [Jenkins Builder](https://github.com/linuxserver/docker-jenkins-builder) as part of an ansible play.
|
||||
Most of these variables are also carried over to [docs.linuxserver.io](https://docs.linuxserver.io/images/docker-webtop)
|
||||
Most of these variables are also carried over to [docs.linuxserver.io](https://docs.linuxserver.io/images/docker-Webtop)
|
||||
|
||||
### Fixing typos or clarify the text in the readme
|
||||
|
||||
@ -97,12 +97,12 @@ If you are proposing additional packages to be added, ensure that you added the
|
||||
### Testing your changes
|
||||
|
||||
```bash
|
||||
git clone https://github.com/linuxserver/docker-webtop.git
|
||||
cd docker-webtop
|
||||
git clone https://github.com/linuxserver/docker-Webtop.git
|
||||
cd docker-Webtop
|
||||
docker build \
|
||||
--no-cache \
|
||||
--pull \
|
||||
-t linuxserver/webtop:latest .
|
||||
-t linuxserver/Webtop:latest .
|
||||
```
|
||||
|
||||
The ARM variants can be built on x86_64 hardware using `multiarch/qemu-user-static`
|
||||
@ -115,7 +115,7 @@ Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64
|
||||
|
||||
## Update the changelog
|
||||
|
||||
If you are modifying the Dockerfiles or any of the startup scripts in [root](https://github.com/linuxserver/docker-webtop/tree/master/root), add an entry to the changelog
|
||||
If you are modifying the Dockerfiles or any of the startup scripts in [root](https://github.com/linuxserver/docker-Webtop/tree/master/root), add an entry to the changelog
|
||||
|
||||
```yml
|
||||
changelogs:
|
||||
|
||||
2
.github/ISSUE_TEMPLATE/config.yml
vendored
2
.github/ISSUE_TEMPLATE/config.yml
vendored
@ -9,5 +9,5 @@ contact_links:
|
||||
about: Post on our community forum.
|
||||
|
||||
- name: Documentation
|
||||
url: https://docs.linuxserver.io/images/docker-webtop
|
||||
url: https://docs.linuxserver.io/images/docker-Webtop
|
||||
about: Documentation - information about all of our containers.
|
||||
|
||||
2
.github/PULL_REQUEST_TEMPLATE.md
vendored
2
.github/PULL_REQUEST_TEMPLATE.md
vendored
@ -21,7 +21,7 @@
|
||||
|
||||
------------------------------
|
||||
|
||||
- [ ] I have read the [contributing](https://github.com/linuxserver/docker-webtop/blob/master/.github/CONTRIBUTING.md) guideline and understand that I have made the correct modifications
|
||||
- [ ] I have read the [contributing](https://github.com/linuxserver/docker-Webtop/blob/master/.github/CONTRIBUTING.md) guideline and understand that I have made the correct modifications
|
||||
|
||||
------------------------------
|
||||
|
||||
|
||||
2
.github/workflows/call_issues_cron.yml
vendored
2
.github/workflows/call_issues_cron.yml
vendored
@ -1,7 +1,7 @@
|
||||
name: Mark stale issues and pull requests
|
||||
on:
|
||||
schedule:
|
||||
- cron: '36 11 * * *'
|
||||
- cron: '8 11 * * *'
|
||||
workflow_dispatch:
|
||||
|
||||
jobs:
|
||||
|
||||
@ -2,7 +2,7 @@ name: External Trigger Scheduler
|
||||
|
||||
on:
|
||||
schedule:
|
||||
- cron: '27 * * * *'
|
||||
- cron: '46 * * * *'
|
||||
workflow_dispatch:
|
||||
|
||||
jobs:
|
||||
@ -21,19 +21,19 @@ jobs:
|
||||
do
|
||||
br=$(echo "$br" | sed 's|origin/||g')
|
||||
echo "**** Evaluating branch ${br} ****"
|
||||
ls_jenkins_vars=$(curl -sX GET https://raw.githubusercontent.com/linuxserver/docker-webtop/${br}/jenkins-vars.yml)
|
||||
ls_jenkins_vars=$(curl -sX GET https://raw.githubusercontent.com/linuxserver/docker-Webtop/${br}/jenkins-vars.yml)
|
||||
ls_branch=$(echo "${ls_jenkins_vars}" | yq -r '.ls_branch')
|
||||
ls_trigger=$(echo "${ls_jenkins_vars}" | yq -r '.external_type')
|
||||
if [[ "${br}" == "${ls_branch}" ]] && [[ "${ls_trigger}" != "os" ]]; then
|
||||
echo "**** Branch ${br} appears to be live and trigger is not os; checking workflow. ****"
|
||||
if curl -sfX GET https://raw.githubusercontent.com/linuxserver/docker-webtop/${br}/.github/workflows/external_trigger.yml > /dev/null 2>&1; then
|
||||
if curl -sfX GET https://raw.githubusercontent.com/linuxserver/docker-Webtop/${br}/.github/workflows/external_trigger.yml > /dev/null 2>&1; then
|
||||
echo "**** Workflow exists. Triggering external trigger workflow for branch ${br} ****."
|
||||
echo "Triggering external trigger workflow for branch ${br}" >> $GITHUB_STEP_SUMMARY
|
||||
curl -iX POST \
|
||||
-H "Authorization: token ${{ secrets.CR_PAT }}" \
|
||||
-H "Accept: application/vnd.github.v3+json" \
|
||||
-d "{\"ref\":\"refs/heads/${br}\"}" \
|
||||
https://api.github.com/repos/linuxserver/docker-webtop/actions/workflows/external_trigger.yml/dispatches
|
||||
https://api.github.com/repos/linuxserver/docker-Webtop/actions/workflows/external_trigger.yml/dispatches
|
||||
else
|
||||
echo "**** Workflow doesn't exist; skipping trigger. ****"
|
||||
echo "Skipping branch ${br} due to no external trigger workflow present." >> $GITHUB_STEP_SUMMARY
|
||||
|
||||
2
.github/workflows/greetings.yml
vendored
2
.github/workflows/greetings.yml
vendored
@ -9,5 +9,5 @@ jobs:
|
||||
- uses: actions/first-interaction@v1
|
||||
with:
|
||||
issue-message: 'Thanks for opening your first issue here! Be sure to follow the relevant issue templates, or risk having this issue marked as invalid.'
|
||||
pr-message: 'Thanks for opening this pull request! Be sure to follow the [pull request template](https://github.com/linuxserver/docker-webtop/blob/master/.github/PULL_REQUEST_TEMPLATE.md)!'
|
||||
pr-message: 'Thanks for opening this pull request! Be sure to follow the [pull request template](https://github.com/linuxserver/docker-Webtop/blob/master/.github/PULL_REQUEST_TEMPLATE.md)!'
|
||||
repo-token: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
||||
4
.github/workflows/package_trigger.yml
vendored
4
.github/workflows/package_trigger.yml
vendored
@ -17,7 +17,7 @@ jobs:
|
||||
echo "Github secret \`PAUSE_PACKAGE_TRIGGER_WEBTOP_MASTER\` is set; skipping trigger." >> $GITHUB_STEP_SUMMARY
|
||||
exit 0
|
||||
fi
|
||||
if [ $(curl -s https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-webtop/job/master/lastBuild/api/json | jq -r '.building') == "true" ]; then
|
||||
if [ $(curl -s https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-Webtop/job/master/lastBuild/api/json | jq -r '.building') == "true" ]; then
|
||||
echo "**** There already seems to be an active build on Jenkins; skipping package trigger ****"
|
||||
echo "There already seems to be an active build on Jenkins; skipping package trigger" >> $GITHUB_STEP_SUMMARY
|
||||
exit 0
|
||||
@ -25,7 +25,7 @@ jobs:
|
||||
echo "**** Package trigger running off of master branch. To disable, set a Github secret named \"PAUSE_PACKAGE_TRIGGER_WEBTOP_MASTER\". ****"
|
||||
echo "Package trigger running off of master branch. To disable, set a Github secret named \`PAUSE_PACKAGE_TRIGGER_WEBTOP_MASTER\`" >> $GITHUB_STEP_SUMMARY
|
||||
response=$(curl -iX POST \
|
||||
https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-webtop/job/master/buildWithParameters?PACKAGE_CHECK=true \
|
||||
https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-Webtop/job/master/buildWithParameters?PACKAGE_CHECK=true \
|
||||
--user ${{ secrets.JENKINS_USER }}:${{ secrets.JENKINS_TOKEN }} | grep -i location | sed "s|^[L|l]ocation: \(.*\)|\1|")
|
||||
echo "**** Jenkins job queue url: ${response%$'\r'} ****"
|
||||
echo "**** Sleeping 10 seconds until job starts ****"
|
||||
|
||||
10
.github/workflows/package_trigger_scheduler.yml
vendored
10
.github/workflows/package_trigger_scheduler.yml
vendored
@ -2,7 +2,7 @@ name: Package Trigger Scheduler
|
||||
|
||||
on:
|
||||
schedule:
|
||||
- cron: '19 3 * * 2'
|
||||
- cron: '36 8 * * 6'
|
||||
workflow_dispatch:
|
||||
|
||||
jobs:
|
||||
@ -21,10 +21,10 @@ jobs:
|
||||
do
|
||||
br=$(echo "$br" | sed 's|origin/||g')
|
||||
echo "**** Evaluating branch ${br} ****"
|
||||
ls_branch=$(curl -sX GET https://raw.githubusercontent.com/linuxserver/docker-webtop/${br}/jenkins-vars.yml | yq -r '.ls_branch')
|
||||
ls_branch=$(curl -sX GET https://raw.githubusercontent.com/linuxserver/docker-Webtop/${br}/jenkins-vars.yml | yq -r '.ls_branch')
|
||||
if [ "${br}" == "${ls_branch}" ]; then
|
||||
echo "**** Branch ${br} appears to be live; checking workflow. ****"
|
||||
if curl -sfX GET https://raw.githubusercontent.com/linuxserver/docker-webtop/${br}/.github/workflows/package_trigger.yml > /dev/null 2>&1; then
|
||||
if curl -sfX GET https://raw.githubusercontent.com/linuxserver/docker-Webtop/${br}/.github/workflows/package_trigger.yml > /dev/null 2>&1; then
|
||||
echo "**** Workflow exists. Triggering package trigger workflow for branch ${br}. ****"
|
||||
echo "Triggering package trigger workflow for branch ${br}" >> $GITHUB_STEP_SUMMARY
|
||||
triggered_branches="${triggered_branches}${br} "
|
||||
@ -32,7 +32,7 @@ jobs:
|
||||
-H "Authorization: token ${{ secrets.CR_PAT }}" \
|
||||
-H "Accept: application/vnd.github.v3+json" \
|
||||
-d "{\"ref\":\"refs/heads/${br}\"}" \
|
||||
https://api.github.com/repos/linuxserver/docker-webtop/actions/workflows/package_trigger.yml/dispatches
|
||||
https://api.github.com/repos/linuxserver/docker-Webtop/actions/workflows/package_trigger.yml/dispatches
|
||||
sleep 30
|
||||
else
|
||||
echo "**** Workflow doesn't exist; skipping trigger. ****"
|
||||
@ -46,5 +46,5 @@ jobs:
|
||||
echo "**** Package check build(s) triggered for branch(es): ${triggered_branches} ****"
|
||||
echo "**** Notifying Discord ****"
|
||||
curl -X POST -H "Content-Type: application/json" --data '{"avatar_url": "https://cdn.discordapp.com/avatars/354986384542662657/df91181b3f1cf0ef1592fbe18e0962d7.png","embeds": [{"color": 9802903,
|
||||
"description": "**Package Check Build(s) Triggered for webtop** \n**Branch(es):** '"${triggered_branches}"' \n**Build URL:** '"https://ci.linuxserver.io/blue/organizations/jenkins/Docker-Pipeline-Builders%2Fdocker-webtop/activity/"' \n"}],
|
||||
"description": "**Package Check Build(s) Triggered for Webtop** \n**Branch(es):** '"${triggered_branches}"' \n**Build URL:** '"https://ci.linuxserver.io/blue/organizations/jenkins/Docker-Pipeline-Builders%2Fdocker-Webtop/activity/"' \n"}],
|
||||
"username": "Github Actions"}' ${{ secrets.DISCORD_WEBHOOK }}
|
||||
|
||||
28
Jenkinsfile
vendored
28
Jenkinsfile
vendored
@ -434,18 +434,18 @@ pipeline {
|
||||
}
|
||||
steps{
|
||||
sh '''#! /bin/bash
|
||||
PACKAGE_UUID=$(curl -X GET -H "Authorization: Bearer ${SCARF_TOKEN}" https://scarf.sh/api/v1/organizations/linuxserver-ci/packages | jq -r '.[] | select(.name=="linuxserver/webtop") | .uuid' || :)
|
||||
PACKAGE_UUID=$(curl -X GET -H "Authorization: Bearer ${SCARF_TOKEN}" https://scarf.sh/api/v1/organizations/linuxserver-ci/packages | jq -r '.[] | select(.name=="linuxserver/Webtop") | .uuid' || :)
|
||||
if [ -z "${PACKAGE_UUID}" ]; then
|
||||
echo "Adding package to Scarf.sh"
|
||||
curl -sX POST https://scarf.sh/api/v1/organizations/linuxserver-ci/packages \
|
||||
-H "Authorization: Bearer ${SCARF_TOKEN}" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"name":"linuxserver/webtop",\
|
||||
-d '{"name":"linuxserver/Webtop",\
|
||||
"shortDescription":"example description",\
|
||||
"libraryType":"docker",\
|
||||
"website":"https://github.com/linuxserver/docker-webtop",\
|
||||
"backendUrl":"https://ghcr.io/linuxserver/webtop",\
|
||||
"publicUrl":"https://lscr.io/linuxserver/webtop"}' || :
|
||||
"website":"https://github.com/linuxserver/docker-Webtop",\
|
||||
"backendUrl":"https://ghcr.io/linuxserver/Webtop",\
|
||||
"publicUrl":"https://lscr.io/linuxserver/Webtop"}' || :
|
||||
else
|
||||
echo "Package already exists on Scarf.sh"
|
||||
fi
|
||||
@ -469,9 +469,9 @@ pipeline {
|
||||
sh "docker buildx build \
|
||||
--label \"org.opencontainers.image.created=${GITHUB_DATE}\" \
|
||||
--label \"org.opencontainers.image.authors=linuxserver.io\" \
|
||||
--label \"org.opencontainers.image.url=https://github.com/linuxserver/docker-webtop/packages\" \
|
||||
--label \"org.opencontainers.image.documentation=https://docs.linuxserver.io/images/docker-webtop\" \
|
||||
--label \"org.opencontainers.image.source=https://github.com/linuxserver/docker-webtop\" \
|
||||
--label \"org.opencontainers.image.url=https://github.com/linuxserver/docker-Webtop/packages\" \
|
||||
--label \"org.opencontainers.image.documentation=https://docs.linuxserver.io/images/docker-Webtop\" \
|
||||
--label \"org.opencontainers.image.source=https://github.com/linuxserver/docker-Webtop\" \
|
||||
--label \"org.opencontainers.image.version=${EXT_RELEASE_CLEAN}-ls${LS_TAG_NUMBER}\" \
|
||||
--label \"org.opencontainers.image.revision=${COMMIT_SHA}\" \
|
||||
--label \"org.opencontainers.image.vendor=linuxserver.io\" \
|
||||
@ -500,9 +500,9 @@ pipeline {
|
||||
sh "docker buildx build \
|
||||
--label \"org.opencontainers.image.created=${GITHUB_DATE}\" \
|
||||
--label \"org.opencontainers.image.authors=linuxserver.io\" \
|
||||
--label \"org.opencontainers.image.url=https://github.com/linuxserver/docker-webtop/packages\" \
|
||||
--label \"org.opencontainers.image.documentation=https://docs.linuxserver.io/images/docker-webtop\" \
|
||||
--label \"org.opencontainers.image.source=https://github.com/linuxserver/docker-webtop\" \
|
||||
--label \"org.opencontainers.image.url=https://github.com/linuxserver/docker-Webtop/packages\" \
|
||||
--label \"org.opencontainers.image.documentation=https://docs.linuxserver.io/images/docker-Webtop\" \
|
||||
--label \"org.opencontainers.image.source=https://github.com/linuxserver/docker-Webtop\" \
|
||||
--label \"org.opencontainers.image.version=${EXT_RELEASE_CLEAN}-ls${LS_TAG_NUMBER}\" \
|
||||
--label \"org.opencontainers.image.revision=${COMMIT_SHA}\" \
|
||||
--label \"org.opencontainers.image.vendor=linuxserver.io\" \
|
||||
@ -528,9 +528,9 @@ pipeline {
|
||||
sh "docker buildx build \
|
||||
--label \"org.opencontainers.image.created=${GITHUB_DATE}\" \
|
||||
--label \"org.opencontainers.image.authors=linuxserver.io\" \
|
||||
--label \"org.opencontainers.image.url=https://github.com/linuxserver/docker-webtop/packages\" \
|
||||
--label \"org.opencontainers.image.documentation=https://docs.linuxserver.io/images/docker-webtop\" \
|
||||
--label \"org.opencontainers.image.source=https://github.com/linuxserver/docker-webtop\" \
|
||||
--label \"org.opencontainers.image.url=https://github.com/linuxserver/docker-Webtop/packages\" \
|
||||
--label \"org.opencontainers.image.documentation=https://docs.linuxserver.io/images/docker-Webtop\" \
|
||||
--label \"org.opencontainers.image.source=https://github.com/linuxserver/docker-Webtop\" \
|
||||
--label \"org.opencontainers.image.version=${EXT_RELEASE_CLEAN}-ls${LS_TAG_NUMBER}\" \
|
||||
--label \"org.opencontainers.image.revision=${COMMIT_SHA}\" \
|
||||
--label \"org.opencontainers.image.vendor=linuxserver.io\" \
|
||||
|
||||
70
README.md
70
README.md
@ -1,5 +1,5 @@
|
||||
<!-- DO NOT EDIT THIS FILE MANUALLY -->
|
||||
<!-- Please read the https://github.com/linuxserver/docker-webtop/blob/master/.github/CONTRIBUTING.md -->
|
||||
<!-- Please read the https://github.com/linuxserver/docker-Webtop/blob/master/.github/CONTRIBUTING.md -->
|
||||
|
||||
[](https://linuxserver.io)
|
||||
|
||||
@ -27,28 +27,28 @@ Find us at:
|
||||
* [GitHub](https://github.com/linuxserver) - view the source for all of our repositories.
|
||||
* [Open Collective](https://opencollective.com/linuxserver) - please consider helping us by either donating or contributing to our budget
|
||||
|
||||
# [linuxserver/webtop](https://github.com/linuxserver/docker-webtop)
|
||||
# [linuxserver/Webtop](https://github.com/linuxserver/docker-Webtop)
|
||||
|
||||
[](https://scarf.sh/gateway/linuxserver-ci/docker/linuxserver%2Fwebtop)
|
||||
[](https://github.com/linuxserver/docker-webtop)
|
||||
[](https://github.com/linuxserver/docker-webtop/releases)
|
||||
[](https://github.com/linuxserver/docker-webtop/packages)
|
||||
[](https://gitlab.com/linuxserver.io/docker-webtop/container_registry)
|
||||
[](https://quay.io/repository/linuxserver.io/webtop)
|
||||
[](https://hub.docker.com/r/linuxserver/webtop)
|
||||
[](https://hub.docker.com/r/linuxserver/webtop)
|
||||
[](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-webtop/job/master/)
|
||||
[](https://ci-tests.linuxserver.io/linuxserver/webtop/latest/index.html)
|
||||
[](https://scarf.sh/gateway/linuxserver-ci/docker/linuxserver%2FWebtop)
|
||||
[](https://github.com/linuxserver/docker-Webtop)
|
||||
[](https://github.com/linuxserver/docker-Webtop/releases)
|
||||
[](https://github.com/linuxserver/docker-Webtop/packages)
|
||||
[](https://gitlab.com/linuxserver.io/docker-Webtop/container_registry)
|
||||
[](https://quay.io/repository/linuxserver.io/Webtop)
|
||||
[](https://hub.docker.com/r/linuxserver/Webtop)
|
||||
[](https://hub.docker.com/r/linuxserver/Webtop)
|
||||
[](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-Webtop/job/master/)
|
||||
[](https://ci-tests.linuxserver.io/linuxserver/Webtop/latest/index.html)
|
||||
|
||||
[Webtop](https://github.com/linuxserver/docker-webtop) - Alpine, Ubuntu, Fedora, and Arch based containers containing full desktop environments in officially supported flavors accessible via any modern web browser.
|
||||
|
||||
[](https://github.com/linuxserver/docker-webtop)
|
||||
[](https://github.com/linuxserver/docker-webtop)
|
||||
|
||||
## Supported Architectures
|
||||
|
||||
We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/).
|
||||
|
||||
Simply pulling `lscr.io/linuxserver/webtop:latest` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
|
||||
Simply pulling `lscr.io/linuxserver/Webtop: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:
|
||||
|
||||
@ -103,7 +103,7 @@ The Webtop can be accessed at:
|
||||
|
||||
**Modern GUI desktop apps (including some flavors terminals) have issues with the latest Docker and syscall compatibility, you can use Docker with the `--security-opt seccomp=unconfined` setting to allow these syscalls**
|
||||
|
||||
**Unlike our other containers these Desktops are not designed to be upgraded by Docker, you will keep your home directoy but anything you installed system level will be lost if you upgrade an existing container. To keep packages up to date instead use Ubuntu/Debians's own apt, Alpine's apk, Fedora's dnf, or Arch's pacman program**
|
||||
**Unlike our other containers these Desktops are not designed to be upgraded by Docker, you will keep your home directory but anything you installed system level will be lost if you upgrade an existing container. To keep packages up to date instead use Ubuntu/Debians's own apt, Alpine's apk, Fedora's dnf, or Arch's pacman program**
|
||||
|
||||
### Options in all KasmVNC based GUI containers
|
||||
|
||||
@ -129,7 +129,7 @@ This container is based on [Docker Baseimage KasmVNC](https://github.com/linuxse
|
||||
| :----: | --- |
|
||||
| `--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) |
|
||||
| `--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 applications. Only **Open Source** drivers are supported IE (Intel,AMDGPU,Radeon,ATI,Nouveau) |
|
||||
|
||||
### Language Support - Internationalization
|
||||
|
||||
@ -160,9 +160,9 @@ Here are some example snippets to help you get started creating a container.
|
||||
---
|
||||
version: "2.1"
|
||||
services:
|
||||
webtop:
|
||||
image: lscr.io/linuxserver/webtop:latest
|
||||
container_name: webtop
|
||||
Webtop:
|
||||
image: lscr.io/linuxserver/Webtop:latest
|
||||
container_name: Webtop
|
||||
security_opt:
|
||||
- seccomp:unconfined #optional
|
||||
environment:
|
||||
@ -187,7 +187,7 @@ services:
|
||||
|
||||
```bash
|
||||
docker run -d \
|
||||
--name=webtop \
|
||||
--name=Webtop \
|
||||
--security-opt seccomp=unconfined `#optional` \
|
||||
-e PUID=1000 \
|
||||
-e PGID=1000 \
|
||||
@ -201,7 +201,7 @@ docker run -d \
|
||||
--device /dev/dri:/dev/dri `#optional` \
|
||||
--shm-size="1gb" `#optional` \
|
||||
--restart unless-stopped \
|
||||
lscr.io/linuxserver/webtop:latest
|
||||
lscr.io/linuxserver/Webtop:latest
|
||||
|
||||
```
|
||||
|
||||
@ -256,18 +256,18 @@ In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as bel
|
||||
|
||||
## Docker Mods
|
||||
|
||||
[](https://mods.linuxserver.io/?mod=webtop "view available mods for this container.") [](https://mods.linuxserver.io/?mod=universal "view available universal mods.")
|
||||
[](https://mods.linuxserver.io/?mod=Webtop "view available mods for this container.") [](https://mods.linuxserver.io/?mod=universal "view available universal mods.")
|
||||
|
||||
We publish various [Docker Mods](https://github.com/linuxserver/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 webtop /bin/bash`
|
||||
* To monitor the logs of the container in realtime: `docker logs -f webtop`
|
||||
* Shell access whilst the container is running: `docker exec -it Webtop /bin/bash`
|
||||
* To monitor the logs of the container in realtime: `docker logs -f Webtop`
|
||||
* container version number
|
||||
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' webtop`
|
||||
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' Webtop`
|
||||
* image version number
|
||||
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/webtop:latest`
|
||||
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/Webtop:latest`
|
||||
|
||||
## Updating Info
|
||||
|
||||
@ -278,16 +278,16 @@ Below are the instructions for updating containers:
|
||||
### Via Docker Compose
|
||||
|
||||
* Update all images: `docker-compose pull`
|
||||
* or update a single image: `docker-compose pull webtop`
|
||||
* or update a single image: `docker-compose pull Webtop`
|
||||
* Let compose update all containers as necessary: `docker-compose up -d`
|
||||
* or update a single container: `docker-compose up -d webtop`
|
||||
* or update a single container: `docker-compose up -d Webtop`
|
||||
* You can also remove the old dangling images: `docker image prune`
|
||||
|
||||
### Via Docker Run
|
||||
|
||||
* Update the image: `docker pull lscr.io/linuxserver/webtop:latest`
|
||||
* Stop the running container: `docker stop webtop`
|
||||
* Delete the container: `docker rm webtop`
|
||||
* Update the image: `docker pull lscr.io/linuxserver/Webtop:latest`
|
||||
* Stop the running container: `docker stop Webtop`
|
||||
* Delete the container: `docker rm Webtop`
|
||||
* 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`
|
||||
|
||||
@ -299,7 +299,7 @@ Below are the instructions for updating containers:
|
||||
docker run --rm \
|
||||
-v /var/run/docker.sock:/var/run/docker.sock \
|
||||
containrrr/watchtower \
|
||||
--run-once webtop
|
||||
--run-once Webtop
|
||||
```
|
||||
|
||||
* You can also remove the old dangling images: `docker image prune`
|
||||
@ -315,12 +315,12 @@ Below are the instructions for updating containers:
|
||||
If you want to make local modifications to these images for development purposes or just to customize the logic:
|
||||
|
||||
```bash
|
||||
git clone https://github.com/linuxserver/docker-webtop.git
|
||||
cd docker-webtop
|
||||
git clone https://github.com/linuxserver/docker-Webtop.git
|
||||
cd docker-Webtop
|
||||
docker build \
|
||||
--no-cache \
|
||||
--pull \
|
||||
-t lscr.io/linuxserver/webtop:latest .
|
||||
-t lscr.io/linuxserver/Webtop:latest .
|
||||
```
|
||||
|
||||
The ARM variants can be built on x86_64 hardware using `multiarch/qemu-user-static`
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
|
||||
# project information
|
||||
project_name: webtop
|
||||
project_name: Webtop
|
||||
project_url: "https://github.com/linuxserver/docker-webtop"
|
||||
project_logo: "https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/webtop-logo.png"
|
||||
project_blurb: |
|
||||
@ -86,7 +86,7 @@ app_setup_block: |
|
||||
|
||||
**Modern GUI desktop apps (including some flavors terminals) have issues with the latest Docker and syscall compatibility, you can use Docker with the `--security-opt seccomp=unconfined` setting to allow these syscalls**
|
||||
|
||||
**Unlike our other containers these Desktops are not designed to be upgraded by Docker, you will keep your home directoy but anything you installed system level will be lost if you upgrade an existing container. To keep packages up to date instead use Ubuntu/Debians's own apt, Alpine's apk, Fedora's dnf, or Arch's pacman program**
|
||||
**Unlike our other containers these Desktops are not designed to be upgraded by Docker, you will keep your home directory but anything you installed system level will be lost if you upgrade an existing container. To keep packages up to date instead use Ubuntu/Debians's own apt, Alpine's apk, Fedora's dnf, or Arch's pacman program**
|
||||
|
||||
### Options in all KasmVNC based GUI containers
|
||||
|
||||
@ -112,7 +112,7 @@ app_setup_block: |
|
||||
| :----: | --- |
|
||||
| `--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) |
|
||||
| `--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 applications. Only **Open Source** drivers are supported IE (Intel,AMDGPU,Radeon,ATI,Nouveau) |
|
||||
|
||||
### Language Support - Internationalization
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user