x
Wyn Enterprise 3.6 is now available! See what’s new Wyn Enterprise 3.6 is now available! See what’s new Wyn Enterprise 3.6!

Wyn Enterprise: Installing on WindowsOS

To install and use Wyn Enterprise on WindowsOS, you need the following environment.

Requirements

Framework

  • .NET Framework 4.6.1

Operating System

  • Windows 10
  • Windows Server 2016

Browser

  • Internet Explorer 11 and above, Microsoft Edge, Google Chrome, and Safari.

Note : Before installing, please exit the anti-virus software on your computer. Our products are commercial software provided by regular manufacturers and will not adversely affect the system. Please feel free to use them.

To Install

  1. Download and execute the installer (.exe) as System Administrator.
  2. Confirm the software agreement, set the installation directory, and click Next.
  3. In the Software Registration form, fill in the details, and click install.

    The installation progress is displayed.

  4. Depending on your OS, the installer may ask for your permission to install one or two operating system updates during installation. Wait until the installation is finished.

After the installation is complete, click Open Portal to open Wyn Enterprise portal - http://localhost:51980/ in the browser.

Following are the installer-added services:

  • WynDatabase: Maintains a PostgreSQL database.
  • WynService: Hosts several processes to maintain Wyn Enterprise websites and other modules.

Default Ports

Wyn Enterprise uses the following ports by default.

  • Server: 51981
  • Portal: 51980
  • Reporting Worker: 51982
  • Identity Service: 51980

You can reassign the ports in the config file.

To Configure

You can change Wyn Enterprise behavior by modifying the primary config file Wyn.conf, located here - C:\Program Files\Wyn Enterprise\Monitor\. The changes are applied after the WynService is restarted. All settings have default values, if you want to change the default value, just uncomment the line and change the value.

Wyn.conf
    
    # This is a YAML file. Format reference: (EN) https://en.wikipedia.org/wiki/YAML ; (ZH) https://zh.wikipedia.org/wiki/YAML .
    # You can specify the global setting in global_settings section. These settings will be applied to all services in the services section. Of course, you can override the item via specify the item in particular service section.
    # Available settings:
    #     identity_server_url: Identity server URL.
    #     enable_health_check: A value indicates if health check is enabled. The default value is true.
    #     try_restart_count: A value indicates how many time the monitor restarts the service when the service crashes.
    #     command: Define the command to run the service.
    global_settings:
        identity_server_url: 'http://localhost:51988'
        command: dotnet
        enable_health_check: true
        try_restart_count: -1
        # log_level: Error
        # redirect_output_of_service: true

    # Service section includes all service definitions.
    # There are a set of common settings. These settings are available for each Service
    # Common settings:
    #     urls: The service URLs. The value is a semicolon-separated list;
    #     disabled: A value indicates if this service is disabled. The default value is false.
    #     enable_health_check: A value indicates if health check is enabled. The default value is true.
    #     try_restart_count: A value indicates how many times the monitor restarts the service when the service crashes. If you want to try until the service is started successfully, you can specify -1.
    #     identity_server_url: Identity server URL.
    #     command: Define the command to run the service.
    #     arguments: Define the arguments that command starts the service with.
    #     working_directory: The directory that the service is started in. You don't have to specify the working directory unless you change the directory that the service is installed.
    services:
        identity_server:
            urls: 'http://:51988'
            # The extra urls that are authorized. By default identity server adds all URLs that Wyn Enterprise runs.
            # If you want to setup the reverse proxy or use public IP address or DNS for the portal, you should add the portal's URL to allowed_urls.
            allowed_urls: 
            #    - "http://www.yourdomain.com:51980"
            #    - "http://youserver.eastus.coluadapp.azure.com:51980"

        server:
            urls: 'http://:51981'
            # You don't have to sepcify this item unless you change the directory that data providers were installed.
            # data_provider_directory: DataProviders
            # storage:
                # engine: Postgres

            # Plugin's path can be an absolute path or a relative path to root of install directory
            plugins:
                - 'Plugins/Dashboard/dashboard/Gces.Dashboards.Plugin.dll'
                - 'Plugins/Reporting/Gces.Reporting.Plugin.dll'
                - 'Plugins/Dataset/dataset/Gces.Dataset.Plugin.dll'
                - 'Plugins/Dataset/account/Gces.Account.Plugin.dll'

        portal:
            urls: 'http://*:51980'
            # backend:
            #    host: localhost
            #    port: 51981

        worker:
            urls: 'http://localhost:51982'
            environment: Development
            # display_name: 'reporting-worker'
            # backend:
            #    server_url: 'http://localhost:51981'
    
   

Installed Files

The Wyn Enterprise files are installed in ProgramFiles, whose values are relative with operation system settings.

File Name Location
CotWorker \Wyn Enterprise\
logs \Wyn Enterprise\
Monitor \Wyn Enterprise\
Plugins \Wyn Enterprise\
Account \Wyn Enterprise\Plugins\
Dashboard \Wyn Enterprise\Plugins\
DataSet \Wyn Enterprise\Plugins\
Reporting \Wyn Enterprise\Plugins\
Portal \Wyn Enterprise\
ReportingWorker \Wyn Enterprise\
sampledata \Wyn Enterprise\
Server \Wyn Enterprise\
Tools \Wyn Enterprise\

Publish Wyn Enterprise Portal

By default newly installed Wyn Enterprise can be accessed only via local machine for security reasons.

If you want to make Wyn Enterprise accessible for other machines (on intranet and internet), you need to configure the Wyn Enterprise manually. For more information, see To Configure.

Publish Wyn Enterprise to Internet

When you publish Wyn Enterprise to internet, you need to change some settings. As usual you need to bind a domain name to portal and identity service. You also could use reverse proxy. So the URL of portal and identity service must be set in configuration file.

  1. Set global_settingsidentity_server_url to your public IP/address, for example http://www.yourdomain.com:51988/.
  2. Under servicesidentity_serverallowed_urls add your public IP/address, for example:

    - http://www.yourdomain.com:51980
    

    Notice the dash symbol please.

  3. Restart WynService service.

  4. Access Wyn portal http://www.yourdomain.com:51980/ from other machine to test.

Uninstall Wyn Enterprise

  1. Got to Settings > Add or Remove Programs.
  2. Click Uninstall.

    or

  1. Run Wyn Enterprise installer.
  2. Select Remove database if you do not want to preserve the database on uninstalling.
  3. Click Uninstall.