====== {$page} ======



The CHAPI service should self-install when you run the .MSI installer for CHAPI. If you need to manually install it you can do so via a command line interface.



-This creates the SERVICE only, not the folder. This is good to note when the service needs to be installed to a new drive. Prior to running this, copy the CHAPI folder to the new location. Then run the command as directed below.



===== Installing the Chapi_ServiceHost Service =====



The Chapi.Register.exe supports multiple command line options, a list of available options is listed below. In most cases when installing, you'll only need to specify a few of these options. The example below just covers the basics of installing.


  - For this scenario we'll assume the following settings
    * Chapi Username: chapi
    * Chapi Password: Ch@piUser1
    * Computer Name where Chapi is Installed: MyServer


  - To register the service, Open a command prompt with Administrative level permissions.


  - Navigate to C:\Program Files (x86)\Cyrious\Control\CHAPI\


  - Type the following command
    * [[code]]



chapi.register.exe -i -p=[port #] --username=[computer or domain name\username] --password=[username password]



[[code]]
    * Example:
    * [[code]]



chapi.register.exe -i -p=12556 --username=MyServer\chapi --password=Ch@piUser1



[[code]]


  - The CHAPI service will begin the service registration process, once complete you can go to Control Panel | Administrative Tools | Services to verify Chapi_ServiceHost_12556 was created as a service.



===== Available Options for Chapi.Register.exe =====



[[code]]



Usage: CHAPI.Register -p= [OPTIONS]



Usage: CHAPI.Register -a -- -p= [OPTIONS]



  Run as administrator with specified OPTIONS.



Options:


  -a , --runas              run as administrator


  -i , --install            same as -is -ia


  -u , --uninstall          same as -us -ua -uc


  -us, --uninstallservice   uninstall service from PORT


  -is, --installservice     install service for PORT


  -uc, --uninstallcert      uninstall certificate from PORT


  -ic, --installcert        install certificate for PORT


  -p , --port=        REQUIRED: port of service to perform operations on


  -pa, --postaction= action to perform after install/uninstall



                            valid values: START, STOP, RESTART


  -ia, --installacl         add http.sys permissions


  -ua, --uninstallacl       uninstall http.sys permissions


  -cf, --cert=    install/uninstall alternate certificate


  --cslog=               override the default connection string for logging


  --cschapi=             override the default connection string for chapi


  --username=            set the user that the service to be installed will run as


  --password=            the password of the user to run the service as


  -h , -?, --help           display this help and exit



[[code]]



===== Source =====



Contributor: Brandon Readlinger, Cyrious



Date: 05/24/2013



Version: Control 5.1



===== See Also =====
  * Backlinks [[include_pagepage_componentbacklinks]]