Getting Started
Below you find a quick start guide for Royal TS, Royal TSX and Royal Server. Use the navigation above to browse the full documentation.
Quick start guide for Royal TS for Windows
Create a new document to store your connections
Provide a name for the document and click OK.
Select the document or a folder in your document and create a new connection
In this example we add a new remote desktop connection. Enter a display name and computer name for the new connection.
Select the connection and click Connect
Quick start guide for Royal TSX for macOS
Step 1: Install Plugins
Royal TSX is a plugin-based application. That means, before you can actually connect to any remote computer, you have to install the plugin required for that particular connection.
To install plugins, open the "Royal TSX" menu and select the "Preferences" menu item, then navigate to "Plugins".
The plugins screen allows you to install, uninstall and update connection plugins.
Step 2: Create a Document
When you first start Royal TSX you'll notice that an "Application" document was created for you automatically. This document has some unique properties:
- You can password protect the Application Document. After doing so, every time you start Royal TSX you will be asked to enter your password.
- You can create folders, credentials, tasks, connection templates and edit Default Settings.
- You cannot close or delete it.
- You cannot create connections.
To actually create connections you have to create a new document. To do so navigate to the "File" menu and select the "New Document" menu item. You'll notice that new items have been added to the navigation panel on the left side of the main window.
Documents can contain any object type supported by Royal TSX. You can have as many documents as you like but only one Application Document.
Step 3: Add your first connection
Now that you have one or more plugins installed and a new document set up you can actually start creating connections and using Royal TSX. To create a new connection, select the "Connections" folder that was created automatically, then click the little "plus button" on the bottom left corner of the navigation panel in the main window and select the connection type you want to create a connection for.
After clicking the menu item for the connection type you want to add you'll be taken to the "connection properties dialog". This is the place where you can edit all properties available for a particular connection. The dialog also offers some generic properties that are common to all connections like "Notes" and "Custom Properties".
After creating your first connection object you will be able to connect to it by simply double clicking the newly added item in the navigation panel.
Tip: Remember that you can only create or edit connection objects if you have a matching plugin for that connection type installed.
Quick start guide for Royal Server
Configure a Worker Account and start Royal Server
After installation Royal Server needs to be provided with a Worker Account configuration. Click on "Service Configuration" in the left menu and use the "Change..." button to provide a Worker Account. It is recommended that this account is a local account with administrative rights:
After clicking "OK" restart the Royal Server service by clicking "Save" and "Restart" icons.
Allow users to work with Royal Server
Royal Server can only be accessed by accounts that are member of the "Royal Server Users" group (for Secure Gateway connections it is the "Royal Server Gateway Users" group). Consider adding users to these groups and restart Royal Server (since group memberships are cached by Royal Server by default).
Enable the Document Store and host a document
In order to prepare a centrally stored Royal Document for your team you need to enable the Document Store first. In order to do this, please install a license by selecting "License" and click "Add License...". A free trial license for testing the Document Store can be requested here.
To enable the Document store select "Document Store" and click "Enable", save and restart Royal Server.
Then select "Documents" and click "Add" -> "New..." to add a new Royal Document.
You now have a centrally stored document that can be shared and used within a team.
