NickBland/xpipe-selkies
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fixes

Browse Source
This commit is contained in:
Christopher Schnick
2025-02-16 00:29:53 +01:00
parent e8882120e9
commit 6227f0539b
2 changed files with 10 additions and 87 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
Dockerfile
View File

@@ -43,14 +43,6 @@ RUN echo "**** install base packages ****" && \
/var/tmp/* \
/tmp/*
RUN echo "**** VsCode **** ($TARGETPLATFORM)" && \
if [ "$TARGETPLATFORM" = "linux/amd64" ]; then VSCODE_LINK="https://code.visualstudio.com/sha/download?build=stable&os=linux-deb-x64"; else VSCODE_LINK="https://code.visualstudio.com/sha/download?build=stable&os=linux-deb-arm64"; fi && \
wget -O vscode.deb "${VSCODE_LINK}" && \
DEBIAN_FRONTEND=noninteractive \
apt-get update && \
apt-get install --no-install-recommends -y "./vscode.deb" && \
rm "./vscode.deb"
# add local files
COPY /root /
@@ -63,7 +55,15 @@ RUN \
echo "**** add icon ****" && \
curl -L -o \
/kclient/public/icon.png \
https://rawcdn.githack.com/xpipe-io/xpipe/a097ae7a41131fa358b5343345557ad00a45c309/dist/logo/logo.png
https://rawcdn.githack.com/xpipe-io/xpipe/a097ae7a41131fa358b5343345557ad00a45c309/dist/logo/logo.png \
RUN echo "**** VsCode **** ($TARGETPLATFORM)" && \
if [ "$TARGETPLATFORM" = "linux/amd64" ]; then VSCODE_LINK="https://code.visualstudio.com/sha/download?build=stable&os=linux-deb-x64"; else VSCODE_LINK="https://code.visualstudio.com/sha/download?build=stable&os=linux-deb-arm64"; fi && \
wget -O vscode.deb "${VSCODE_LINK}" && \
DEBIAN_FRONTEND=noninteractive \
apt-get update && \
apt-get install --no-install-recommends -y "./vscode.deb" && \
rm "./vscode.deb"
RUN echo "**** install tool packages ****" && \
DEBIAN_FRONTEND=noninteractive \

79
README.md
View File

@@ -5,81 +5,4 @@
XPipe Webtop is a web-based desktop environment that can be run in a container and accessed from a browser via KasmVNC.
The desktop environment comes with XPipe and various terminals and editors preinstalled and configured.
If you are using Kasm Workspaces, this image is also available in the [XPipe Kasm Registry](https://github.com/xpipe-io/kasm-registry).
## Application Setup
The Webtop can be accessed at:
* http://localhost:3000/
* https://localhost:3001/
## Authentication
Note that the authentication setup has to be done by you. By default, there is no authentication enabled and the webtop will be available to everyone.
So you have to be careful not to publicly expose it in that state.
As seen below, there are options to use basic HTTP authentication to restrict access.
However, this might also not be considered very secure, and it is recommended to use a proper separate authentication solution in front of the actual webtop environment.
Examples are Authelia, Authentik, KeyCloak, and others.
### Options in all KasmVNC based GUI containers
This container is based on [Docker Baseimage KasmVNC](https://github.com/linuxserver/docker-baseimage-kasmvnc) which means there are additional environment variables and run configurations to enable or disable specific functionality.
| Variable | Description |
| :----: | --- |
| 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/` |
## Usage
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
The webtop image is available for both `linux/amd64` and `linux/arm64` platforms.
### docker-compose (recommended, [click here for more info](https://docs.linuxserver.io/general/docker-compose))
```yaml
---
services:
webtop:
image: ghcr.io/xpipe-io/xpipe-webtop:latest
container_name: xpipe-webtop
environment:
- SUBFOLDER=/ #optional
volumes:
- /path/to/data:/config
- /var/run/docker.sock:/var/run/docker.sock #optional
ports:
- 127.0.0.1:3000:3000
- 127.0.0.1:3001:3001
restart: unless-stopped
```
### docker cli ([click here for more info](https://docs.docker.com/engine/reference/commandline/cli/))
```bash
docker run -d \
--name=xpipe-webtop \
-e SUBFOLDER=/ `#optional` \
-p 127.0.0.1:3000:3000 \
-p 127.0.0.1:3001:3001 \
-v /path/to/data:/config \
-v /var/run/docker.sock:/var/run/docker.sock `#optional` \
--restart unless-stopped \
ghcr.io/xpipe-io/xpipe-webtop:latest
```
## Building locally
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/xpipe-io/xpipe-webtop.git
cd xpipe-webtop
docker build \
--no-cache \
--pull \
.
```
You can find the documentation at [https://docs.xpipe.io/guide/webtop](https://docs.xpipe.io/guide/webtop).