Instruction Manual for softing models including: EN-012024 License Server, License Server, Server
14 mars 2024 — Disclaimer of liability. The information contained in these instructions corresponds to the technical status at the time of printing of it and is passed on ...16 pages
File Info : application/pdf, 16 Pages, 3.65MB
DocumentDocumentUser Guide licenseServer Version: EN-012024-1.00 © Softing Industrial Automation GmbH Disclaimer of liability The information contained in these instructions corresponds to the technical status at the time of printing of it and is passed on with the best of our knowledge. Softing does not warrant that this document is error free. The information in these instructions is in no event a basis for warranty claims or contractual agreements concerning the described products, and may especially not be deemed as warranty concerning the quality and durability pursuant to Sec. 443 German Civil Code. We reserve the right to make any alterations or improvements to these instructions without prior notice. The actual design of products may deviate from the information contained in the instructions if technical alterations and product improvements so require. OpenSource To comply with international software licensing terms, we offer the source files of open source software used in our products. For details see https://opensource.softing.com/ If you are interested in our source modifications and sources used, please contact: info@softing.com Softing Industrial Automation GmbH Richard-Reitzner-Allee 6 85540 Haar / Germany https://industrial.softing.com + 49 89 4 56 56-340 info.automation@softing.com support.automation@softing.com https://industrial.softing.com/support/support-form Table of Contents Table of Contents Chapter 1 1.1 1.2 1.3 1.4 Chapter 2 2.1 2.2 Chapter 3 3.1 3.2 3.3 Chapter 4 4.1 4.2 4.3 4.3.1 4.3.2 4.4 4.4.1 4.4.2 4.4.3 About this guide.................................................................................... 5 Read me first ........................................................................................................... 5 Target audienc.e.......................................................................................................... 5 Typographic co.n...v.e..n...t.i.o..n..s........................................................................................... 5 Document hist.o..r.y....................................................................................................... 5 About the licens.e..S..e..r.v..e..r........................................................................ 6 Intended use ........................................................................................................... 6 Technical data........................................................................................................... 6 Installation .................................................................................... 7 Docker ........................................................................................................... 7 Windows ........................................................................................................... 9 Commissionin..g......................................................................................................... 10 Working with t.h..e...l.i.c..e..n..s.e..S..e..r.v..e..r.......................................................... 11 User interface........................................................................................................... 11 Registration a.n...d...L.o...g.i.n.............................................................................................. 11 Licenses ........................................................................................................... 12 Uploading a li.c..e..n..s..e.................................................................................................. 12 Activating a li.c.e..n...s.e................................................................................................... 13 Settings ........................................................................................................... 14 Changing the .l.o..g..i.n...c..r.e..d...e..n..t.i.a..l.s................................................................................ 14 Softing suppo.r..t..d..a..t..a................................................................................................ 14 HTTPS certific.a..t.e....................................................................................................... 15 Version EN-012024-1.00 3 This page is intentionally left blank. 4 Version EN-012024-1.00 Chapter 1 - About this guide 1 About this guide 1.1 Read me first Please read this guide carefully before using the device to ensure safe and proper use. Softing does not assume any liability for damages due to improper installation or operation of this product. This document is not warranted to be error-free. The information contained in this document is subject to change without prior notice. To obtain the most current version of this guide, contact your Softing representative. 1.2 Target audience This guide is intended for experienced operation personnel and network specialists responsible for installing and licensing network devices. 1.3 Typographic conventions The following conventions are used throughout Softing customer documentation: Keys, buttons, menu items, commands and other à à Open Start Control Panel Programs elements involving user interaction are set in bold font and menu sequences are separated by an arrow Buttons from the user interface are enclosed in brackets and set to bold typeface Coding samples, file extracts and screen output is set in Courier font type Press [Start] to start the application MaxDlsapAddressSupported=23 Filenames and directories are written in italic Device description files are located in C: \<Application name>\delivery\software\Device Description files CAUTION CAUTION indicates a potentially hazardous situation which, if not avoided, may result in damage or injury. Note This symbol is used to call attention to notable information that should be followed during installation, use, or servicing of this device. Hint This symbol is used when providing you with helpful user hints. Read This symbol calls your attention to specific related documentation which you are requested to read carefully. 1.4 Document history Document version 1.00 Changes since last version first version Version EN-012024-1.00 5 licenseServer - User Guide 2 About the licenseServer 2.1 Intended use The Softing licenseServer hosts and keeps track of of a number of available network software licenses (also known as floating licenses or shared licenses) that are used locally on individual machines and that can be shared among many users and applications. When users wants to access a Softing product or application they have to request a license from the licenseServer. The server now checks for a spare license. If available it will allocate the license as requested and allows the Softing product or application run. However, if the request exceeds the number of available licenses, the licenseServer will decline the request and the product can only be run in demo mode. When a license is no longer required on a local machine (user closes an application), the license is released from the local machine and is floating back to the pool of available licenses held on the server. 2.2 Technical data Platform: System Requirements Docker Container: Intel / AMD 64-bit, ARM 64-bit Windows Application: Windows 10 and newer - Intel / AMD 64-bit Windows: § RAM: 3 MB § Disk: 60 MB Docker: § RAM: 70 MB § Disk: 215 MB 6 Version EN-012024-1.00 Chapter 3 - Installation 3 Installation 3.1 Docker Note The license server docker image is available on Docker Hub: https://hub.docker.com/r/softingindustrial/license-server. § Download the docker image using the following command: docker pull softingindustrial/license-server § Use the following commands to create and configure Docker container: o mkdir -p /var/lib/license-server o mkdir -p /var/lib/license-server/licenses o mkdir -p /var/lib/license-server/config o mkdir -p /var/lib/license-server/users o docker create --name license-server -p 8000:8000 -p 6200:6200 -v /var/lib/licenseserver/licenses:/root/.x-formation -v /var/lib/license-server/users:/root/sflm/users v /var/lib/license-server/config:/root/sflm/config --restart=always softingindustrial/licenseserver The following ports are used by the license server: Port 6200 8000 Service Network License Server HTTPS Web Server These ports are mapped in the docker create call above 1:1 to the ports of the host system. Of course, you can map them to different ports on the host system by changing the first number on the -p option (example: -p 8400:8000). To disable HTTPS use the docker create call without a port mapping for port 8000. Note You will need access to the Web server to add licenses. These following volumes are used by the license server: Volume /root/.x-formation /root/sflm/users /root/sflm/config Description Folder to store the license files Folder to store the user data Folder to store the configuration of the license server The directory /var/lib/license-server is used to persist the configuration of the license server container. Of course, you can store it in a different folder on the host system by changing the first folder on the -v option (example: -v /home/xxx/ls:/root/.x-formation). The option restart=always will start the container on the startup of the system or restart it on failure. Version EN-012024-1.00 7 licenseServer - User Guide Start the container with the following command: § docker start license-server Stop the container with the following command: § docker stop license-server Remove the container with the following command: § docker rm -f license-server Read See the official Docker documentation for more Details on the Docker command line. 8 Version EN-012024-1.00 Chapter 3 - Installation 3.2 Windows 1. Download the installation file Softing License Manager V4.xx.exe from the edgeConnector or edgeAggregator product page. 2. Double-click the downloaded file to start the software installation. 3. Select your installation language. 4. Click [OK] and follow the on-screen instructions. 5. Select the option Softing Floating License Server from the feature list. 6. Click [Next] and [Install]. 7. Follow the on-screen instructions. 8. In the Files in Use dialog is shown, select the default setting Automatically close and attempt to restart application and click [OK]. 9. When the Softing Floating License Server is installed, click [Finish] to exit the installation wizard. Note If you intend to open and work with the Softing Floating License Server application immediately, you will have to restart your PC to complete the installation. Before you do so ensure that you have saved all currently open projects and files to avoid losing your work. 10. Click [Yes] to restart your computer and activated the application or click [No] to wait till next time you start your PC. Version EN-012024-1.00 9 licenseServer - User Guide 3.3 Commissioning To be able to use the license server you must add licenses which should be served to the server. 12 See Chapter 4.3 explaining how to add licenses. 10 Version EN-012024-1.00 Chapter 4 - Working with the licenseServer 4 Working with the licenseServer 4.1 User interface 1. Open a browser of your choice and enter the IP address and port of the license server. Example: https://192.168.42.23:8000 Note The default port is 8000. If you have configured the web access of the license server to run on a port other 8000 you have to add the port number to the IP address, separated by a colon (:). Example: https://192.168.42.23:8400 2. Press return. The user interface of the license server appears. 4.2 Registration and Login The first time you are using the web UI you must register a user. If you have registered a user you can use this user to login afterwards. Version EN-012024-1.00 11 licenseServer - User Guide 4.3 Licenses After login you see the license page which lists all licenses served. The Host ID field displays the host id of the server. You can use the button on the right to copy it to the clipboard. 4.3.1 Uploading a license You can upload a license which has been activated on the Softing internet page. 1. Go to the Softing Industrial website and click the icon in the upper right corner to register yourself. 2. Alternatively, select this My Softing Portal link. When you are registered and logged in you are directed to the My Softing page. 3. Click [Register License]. 4. Enter the license key from your License Certificate in the license key input field. You will have received the License Certificate when you purchased the FOUNDATION Fieldbus or PROFIBUS PA license. 5. Paste the host ID you copied in Step 4 into the Host ID field of the My Softing page. 12 Version EN-012024-1.00 Chapter 4 - Working with the licenseServer 6. Click [Register License]. A license file is generated. 7. Click [Download]. The license file is saved to your PC. to your PC. 8. Switch to the licenseServer application. 9. Click the icon to choose alicense file on your PC and click [Open]. 10. Click [Upload]. 4.3.2 Activating a license If the licenseServer is connected to the Internet you can activate a license directly in the licenseServer. Version EN-012024-1.00 13 licenseServer - User Guide 4.4 Settings Adjust the configuration of the licenseServer on the Settings. 4.4.1 Changing the login credentials Here you can change the Email and password used for the login. 4.4.2 Softing support data I you need to send data to the Softing product support, press this button and send the created 7z file to Softing. 14 Version EN-012024-1.00 Chapter 4 - Working with the licenseServer 4.4.3 HTTPS certificate By default, HTTPS certificates for localhost are generated. All generated certificates will be regenerated automatically before they elapsed. Generating a certificate The HTTPS certificate needs to include the IP address or the host name of the machine to be able to declare it as secure on a machine running the browser. Therefore, it is possible to generate a certificate with this information. Uploading a certificate It is possible to upload an external generated certificate for the use with the HTTPS server. The Key and Certificate files have to be uploaded. Version EN-012024-1.00 15 Softing Industrial Automation GmbH Richard-Reitzner-Allee 6 85540 Haar / Germany https://industrial.softing.com + 49 89 45 656-340 info.automation@softing.com