Previous Next
teamwork_server_user_guide Chapter 2 - Installing the Server

Chapter 2 - Installing the Server

Using the Installer

  1. Double-click on the installer file to launch the setup program.
    Figure 2.1 - Running the setup program
    For Linux platforms, execute the command 'bash ./%TEAMWORK_SERVER-INSTALLER-FILENAME%' (e.g. bash ./Teamwork_Server_Linux_3_0.sh)
  2. Click Next > to proceed to the License Agreement page.
  3. Read through the License Agreement carefully. Make sure you accept the terms before continuing with the installation. If you accept the agreement, select I accept the agreement and click Next > to proceed to the Select Destination Directory page.
    Figure 2.2 - Accepting the license agreement
  4. Specify the directory for installing Teamwork Server. Click Next > to proceed to the next page.
  5. Specify the name of the Start Menu folder that will be used to store the shortcuts. Keep Create shortcuts for all users checked if you want the shortcut to be available in all the user accounts in the machine. Click Next > to proceed.
    For Linux platforms, select a folder for creating symlinks. You may select Don't create symlinks if you do not want to.
    For Mac OS X platforms, select whether you want to create desktop icon(s) that act as shortcut(s) to the installed products.
  6. (For Windows users only) Select Install service "Teamwork Server Service" if you want Teamwork Server to be installed as a Windows service. And select Start on bootup if you want the Teamwork Server service to be started automatically on startup of the computer. Click Next > to proceed.
  7. In the Installation Type screen, select an installation type and then click Next > to continue.

    You can choose to install both the Server and Admin program, or only the Server, or only the Admin. The recommended option is Server and Admin if it is a fresh installation. If you have already installed the Server or Admin (either on the same computer or a different one), you may choose the Server Only or Admin Only option.

    Figure 2.3 - Installation type
  8. Server and Admin/Server Only

    If you have chosen to install as Server and Admin or Server Only, you are brought to the Server Configuration page.

    Specify the port number that will be used by Teamwork Server. The default port is 1999. Please make sure that the specified port will not be used by other applications.

    The Teamwork Server Repository field allows you to specify the Teamwork Server repository location, where the configuration and data files used by the Teamwork Server are stored. If there is an existing teamwork server repository, you can import it into the new repository by checking Import Existing Repository and entering its path in the Import Directory field.

    You can also import the license key file in this step (since Teamwork Server will not function if there is no valid license key, though you can import the key later, it is advised that you import the key during installation).

    Click Next > to proceed with copying files.

    Figure 2.4 - Server Configuration

    Admin Only

    If you have chosen to install as Admin Only, you are brought to the Admin Configuration page.

    Specify the host and port number that is used by Teamwork Server.

    Click Next > to proceed with copying files.

    Figure 2.5 - Admin Configuration
  9. Click Finish to close the setup program.

Administration

The Teamwork Administrator will be started if you finished the installation of Server and Admin or Admin Only.

  1. If the Teamwork Administrator failed to connect to the Teamwork Server, the Checking Server page will show so that you can specify the appropriate server/connection information. Click Start Server to make sure the Teamwork Server is started before proceeding. If no valid key is found, you can click Import License Key to select the license key file in this step. After that, click Next to proceed with changing the administrator.
    Figure 2.6 - The Checking Server page
  2. In the Change Administrator Password screen, change the administrator password other than the default one. This step is compulsory right after the installation for security reason. After that, click Next to continue.
    Figure 2.7 - The Change Administrator Password page
  3. In the Create User page, add users to the Teamwork Server and assign permissions to them. You can add multiple users by repeating the steps of entering user information and click Add User. The Existing Users area shows the current users in the Teamwork Server, click Refresh if users are added/removed/modified externally. This step is optional and you may choose to do this at a later time. Click Next to continue.
    Figure 2.8 - The Create User page
  4. In the Create Project screen, add projects to the Teamwork Server and assign users to the projects. You can add multiple projects by repeating the steps of entering project information and click Add Project. The Existing Projects area shows the current projects in the Teamwork Server, click Refresh if project are added/removed/modified externally. This step is optional and you may choose to do this at a later time.
    Figure 2.9 - The Create Project page
  5. Click Finish to close the administrator program.

Using the No-Install

"No Install" is a compressed (zipped) file which contains all the files needed to run Teamwork Server. To use it, simply decompress the file, you will see a "Teamwork Server" folder is extracted.

On Windows

Go into the bin folder, you will see there are Windows executable files (with file extension exe).

File Purpose
StartTeamworkServer.exe Start the Teamwork Server.
StartTeamworkServerService.exe Install and start the Teamwork Server as Windows service.
TeamworkServerConfig.exe Configure the Teamwork Server settings.
TeamworkServerAdmin.exe Perform Teamwork Server administration like add users/projects.
ShutdownTeamworkServer.exe Shutdown the Teamwork Server.
Table 2.1 - Files inside the bin folder of the Teamwork Server and their purposes

On Linux

To decompress the "No Install" file, type tar -zxf in the terminal (replace with the actual "No Install" file name).

Go into the bin folder, you will see there are some executable files. Open the terminal and type the corresponding command to perform the desired operation.

Command Purpose
./StartTeamworkServer Start the Teamwork Server.
./StartTeamworkServerService Install and start the Teamwork Server as Windows service.
./TeamworkServerConfig Configure the Teamwork Server settings.
./TeamworkServerAdmin Perform Teamwork Server administration like add users/projects.
./ShutdownTeamworkServer Shutdown the Teamwork Server.
Table 2.2 - Commands related to Teamwork Server operations

Previous Next
Visual Paradigm International Limited
Website: www.visual-paradigm.com
E-mail: support@visual-paradigm.com