• Windows remote desktop (RDP)
• VNC
• VMRC
• SSH
• Telnet
• RAS
• ICA Citrix
• HTTP and HTTPs based viewers 

Developer guide

Continuous integration

• This service is Temporary unavailable!
• There is a public Team City server configured for our project at: ...
• Use Login as Guest on Login page
• These builds shouldn't be used as public available development builds (beta or RC)

Last Successful builds:

• Latest Binaries: http://goo.gl/bTlqr
• Unit tests build: http://goo.gl/nFdxs

Application life cycle

• To publish release version, the application version should be updated in Setup project and in Program startup object
• Releases are marked with label. If you want to rollback to previous version load selected version release label
• Tasks have iteration path "Terminals" until there is at least one related checkin. Then change the iteration path to the current development version
• When fixing an issue, mark it as Fixed (not as Closed). Task is closed as a part of release, if there are no comments otherwise it is shifted to next version.

Cooperation rules

• Miguel de Icaza has a good post on Open Source Contribution Etiquette that is worth reading, as the guidance he gives applies well to Terminals (inspired by Nuget project).
• Don't keep your checkouts long time, use Shelve sets instead
• Pickup from task stack only task, which you are able to solve in no more than two months
• Always associate check-in change set with task, if your check in is related to it
• In case of formating make two separate checkins: one which holds only code formating changes, second with fix/feature changes

Project structure

• Current development tool is Visual Studio 2010 with .NET C#.
• The main solution project is configured to target .NET framework 4. But there are other external projects, which are still targeting .NET 2.0. Don't change the target framework for them.
• For Logging the Log4Net is configured. Log files are stored under application Logs subdirectory.
• To build the release setup use the "Distribution release" solution configuration. For general development use standard debug and release.
• Output directory is default directory under the Terminals project.
• Put all localize able resources under the Localization directory in resource file stored there.
• The latest development branch is stored under "Main\Sources"
• To create user branch create your own under "FeatureBranches" directory and branch allways whole main subtree
• All extrenal components and other resources like images should be stored under "Resources" directory in its branch

External components

• SSH protocol from Granados project (actually developed as Poderosa)
• Terminal emulator control for ssh and telnet ( Terminal control)
• Amazon S3 component (from Amazon SDK Amazon SDK for .NET)
• zLib compression library (zLib)
• VNC client library (VncSharp)
• Log4Net (Log4Net)
• Packet manipulation library (SharpPcap)
• ICA Citrix component
• RDP imported as activeX component

Coding rules

• Use Visual Studio 2010 default settings or similar settings in another editor.
• For developer who are using Resharper, there is a Team shared configuration file for coding rules. Don't change this file, if you want to apply some rules. Discuss it first within the team.
• Indents are 4 spaces. You can use Productivity Power Tools for VS to convert tab characters into spaces.
• Fields should be declared private and above all methods.
• Put curly brackets on a new line and close it in the same indentation.
• Keep classes small up to maximum 500 lines
• Keep methods small up to maximum 35 lines
• Use usings as much as possible and remove not used usings
• When using an if condition with one statement, put the statement on the next line.

if (true)
       DoSomething();

• When using an if condition with one statement after if condition and else condition, curly brackets are optional.

if(true)
       DoSomething();
   else
       DoSomethingElse();

• When using an if condition with curly brackets, use curly brackets for all attached conditions

if (true)
   {
       x++;
       DoSomething();
   }
   else
   {
       DoSomethingElse();
   }

• After an if, while, for each or other conditions that can use curly brackets, leave an empty line.

if (true)
      DoSomething();

   x++;
   foreach(String s in stringArray)
   {
      Debug.Print(s);
   }
   
   DoTheNextThing();

• Use String.Format when possible.
• Use String.Empty instead of "", use String.IsNullOrEmpty() instead of (x == null | x = "").

User documentation

Key application terms:

• Connection - session between computer, which offers remote control, and your Terminals application
• Terminal - text window, which can be used for not GUI remote control protocols like Telnet or SSH
• Favorite - stored configuration, which allows you to connect to one service on one server using one user login
• Tag - text associated with one or more favorites, which allows you to group your favorites into logical groups visible in tree
• Group - set of favorites used for batch connections
• Shortcut - stored configuration, which allows you to start script or application directly from Terminals application. By default Terminals comes with shortcuts to Microsoft management console and Control panel applets
• Capture - stored screen picture of your running connection
• Protocol - type of remote control service offered by server you want to connect to
• Credentials - authentication informations (Domain, user name and password). Note, that you don't have to store your passwords. For more details check the documentation.

How to ...

• Manage connections
  • Create connection
  • Check why i can't connect
  • Move connection to the other monitor
  • Configure connection share
• Manipulate with connection credentials
  • Define custom connection credentials
  • Reuse stored credentials for more connections
  • Protect my connections with master password
• Organize favorites
  • Manage Tags and Groups
  • Import favorites
  • Search for computers servicing remote control protocol
• Capture connection screen
• Configure application data
  • Backup and restore settings files
  • Store data in SQL database
• Start Terminals using Command line arguments
• Installation
  • Upgrade to version 3.0

How to store data in SQL database

How to create database

How to configure the connection

• Connection string: Usual connection string used to connect to the MS SQL database. When the SQL storage is enabled, default connection string is offered as an example. For more details consult the MS SQL documentation.

• Database password: Because we have to protect the shared content stored in the database, SQL database is simply protected by this password. The password is checked when Terminals starts. Note, that this is not the application master password, nor the connection string password. Default database password is empty.

SQL store behavior

• Only simple concurrent updates are implemented. E.g. In some cases the database request may fail. In this case restart the application
• Simple refresh is done each 10 seconds. So wait few seconds after your colleague saves favorite changes
• There are no private favorites or credentials. All team members share complete database content
• The database is shared for all users, there is no possibility to isolate favorites for each user. There is no user or groups management.
• Database Master password updates are done in transaction. It should be secure to update all your stored passwords, if you already have them stored by clients.
• If you forget database master password, go to the options table and clear "MasterPasswordHash" row value. In this case, there is no restore. All your passwords protected by this database master password are lost.

How to migrate the data from files to the database

• To switch between data store types you have to restart the application
• Changing the data store doesn't copy, change or remove any data
• If you use both data stored, their data are isolated, but they share application configuration
• There is no possibility to combine favorites between file store and database store
• To migrate the content you have to export favorites, restart the application and import the exported content

Upgrade to version 3.0

Setup types

• Local installation: General type of setup known from other applications. All application configuration files are stored in user profile. This is new option not present in previous versions. In this case application doesn't write any files outside user profile
• Portable version: Version 3.0 is 100% portable. This is identical to previous versions setups. You may notice, that some new xml files appear in the application directory. This explains fixes in wrong file locations from previous version for portable configuration.

Replacing binaries (Installation without Windows installer)

• Replace also Log4Net.config file (Path to the logs was changed)
• You can remove "Thumbs" and "Logs" directories in the application directory. They will be recreated.
• After first run of the new version, all your data files should be moved to the "Data" subdirectory

Switching between local install and portable version

• Change the Log4Net logs directory in Log4Net.config file
• Change the "Portable" flag in Terminals.exe.config
• Move "Data" directory in expected location

Upgrade behavior

• If your data are protected by Master password and you are not able to provide it, application will exit without upgrading your f

Upgrade to version 3.0

Setup types

• Local installation: General type of setup known from other applications. All application configuration files are stored in user profile. This is new option not present in previous versions. In this case application doesn't write any files outside user profile
• Portable version: Version 3.0 is 100% portable. This is identical to previous versions setups. You may notice, that some new xml files appear in the application directory. This explains fixes in wrong file locations from previous version for portable configuration.

Replacing binaries (Installation without Windows installer)

• Replace also Log4Net.config file (Path to the logs was changed)
• You can remove "Thumbs" and "Logs" directories in the application directory. They will be recreated.
• After first run of the new version, all your data files should be moved to the "Data" subdirectory

Switching between local install and portable version

• Change the Log4Net logs directory in Log4Net.config file
• Change the "Portable" flag in Terminals.exe.config
• Move "Data" directory in expected location

Upgrade behavior

• If your data are protected by Master password and you are not able to provide it, application will exit without upgrading your files
• There is no downgrade from version 3.0 to version 2 or earlier, because encryption algorithm of passwords is not compatible. The only options is to export favorites in import into older version. Because there is no export of Credentials, they are always lost.
• There is no upgrade of connections history. After an upgrade your history will be deleted.

System requirements

Operation system

.NET Framework:

Remote destktop client (RDP client)

System requirements

Operation system

Version 2.0

• .NET Framework:

• Remote desktop client (RDP client)

Version 3.0 (under development):

• .NET 4.0 is required: http://www.microsoft.com/en-us/download/details.aspx?id=17718
• Also RDP 8 is supported:

System requirements

Operation system

Version 2.0

Version 3.0 (under development):

• .NET 4.0 is required: http://www.microsoft.com/en-us/download/details.aspx?id=17718
• Also RDP 8 is supported:
  • Not necessary
  • Not available for Windows XP
  • http://blogs.msdn.com/b/rds/archive/2012/10/23/rdp-8-0-update-for-windows-7-sp1-released-to-web.aspx

User documentation

Key application terms:

• Connection - session between computer, which offers remote control, and your Terminals application
• Terminal - text window, which can be used for not GUI remote control protocols like Telnet or SSH
• Favorite - stored configuration, which allows you to connect to one service on one server using one user login
• Tag - text associated with one or more favorites, which allows you to group your favorites into logical groups visible in tree
• Group - set of favorites used for batch connections
• Shortcut - stored configuration, which allows you to start script or application directly from Terminals application. By default Terminals comes with shortcuts to Microsoft management console and Control panel applets
• Capture - stored screen picture of your running connection
• Protocol - type of remote control service offered by server you want to connect to
• Credentials - authentication informations (Domain, user name and password). Note, that you don't have to store your passwords. For more details check the documentation.

How to ...

• Manage connections
  • Create connection
  • Check why i can't connect
  • Move connection to the other monitor
  • Configure connection share
• Manipulate with connection credentials
  • Define custom connection credentials
  • Reuse stored credentials for more connections
  • Protect my connections with master password
• Organize favorites
  • Manage Tags and Groups
  • Import favorites
  • Search for computers servicing remote control protocol
• Capture connection screen
• Configure application data
  • Backup and restore settings files
  • Store data in SQL database
• Start Terminals using Command line arguments

Documentation

• User documentation
• Installation
  • System requirements
  • Upgrade to version 3.0
• Features and Screen shots
• Developer guide

How to store data in SQL database

How to create database

How to configure the connection

• Connection string: Usual connection string used to connect to the MS SQL database. When the SQL storage is enabled, default connection string is offered as an example. For more details consult the MS SQL documentation.

• Database password: Because we have to protect the shared content stored in the database, SQL database is simply protected by this password. The password is checked when Terminals starts. Note, that this is not the application master password, nor the connection string password. Default database password is empty.

• Server Name "..." button: Use Sql browser service to locate SQL instances in your network
• Database "..." button: Locate all available databases attached to the selected database server instance
• Database password: Provide current Terminals database master password set up by your application administrator. This is used to validate, when connecting to the database.
• Set password button: Configure the database with new database password. You will be prompted to provide old and new password like in other password resets. If old password doesn't match, you will be not able to apply new password. Depending on content of your database this procedure can take a while, because it requires to update all already stored passwords.
• Test connection: Creates new connection string from currently configured values and tries to connect to terminals database. Result is shown, when procedure finishes. Not only connection string is checked, but also provided database master password is checked. Using this button you are able to check complete connection setup.
• Advanced: If you need to provide more detail about your connection, like timeouts etc. this button shows detail properties dialog, where you are able to configure complete MS SQL connection string.

SQL store behavior

• Only simple concurrent updates are implemented. E.g. In some cases the database request may fail. In this case restart the application
• Simple refresh is done each 10 seconds. So wait few seconds after your colleague saves favorite changes
• There are no private favorites or credentials. All team members share complete database content
• The database is shared for all users, there is no possibility to isolate favorites for each user. There is no user or groups management.
• Database Master password updates are done in transaction. It should be secure to update all your stored passwords, if you already have them stored by clients.
• If you forget database master password, go to the options table and clear "MasterPasswordHash" row value. In this case, there is no restore. All your passwords protected by this database master password are lost.

How to migrate the data from files to the database

• To switch between data store types you have to restart the application
• Changing the data store doesn't copy, change or remove any data
• If you use both data stored, their data are isolated, but they share application configuration
• There is no possibility to combine favorites between file store and database store
• To migrate the content you have to export favorites, restart the application and import the exported content

How to store data in SQL database

How to create database

How to configure the connection

• Connection string: Usual connection string used to connect to the MS SQL database. When the SQL storage is enabled, default connection string is offered as an example. For more details consult the MS SQL documentation.

• Database password: Because we have to protect the shared content stored in the database, SQL database is simply protected by this password. The password is checked when Terminals starts. Note, that this is not the application master password, nor the connection string password. Default database password is empty.

• Server Name"..." button: Use Sql browser service to locate SQL instances in your network
• Database"..." button: Locate all available databases attached to the selected database server instance
• Database password: Provide current Terminals database master password set up by your application administrator. This is used to validate, when connecting to the database.
• Set password: Configure the database with new database password. You will be prompted to provide old and new password like in other password resets. If old password doesn't match, you will be not able to apply new password. Depending on content of your database this procedure can take a while, because it requires to update all already stored passwords.
• Test connection: Creates new connection string from currently configured values and tries to connect to terminals database. Result is shown, when procedure finishes. Not only connection string is checked, but also provided database master password is checked. Using this button you are able to check complete connection setup.
• Advanced: If you need to provide more detail about your connection, like timeouts etc. this button shows detail properties dialog, where you are able to configure complete MS SQL connection string.

SQL store behavior

• Only simple concurrent updates are implemented. E.g. In some cases the database request may fail. In this case restart the application
• Simple refresh is done each 10 seconds. So wait few seconds after your colleague saves favorite changes
• There are no private favorites or credentials. All team members share complete database content
• The database is shared for all users, there is no possibility to isolate favorites for each user. There is no user or groups management.
• Database Master password updates are done in transaction. It should be secure to update all your stored passwords, if you already have them stored by clients.
• If you forget database master password, go to the options table and clear "MasterPasswordHash" row value. In this case, there is no restore. All your passwords protected by this database master password are lost.

How to migrate the data from files to the database

• To switch between data store types you have to restart the application
• Changing the data store doesn't copy, change or remove any data
• If you use both data stored, their data are isolated, but they share application configuration
• There is no possibility to combine favorites between file store and database store
• To migrate the content you have to export favorites, restart the application and import the exported content

How to backup and restore settings files

Data files

• History.xml - Stores content visible in History pane. This content is updated whenever you connect to some favorite. Removing this file will clear the history.
• Credentials.xml - contains values of stored credentials.
• Terminals.config - This is the main Terminals data file. Here Tags, Favorites and application application options are saved. Removing this will clear all your favorites and next time you start terminals, first run wizard will appear.

Window layout files

• ToolStrip.settings.config - Main window tool bar positions
• user.config - stored in user profile (usually in "c:\Documents and Settings\<username>\Local Settings\Application Data\RobertChartier\<Terminals>\<Version>\"). Contains main window position and size.

Log files

• Terminals.log4net.config - logging configuration. No one usually changes content of this file.
• currentlog.txt - located "Logs" subdirectory in application folder. All problems are noticed in this files. If you want to report any issue, please provide this file as attachment.
• LastUpdateCheck.txt - holds only date of last update. This file isn't used yet.

How to backup and restore settings files

Data files

• History.xml - Stores content visible in History pane. This content is updated whenever you connect to some favorite. Removing this file will clear the history.
• Credentials.xml - contains values of stored credentials.
• Terminals.config - This is the main Terminals data file. Here Tags, Favorites and application application options are saved. Removing this will clear all your favorites and next time you start terminals, first run wizard will appear.

Window layout files

• ToolStrip.settings.config - Main window tool bar positions
• user.config - stored in user profile (usually in "c:\Documents and Settings\<username>\Local Settings\Application Data\RobertChartier\<Terminals>\<Version>\"). Contains main window position and size.

Log files

• Terminals.log4net.config - logging configuration. No one usually changes content of this file.
• currentlog.txt - located "Logs" subdirectory in application folder. All problems are noticed in this files. If you want to report any issue, please provide this file as attachment.
• LastUpdateCheck.txt - holds only date of last update. This file isn't used yet.

Version 3.0:

• Has different files structure depending on installation type, which is described in Upgrade to version 3.0*
• All user files of the application are stored in one "Data" directory. This make the application 100% portable.
• All other rules are still valid except:
  • Content of the files is not backward compatible with version 2.0 and older
  • Stronger encryption is used and also additional fields in data files are encrypted (Domain and user name wasn't encrypted till version 3.0)
  • New file was added: Favorites.xml - contains all groups and their favorites. This version no longer stored favorites and their groups (Tags) in config file.
  • User.config file is not used. Currently window positions were moved to the Terminals.config

How to store data in SQL database

How to create database

How to configure the connection

• Connection string: Usual connection string used to connect to the MS SQL database. When the SQL storage is enabled, default connection string is offered as an example. For more details consult the MS SQL documentation.

• Database password: Because we have to protect the shared content stored in the database, SQL database is simply protected by this password. The password is checked when Terminals starts. Note, that this is not the application master password, nor the connection string password. Default database password is empty.

• Server Name"..." button: Use Sql browser service to locate SQL instances in your network
• Database"..." button: Locate all available databases attached to the selected database server instance
• Database password: Provide current Terminals database master password set up by your application administrator. This is used to validate, when connecting to the database.
• Set password: Configure the database with new database password. You will be prompted to provide old and new password like in other password resets. If old password doesn't match, you will be not able to apply new password. Depending on content of your database this procedure can take a while, because it requires to update all already stored passwords.
• Test connection: Creates new connection string from currently configured values and tries to connect to terminals database. Result is shown, when procedure finishes. Not only connection string is checked, but also provided database master password is checked. Using this button you are able to check complete connection setup.
• Advanced: If you need to provide more detail about your connection, like timeouts etc. this button shows detail properties dialog, where you are able to configure complete MS SQL connection string.

SQL store behavior

• Only simple concurrent updates are implemented. E.g. In some cases the database request may fail. In this case restart the application
• Simple refresh is done each 30 seconds. So wait few seconds after your colleague saves favorite changes
• There are no private favorites or credentials. All team members share complete database content
• The database is shared for all users, there is no possibility to isolate favorites for each user. There is no user or groups management.
• Database Master password updates are done in transaction. It should be secure to update all your stored passwords, if you already have them stored by clients.
• If you forget database master password, go to the options table and clear "MasterPasswordHash" row value. In this case, there is no restore. All your passwords protected by this database master password are lost.

How to migrate the data from files to the database

• To switch between data store types you have to restart the application
• Changing the data store doesn't copy, change or remove any data
• If you use both data stored, their data are isolated, but they share application configuration
• There is no possibility to combine favorites between file store and database store
• To migrate the content you have to export favorites, restart the application and import the exported content