WebSequenceDiagrams Installation and Administration Manual

Which version do I have?

The version number is in the installer filename. To find the version of an installed server, browse to the Status page by clicking on the Status button near the top. The version number is only displayed for version 15 and above (February 2013)

Installation

WebSequenceDiagrams uses a built-in web service that will not conflict with any other servers running on your system. It installs the same way as you would install other software on your system. On Windows, this involves running the installer program. On Linux, double-click the .deb or .rpm file that has been given to you, and enter your administrative password.

Entering a product key

After installation, you will have to enter your product key that was emailed to you. Access the web site by going to http://localhost:1086. If you are accessing it from another computer, use the server's name instead of localhost.

When there is no product key installed, the server will prompt for one.

Entering a new product key

If you have changed product keys for some reason, then you can enter a new one by going to the special url http://localhost:1086/?license=new. This will force the web application to prompt for a new product key, even though it already has one.

Changing advanced settings

The default settings are suitable for most systems. As an administrator, you can configure these additional settings:

• The port number (Default 1086)
• The server bind address (default: 0.0.0.0). The bind address specifies which network adapter to use. By default, the server will be accessible from all of them. You can change this by setting the server bind address
• (Version 15.0 until 33) Whether to enable user accounts. User accounts allow users to store files on the server. However, they require the administrator to perform password resets and backup data. To disable user accounts, set HideUserAccounts=1. In version 34 and above, use the administrative screen.
• (Version 43 and above) The certificate file and key file to enable HTTPS. If provided, you should usually set the port number to 443.

These settings can be changed by editing the text file called "wsd.conf". On Windows systems, this is found in the WebSequenceDiagrams installation folder, usually in C:\Program Files (x86)\WebSequenceDiagrams. On Linux systems, it is found in /etc/websequencediagrams/wsd.conf

Here is the contents of the file on a Linux system.

ServerPort=1086   
ServerBindAddress=0.0.0.0
KeyFile=
CertFile=
            

Advanced troubleshooting

All operations performed by WebSequenceDiagrams are logged to a file called debug.log. When this file gets too large, it is renamed to debug.log.old and a new one is started. If you are having problems with your installation, you can check the contents of this file to see what is happening, or send it to support@websequencediagrams.com

Data storage and backup

All data used by WebSequenceDiagrams is stored in an sqlite3 database file. On Linux, this file is found in /var/lib/websequencediagrams/wsd.db. On Windows, it is in c:\Documents And Settings\<username>\ApplicationData\websequencediagrams\wsd.db. To avoid accidental data loss, this file is never removed if you uninstall WebSequenceDiagrams.

If you store diagrams on the server, the server places them in this file. You should backup the file regularly to avoid data loss. To safely backup the database file while websequencediagrams is running, execute the wsdserver program with the --backup option.

    wsdserver --backup mybackupfile.db
            

In verion 17, a restore option was added. To restore the database from a backup, run use the --restore option. It is not necessary to stop the service before running this command. On Linux systems, it is necessary to run this command as the root user.

    wsdserver --restore mybackupfile.db
            

To avoid data loss, prior to restoring, the existing datase will be copied to a file in the current folder of the form wsd.backup.DATE.db

Prior to version 17, to restore, you should stop the service, locate the "wsd.db" file on your system, and replace it with the backup file.

What is stored in this file?

The file is an SQLITE3 database and it stores the following information:

• Your product key
• User accounts and encrypted passwords
• Files that users have saved to the server, in text format

Administering user accounts

In version 33 and above, you can administer user accounts from the administrative panel at /admin.html. If secure passwords are used, an administrative account is required to reset them in case they are forgotten. The administrative user has the account called admin and the default password of admin. After logging in, the administrator may click on the Admin button to see list of all users. From here, he or she may reset an individual user's password.

The administrative password can be changed from the web user interface in the usual way. However, if the administrator forgets his or her password, it may be reset from the command line.

On linux, run this command to reset the administrative password back to "admin". The command must be run as the root user, so you will have to enter the administrators password for the linux system first.

sudo wsdserver --reset-admin
            

On windows, the command is:

c:\Program Files\WebSequenceDiagrams Server Edition 11\wsdserver --reset-admin
            

Administrator-managed sign in

When this option is selected, users will not be able to create accounts. The administrator must create accounts for all users.

Single-Sign-On (SSO) Managed Accounts

The Worry-free site license version allows signin using SSO. When selecting this, you must obtain the XML Metadata file from your SSO provider and enter it into the box below.

Google sign in

The Worry-free site license version allows signin using Google. This can be configured by selecting "user-managed" signin and entering your Google Client ID in the configuration box.

LDAP sign in

The Worry-free site license allows LDAP authentication. Each time a user signs in, WebSequenceDiagrams will form a DN from the user's signin name. It will then attempt to access the given LDAP URI as that user, performing LDAP authentication using the user's DN and password. The DN is formed from the DN that you enter, combined with the username.

Disabled sign in

When sign-in is disabled, premium functionality remains available for all users, but they will not be able to store files and information on the server. The administrator can still sign in by accessing /admin.html.