From 443d74b88110de6c9c4e04552e0d979656710d83 Mon Sep 17 00:00:00 2001 From: Niko Ehrenfeuchter <nikolaus.ehrenfeuchter@unibas.ch> Date: Tue, 6 Mar 2018 22:05:41 +0100 Subject: [PATCH] Move all installation instructions to a separate document. --- INSTALLATION.md | 39 +++++++++++++++++++++++++++++++++------ README.md | 22 +--------------------- 2 files changed, 34 insertions(+), 27 deletions(-) diff --git a/INSTALLATION.md b/INSTALLATION.md index c35c267..f1a252b 100644 --- a/INSTALLATION.md +++ b/INSTALLATION.md @@ -1,18 +1,45 @@ -# Installation Instructions +# AutoTx Service Installation + +The AutoTx service doesn't have a *conventional* installer but rather has to be +registered using the `InstallUtil.exe` tool coming with the .NET framework. + +## Using The Installation Script + +A PowerShell script to help with the installation is provided with each AutoTx +package. To use the script, follow these steps: + +- Log on to the computer using an account with adminstrative privileges. +- Edit the `ScriptsConfig.ps1` settings file, adjust the values according to + your setup. +- Open a PowerShell console using the `Run as Administrator` option. The script + [Run-ElevatedPowerShell.ps1](Scripts/Run-ElevatedPowerShell.ps1) can be used + to start a shell with elevated permissions. +- Navigate to the installation package directory, run the `Install-Service.ps1` + script. +- Supply the two required configuration files in the `conf/` subdirectory of + the service installation location and start the service using `Start-Service + AutoTx`. + + +## Manual Installation Instructions **PLEASE NOTE:** these instructions are mostly for documentation purposes, by default it is **strongly recommended** to use the installation script described in [README](README.md). -## Setup +### Register the service + +Open a *PowerShell* console with elevated privileges ("Run as Administrator"). +Launch `InstallUtil` as follows: +``` +& "C:\Windows\Microsoft.NET\Framework\v4.0.30319\InstallUtil.exe" /username=<SERVICEACCOUNT> /password=<SERVICEPASS> /unattended C:\Tools\AutoTx\AutoTx.exe +``` -## Service Startup +### Service Startup -Open a *PowerShell* console. To start the service and monitor its logfile, use -the following commands: ``` Start-Service AutoTx -Get-Content -Wait C:\Tools\AutoTx\service.log +Get-Content -Wait -Tail 200 C:\Tools\AutoTx\service.log ``` \ No newline at end of file diff --git a/README.md b/README.md index 8df8c16..4c39497 100644 --- a/README.md +++ b/README.md @@ -105,27 +105,7 @@ rules. ## Installation -The AutoTx service doesn't have a *conventional* installer but rather has to be -registered using the `InstallUtil.exe` tool coming with the .NET framework. A -PowerShell script to help with the installation is provided with each AutoTx -package. To use the script, follow these steps: - -- Log on to the computer using an account with adminstrative privileges. -- Edit the `ScriptsConfig.ps1` settings file, adjust the values according to - your setup. -- Open a PowerShell console using the `Run as Administrator` option. The script - [Run-ElevatedPowerShell.ps1](Scripts/Run-ElevatedPowerShell.ps1) can be used - to start a shell with elevated permissions. -- Navigate to the installation package directory, run the `Install-Service.ps1` - script. -- Supply the two required configuration files in the `conf/` subdirectory of - the service installation location and start the service using `Start-Service - AutoTx`. - -### Manual Installation - -For detailed steps on how to do the installation steps yourself, have a look at -the [manual installation](INSTALLATION-MANUAL.md) instructions. +See the [instructions for installing the service](INSTALLATION.md) for details. ## Operation -- GitLab