diff --git a/doc/configuration_network.png b/doc/configuration_network.png index 83d2dec7..187dd74e 100644 Binary files a/doc/configuration_network.png and b/doc/configuration_network.png differ diff --git a/doc/configuration_security.png b/doc/configuration_security.png index 92308d67..7e673e38 100644 Binary files a/doc/configuration_security.png and b/doc/configuration_security.png differ diff --git a/doc/connection.png b/doc/connection.png index 23ed61ff..3e0e1e68 100644 Binary files a/doc/connection.png and b/doc/connection.png differ diff --git a/doc/email_invitation.png b/doc/email_invitation.png deleted file mode 100644 index 70cd38d4..00000000 Binary files a/doc/email_invitation.png and /dev/null differ diff --git a/doc/index.docbook b/doc/index.docbook index c90de3b4..1484761a 100644 --- a/doc/index.docbook +++ b/doc/index.docbook @@ -1,22 +1,11 @@ - - - - + ]> - - - The &krfb; Handbook @@ -32,21 +21,11 @@ as Authors, publish date, the abstract, and Keywords --> 2003 &Brad.Hards; - &FDLNotice; - - -2013-06-19 -&kde; 4.11 - - +2016-07-25 +5.0 (Applications 16.08) @@ -56,10 +35,6 @@ view or even control the desktop. - - KDE kdenetwork @@ -75,23 +50,9 @@ Please at least include KDE, the KDE package it is in, the name - - Introduction - - &krfb; is a server application that allows you to share your current session with a user on another machine, who can use a VNC client to @@ -165,10 +126,8 @@ use &krfb; over other links, but performance is unlikely to be as good. Using &krfb; - - + +&krfb; Main Window It is very easy to use &krfb; - it has a simple interface, as shown in the screenshot below. @@ -189,64 +148,69 @@ the screenshot below. -When you want to allow someone to access your desktop, you can create -an personal invitation using the New Personal -Invitation... button, which will bring up a window -containing the information needed to access your desktop. An example -is shown below. +When you want to allow someone to access your desktop, you have to +enable the checkbox Enable Desktop Sharing, +which will start the server. + + + +Connection Details + + +The Address contains the address of your +computer and the port number, separated by a colon. +The address is just a hint - you can use any address that can +reach your computer. &krfb; tries to guess your address from your +network configuration, but does not always succeed in doing so. +If your computer is behind a firewall it may have a different +address or be unreachable for other computers + + +You can change the port on the Network +page in the configuration dialog. + + +The next field is prefilled with an automatical generated password. +Click in the icon at the right of the field to change the password. + + + + +Unattended Access + + +Any remote user with the desktop sharing password will have to be authenticated. +If unattended access is activated, and the remote user provides the password +for unattended mode, desktop sharing access will be granted without explicit +confirmation. + + +By default the password for this mode is empty, to change that click on +the button and enter a password. + + +If unattended access is allowed, then you should probably specify a +password. - -Example &krfb; personal invitation - - - - - - Example &krfb; personal invitation - - - +If the machine is a server and you are using &krfb; for remote +administration, you probably want to use unattended access. - -To increase security, the invitation is only valid for an -hour after it is created, and of course the person connecting has to -have the correct password. - + + + +Transfer Login Information -Since you may want to invite someone to access your desktop by email, -&krfb; can create invitations as email messages. You can create such -an invitation using the New Email Invitation... -button on the &krfb; main window. This will usually bring up an email -message that looks like the following, ready for you to type in the -email address of the person you are sending the invitation to. - - - - -Example &krfb; email invitation - - - - - - Example &krfb; email invitation - - - - - - - -&krfb; will warn you about the security implications of sending this -information across an insecure link. You must heed those warnings. +&krfb; has no invitation feature any more as in previous versions. +So you have to transfer the login information yourself using email +or a personal invitation. If you cannot encrypt the email (or otherwise secure the link), -sending invitations by email is a very serious security risk, since +sending a password by email is a very serious security risk, since anyone can read the password and address from the email as it passes over the network. This means that they can potentially take control of your machine. @@ -255,33 +219,32 @@ your machine. If you cannot encrypt the email message, it may be better to use a personal invitation, telephone the person you are giving access to, verify the identity of that person, and provide the required -invitation information that way. +information that way. - - - -Managing &krfb; invitations + -Having created an invitation (either a personal invitation or one that -was sent by email), &krfb; main window allows you to delete existing -invitations. To just delete one of the invitations, select it with the -mouse (it should become highlighted), and then select -the Delete. To delete all invitations, just -select the Delete All button. +&krfb; uses the normal RFB password system, which does not transfer +your password in the clear across the network. Instead, it uses a +challenge-response system. This is reasonably secure, as long as the +password is securely guarded. + - + - + Quit &krfb; -If you close the &krfb; main window the server keeps running, which is -indicated by an icon in the system tray. -To stop &krfb; right click on the icon in the systems tray and select +If you close the &krfb; main window by clicking on the window close icon or using the +shortcut &Alt;F4 the server +keeps running, which is indicated by an icon in the system tray. +To stop &krfb; either use FileQuit +in the main window or right click on the icon in the system tray and select Quit. + @@ -290,7 +253,7 @@ To stop &krfb; right click on the icon in the systems tray and select In addition to the main &krfb; interface shown and described above, you can also control &krfb; using the -Configure... on the &krfb; main window. The &krfb; +Configure... on the &krfb; main window. The &krfb; configuration has two pages, as shown in the screenshot below: @@ -314,8 +277,8 @@ The Network page allows control over the port that -The Announce service on the network checkbox -controls whether &krfb; announces invitations over the network using +The Announce service on the local network checkbox +controls whether &krfb; announces the service over the local network using Service Location Protocol. This is normally a good idea, but only works really well with a Service Location Protocol aware client, such as &krdc;. @@ -323,8 +286,8 @@ as &krdc;. If you select the Use default port checkbox, -then &krfb; will locate a suitable port, and invitations will match -this port. If you deselect this checkbox, you can specify a particular +then &krfb; will locate a suitable port. +If you deselect this checkbox, you can specify a particular port. Specifying a particular port may be useful if you are using port-forwarding on the firewall. Note that if Service Location Protocol is turned on, this will automatically deal with identifying @@ -332,8 +295,8 @@ the correct port. -The Security page allows you configure settings -related to access to the &krfb; server. +The Security page allows you to configure whether the +person connecting to the &krfb; servercan control the desktop, or only view. @@ -350,41 +313,15 @@ related to access to the &krfb; server. - -The Allow uninvited connections check box controls -whether &krfb; allows connection without an invitation. If uninvited -connections are allowed, then you should probably specify a -password. You can also use the check boxes here to choose whether you -have to confirm the connection before it proceeds, and whether the -person connecting can control the desktop, or only view. - - - -If the machine is a workstation, and you choose to allow uninvited -connections, you probably want to select the Ask -before accepting connections . Conversely, if the -machine is a server and you are using &krfb; for remote -administration, you probably want to deselect this option. - - - - -&krfb; uses the normal RFB password system, which does not transfer -your password in the clear across the network. Instead, it uses a -challenge-response system. This is reasonably secure, as long as the -password is securely guarded. - - - -What happens when someone connects to &krfb; +Connecting to &krfb; When someone connects to &krfb; on your machine, you will get a pop-up notification that looks like the following screenshot, unless you are -accepting uninvited connections without warning. +accepting unattended access without confirmation. @@ -402,8 +339,8 @@ accepting uninvited connections without warning. If you Accept Connection, the client can -proceed to authenticate (which requires the correct password for a -personal invitation or email invitation). If you Refuse +proceed to authenticate, which requires the correct password for a +login. If you Refuse Connection, then the attempt to connect will be terminated. @@ -413,23 +350,11 @@ mouse check box determines whether this client can only observe, or can take control of your machine. - -If the client connection is successful, and used the password from a -personal invitation or email invitation, then that invitation is -deleted and cannot be used again. You will also get a small pop-up -window in the dock, that shows that the connection has been made. - - - - Credits and License @@ -458,33 +383,6 @@ Documentation Copyright © 2003 &Brad.Hards; &Brad.Hards.mail; - -Installation - - -How to obtain &krfb; - - - -&install.intro.documentation; - - - - -Compilation and Installation - - - - - -&install.compile.documentation; - - - - - &documentation.index; diff --git a/doc/personal_invitation.png b/doc/personal_invitation.png deleted file mode 100644 index e8829071..00000000 Binary files a/doc/personal_invitation.png and /dev/null differ diff --git a/doc/screenshot.png b/doc/screenshot.png index 34d5ba3d..b903ec5f 100644 Binary files a/doc/screenshot.png and b/doc/screenshot.png differ diff --git a/krfb/ui/invitewidget.ui b/krfb/ui/invitewidget.ui deleted file mode 100644 index 0aa70165..00000000 --- a/krfb/ui/invitewidget.ui +++ /dev/null @@ -1,171 +0,0 @@ - - InviteWidget - - - - 0 - 0 - 603 - 364 - - - - - - - - 0 - 0 - - - - - 128 - 128 - - - - - - - - - - - 75 - true - - - - Welcome to KDE Desktop Sharing - - - false - - - - - - - KDE Desktop Sharing allows you to invite somebody at a remote location to watch and possibly control your desktop. <a href="whatsthis">More about invitations...</a> - - - Qt::RichText - - - true - - - Qt::LinksAccessibleByKeyboard|Qt::LinksAccessibleByMouse|Qt::NoTextInteraction - - - - - - - Qt::Vertical - - - QSizePolicy::MinimumExpanding - - - - 215 - 101 - - - - - - - - - - Qt::Horizontal - - - QSizePolicy::Expanding - - - - 90 - 26 - - - - - - - - - - - - - Create a new invitation and display the connection data. Use this option if you want to invite somebody personally, for example, to give the connection data over the phone. - - - Create &Personal Invitation... - - - - - - - This button will start your email application with a pre-configured text that explains to the recipient how to connect to your computer. - - - Invite via &Email... - - - - - - - &Manage Invitations (%1)... - - - - - - - - - Qt::Horizontal - - - QSizePolicy::Expanding - - - - 90 - 26 - - - - - - - - - - Qt::Vertical - - - QSizePolicy::Fixed - - - - 20 - 24 - - - - - - - - - - -