Server Access Management - techtalk/SpecLog-Resources GitHub Wiki

Using a SpecLog server allows you to share your repository amongst users over your network. In order to be able to access the server, users require a valid authentication token. The process of registering users on the server differs depending on your license type (server or single user).

You do not require a server license to run a SpecLog server. The license is required to generate authentication tokens on the server that grant access to that specific server. Users with a single user license can generate the required authentication token on their client and the token can be registered on the server without the need for a server license.

The different license types also affect which server(s) a user can access:

• A user license can be used to access any SpecLog server. The authentication token generated by the client needs to be registered on each server individually.
• A server license only allows users to access that specific server using the authentication tokens generated on the server.

The server supports two user roles:

Role	Permissions
Regular	Access, publish and manage repositories on the server (dependent on per-repository permissions)
Admin	Manage users on the server Manage and publish repositories on the server (independent of per-repository permissions) Access repositories on the server (dependent on per-repository permissions)

Use SpecLog.UserManager.exe located in the server directory to manage SpecLog users. Note the following:

• The SpecLog server service must be running and accessible to the client over the network.
• A valid admin.sltoken file must be located in the application startup directory. This token is generated when setting up the server. Use the /admintoken: option to use another administrative token file instead.
• Ensure that SpecLog.UserManager.exe.config references the correct URL of the SpecLog server you want to manage (SpeclogServerUrl). Ensure that this URL is also entered in the administrative token you are using.

Enter SpecLog.UserManager help to view a list of available commands.

You need to register a user token file (.sltoken) for each client that authenticates with the server. User token files can be generated by the client or by the server and need to be registered at the other side to allow authentication.

Whether you generate the user token file on the client or the server depends on your license type. During the evaluation period, you can only work with user token files generated on the server.

• IMPORTANT: Before using SpecLog.UserManager.exe, update the SpeclogServerUrl key in the <appSettings/> element in SpecLog.UserManager.exe.config to the correct server URL. This URL is also written to user token files, and should be the URL specified by users when connecting to the server.

• Once the user token file has been generated on the client, add a new user on the server and register the user's token file on the server:
  >SpecLog.UserManager.exe register [email protected] MyFirstname MyLastname myToken.sltoken
  You can also use this command to re-register server-generated token files deleted from the server.

• To add a user and generate the user token file, use the following command:
  >SpecLog.UserManager.exe create [email protected] MyFirstname MyLastname
  The generated user token file needs to be registered on the client.

Use the /role:admin parameter to generate server users with an administrator role.
To view information on all the options available, use:
>SpecLog.UserManager.exe help register and
>SpecLog.UserManager.exe help create

Users are identified by their registered email address. You can disable existing users to prevent them from accessing the server and repositories they previously had access to without changing their individual permissions on the server. To do so, use the following command to set their status to disabled:
>SpecLog.UserManager.exe update [email protected] /status:disabled

Use the same command to set the status to enabled, which restores server access for the user.

For more information about enabling/disabling users and updating their individual properties, enter:
>SpecLog.UserManager.exe help update

To view information on other user management functions, enter:
>SpecLog.UserManager.exe help