Versions Compared

Old Version 1

changes.mady.by.user user-66fe9

Saved on

compared with

New Version Current

changes.mady.by.user Jonė Š.

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Content layer
id1316545669
Content column
id1316545680
Content block
id1326996622

On this page:

Table of Contents

Content block
id1316545679

The authentication server is part of Teamwork Cloud (TWCloud). You can deploy the authentication server onto your computer using the following instructions for Windows and Linux users. 

Table of Contents
maxLevel2
minLevel2

Authentication server deployment on Windows

To deploy an authentication

...

server using the zip file

...

  1. Make sure that the JAVA_HOME environment property links to the Java 11 directory.
  2. Go to the directory where TWCloud is unzipped and select the AuthServer

...

  1.  directory.
  2. Update the file <TWCloud directory>/AuthServer/config/authserver.properties as follows:
    1. server.public.host - Enter the IP address of the authentication server in place of ${server.ip}. If TWCloud is installed behind a proxy or firewall with NAT, use a public IP address. If you are accessing the server via

...

    1. an FQDN, use it instead of the IP address.
    2. twc.server.host - Enter the IP address of the server where TWCloud is installed in place of ${twc.server.ip}.
    3. twc.server.port - Specify the port

...

    1. of TWCloud

...

    1. REST API (the default

...

    1. is 8111).
    2. twc.server.protocol - Specify the protocol

...

    1. of TWCloud

...

    1. REST API (the default

...

    1. is https).

    2. authentication.redirect.uri.

...

    1. whitelist - Update the whitelist of redirect URI. Also, change the TWCloud swager's redirect URI (the initial

...

    1. is https://${twc.server.ip}:8111/) by setting the TWCloud IP address or FQDN instead of ${twc.server.ip}. Change the Web App Platform redirect URI (the initial is https://${webapp.server.ip}:8443/webapp/) by setting the Web App Platform IP address or FQDN (if you are accessing the server by FQDN) instead

...

    1. of ${webapp.server.ip} (and change the port/protocol if they were changed).

    2. cassandra.

...

    1. contactPoints and cassandra.

...

    1. port - Update the Cassandra host(s) if the database is installed on a different machine(s) and the Cassandra port if the custom port is configured in the database for CQL clients listening.

  2. Save the

...

  1.  authserver.properties file.
  2. Make sure that the log configuration points to the file location that is writable. You can find the log config in the file <TWCloud directory>/AuthServer/config/logback-spring.xml.
  3. Open the command prompt to <TWCloud directory>/AuthServer and run the file registerWindowsService.bat.
  4. Open the Windows Services panel or Task Manager'

...

  1. s Services

...

  1.  tab.
  2. Locate Authentication Server in the Windows Services panel (

...

  1. or AuthServer in Task Manager) and start it.


To deploy an authentication server using the installer

Note

To run the installer on Windows, you need .NET 3.5.

  1. Make sure that the log configuration points to the file location that is writable. You can find the log config in the file <TWCloud directory>/AuthServer/config/logback-spring.xml.
  2. By default, the Authentication Server will be started on the IP address specified during the installation process. If you want to access it through the public IP or FQDN, open the file <TWCloud directory>/AuthServer/config/authserver.

...

  1. properties and enter the public IP address or FQDN into the property server.public.host.
  2. Open the Windows Services panel or Task Manager's Services tab.
  3. Locate Authentication Server in the Windows Services panel (or AuthServer in Task Manager) and start it.


To undeploy an authentication server

  1. Open the Windows Services panel or Task Manager's Services tab.
  2. Locate Authentication Server in the Windows Services panel (or AuthServer in Task Manager) service and stop it.
  3. Open the command prompt to <TWCloud directory>/AuthServer and run the file unregisterWindowsService.bat.


Authentication server deployment on Linux

To deploy an authentication server using the zip file

  1. Go to the directory, where TWCloud is unzipped, and select the AuthServer directory.
  2. Update the file <TWCloud directory>/AuthServer/config/authserver.properties as follows.
    1. server.public.host - Enter the IP address of the authentication server in place of ${server.ip}. If TWCloud is installed behind a proxy or firewall with NAT, use a public IP address. If you are accessing the server via FQDN, use it instead of the IP address.
    2. twc.server.

...

    1. host - Enter the IP address of the server where TWCloud is installed in place of ${twc.server.ip}.
    2. twc.server.port - Specify the port of TWCloud

...

    1. REST API (the default is

...

    1. 8111).
    2. twc.server.protocol - Specify the protocol of TWCloud

...

    1. REST API (the default is https).

    2. authentication.redirect.uri.whitelist - Update the whitelist of redirect URI. Also, change the TWCloud swager's redirect URI (the initial is https://${twc.server.ip}:8111/) by setting the TWCloud IP address or FQDN instead of ${twc.server.ip}. Change the Web App Platform redirect URI (the initial is https://${webapp.server.ip}:8443/webapp/) by setting the Web App Platform IP address or FQDN (if you are accessing the server by FQDN) instead of ${webapp.server.ip} (and change the port/protocol if they were changed).

    3. cassandra.

...

    1. contactPoints and cassandra.

...

    1. port - Update the Cassandra host(s) if the database is installed on a different machine(s) and the Cassandra port if the custom port is configured in the database for CQL clients listening.

  2. Save the file authserver.properties.
  3. Make sure that the log configuration points to the file location that is writable. You can find the log config in the file <TWCloud directory>/AuthServer/config/logback-spring.xml.
  4. Copy the file <TWCloud directory>/AuthServer/script/authserver.service to the following directory /etc/systemd/system: sudo cp <TWCloud directory>/AuthServer/script/authserver.service   /etc/systemd/system.
  5. To make the service start/stop with system startup/shutdown, use the following command: sudo

...

  1.  systemctl enable authserver

...

  1. .
  2. Start the authentication server: sudo systemctl start authserver.


To deploy an authentication server using the installer

  1. Make sure that the log configuration points to the file location that is writable. You can find the log config in the file <TWCloud directory>/AuthServer/config/logback-spring.xml.
  2. Start the authentication server: sudo systemctl start authserver.

...

To undeploy an authentication server

...


To undeploy an authentication server, visit the Uninstallation page.

Content block
id1316545667

Related pages

...