This is an automated email from the git hooks/post-receive script. x2go pushed a commit to branch master in repository x2gobroker. commit c9696c3db8ba843b2fe95d4a652c0e54147213e0 Author: Mike Gabriel <mike.gabriel@das-netzwerkteam.de> Date: Fri Sep 7 08:36:27 2018 +0200 Getting started documentation: Rework document, convert to markdown, install into x2gobroker bin:pkg (on DEB based systems). --- debian/changelog | 2 ++ debian/x2gobroker.docs | 1 + .../README.x2goclient+broker.getting-started.md | 39 ++++++++++++++-------- 3 files changed, 28 insertions(+), 14 deletions(-) diff --git a/debian/changelog b/debian/changelog index 9ee8a6f..e203a54 100644 --- a/debian/changelog +++ b/debian/changelog @@ -71,6 +71,8 @@ x2gobroker (0.0.4.0-0x2go1) UNRELEASED; urgency=medium and session profile defaults. - etc/x2gobroker-wsgi.apache.*: Drop Apache2.2 support. - Log to system broker.log file when run via x2gobroker-ssh. + - Getting started documentation: Rework document, convert to markdown, + install into x2gobroker bin:pkg (on DEB based systems). * debian/*: + Trigger Makefile's install target and install those files. Drop debhelper from-source-installation magic. diff --git a/debian/x2gobroker.docs b/debian/x2gobroker.docs new file mode 100644 index 0000000..1c04808 --- /dev/null +++ b/debian/x2gobroker.docs @@ -0,0 +1 @@ +doc/README.x2goclient+broker.getting-started \ No newline at end of file diff --git a/doc/README.x2goclient+broker.getting-started b/docs/README.x2goclient+broker.getting-started.md similarity index 70% rename from doc/README.x2goclient+broker.getting-started rename to docs/README.x2goclient+broker.getting-started.md index bececee..dac2f23 100644 --- a/doc/README.x2goclient+broker.getting-started +++ b/docs/README.x2goclient+broker.getting-started.md @@ -1,18 +1,23 @@ -X2Go Client / X2Go Broker Setup -=============================== +# X2Go Client / X2Go Broker Setup The easy setup for getting a first impression is this: -1. -Install x2goclient, x2gobroker and x2goserver(-xsession) locally +## Installing X2Go Client, X2Go Server and X2Go Broker - $ sudo apt-get install x2gobroker-daemon x2gobroker-authservice - $ sudo apt-get install x2goclient - $ sudo apt-get install x2goserver-xsession +Install x2goclient, x2gobroker and x2goserver(-xsession) locally. For +testing purposes, you can run all three components on one host. For +production environments, you distribute the services over different +machines and probably run many X2Go Server instances and man X2Go Client +instances. -2. -Edit the file /etc/default/x2gobroker-daemon. Enable the daemon and + $ sudo apt install x2gobroker-daemon x2gobroker-authservice + $ sudo apt install x2goclient + $ sudo apt install x2goserver-xsession + +## Test Configuration + +Edit the file /etc/default/x2gobroker-daemon. Enable the daemon and, if needed, adapt the bind address:port (DAEMON_BIND_ADDRESS) parameter. After editing, save the file and return to your terminal command line. @@ -20,21 +25,25 @@ From here, start the daemon: $ invoke-rc.d x2gobroker-daemon restart -3.1 +## Approach 1: Launch X2Go Client + Launch x2goclient in HTTP broker mode: $ x2goclient --broker-url=http://127.0.0.1:8080/plain/ (if you have changed the bind address, use your changed value here). -3.2 +## Approach 2: Launch PyHoca-GUI + Alternatively, launch pyhoca-gui in HTTP broker mode: $ pyhoca-gui --broker-url=https://127.0.0.1:8080/json/ (if you have changed the bind address, use your changed value here). -4. + +## The Broker Authentication + The first authentication that the x2goclient asks for is an authentication against the X2Go Broker (a HTTP server using the Tornado web framework on default port 8080). @@ -44,14 +53,16 @@ further by looking at this file: $ sudo editor /etc/pam.d/x2gobroker -5. +## The X2Go Client WebUI in Broker Mode + If you have successfully authenticated against the broker, then you get offered two session profiles named ,,KDE - localhost'' and ,,MATE - localhost''. These session profiles can be modified and customized in /etc/x2go/broker/x2gobroker-sessionprofiles.conf -6. +## Launch an X2Go Session via Broker Backend + If you select either of the session profiles (KDE or MATE on localhost), you will start an X2Go session on your local machine. (Of course, either KDE or the MATE desktop needs to be installed locally). -- Alioth's /home/x2go-admin/maintenancescripts/git/hooks/post-receive-email on /srv/git/code.x2go.org/x2gobroker.git