github.com/alloyci/alloy-runner@v1.0.1-0.20180222164613-925503ccafd6/docs/install/windows.md (about)

     1  # Install AlloyCI Runner on Windows
     2  
     3  To install and run AlloyCI Runner on Windows you need:
     4  * Git installed
     5  * A password for your user account, if you want to run it under your user
     6    account rather than the Built-in System Account
     7  
     8  ## Installation
     9  
    10  1. Create a folder somewhere in your system, ex.: `C:\AlloyCI-Runner`.
    11  1. Download the binary for [x86][]  or [amd64][] and put it into the folder you
    12     created. Rename the binary to `alloy-runner.exe`.
    13     You can download a binary for every available version as described in
    14     [Bleeding Edge - download any other tagged release](bleeding-edge.md#download-any-other-tagged-release).
    15  1. Run an [`Administrator`/elevated command prompt][prompt] (<kbd>WindowsKey</kbd>, search for "cmd", right click and run as admin).
    16  1. [Register the Runner](../register/README.md).
    17  1. Install the Runner as a service and start it. You can either run the service
    18     using the Built-in System Account (recommended) or using a user account.
    19  
    20      **Run service using Built-in System Account**
    21  
    22      ```bash
    23      alloy-runner install
    24      alloy-runner start
    25      ```
    26  
    27      **Run service using user account**
    28  
    29      You have to enter a valid password for the current user account, because
    30      it's required to start the service by Windows:
    31  
    32      ```bash
    33      alloy-runner install --user ENTER-YOUR-USERNAME --password ENTER-YOUR-PASSWORD
    34      alloy-runner start
    35      ```
    36  
    37      See the [troubleshooting section](#troubleshooting) if you encounter any
    38      errors during the Runner installation.
    39  
    40  1. (Optional) Update Runners `concurrent` value in `C:\AlloyCI-Runner\config.toml`
    41     to allow multiple concurrent jobs as detailed in [advanced configuration details](../configuration/advanced-configuration.md).
    42     Additionally you can use the advanced configuration details to update your
    43     shell executor to use Bash or PowerShell rather than Batch.
    44  
    45  Voila! Runner is installed, running, and will start again after each system reboot.
    46  Logs are stored in Windows Event Log.
    47  
    48  ## Update
    49  
    50  1. Stop the service (you need elevated command prompt as before):
    51  
    52      ```bash
    53      cd C:\AlloyCI-Runner
    54      alloy-runner stop
    55      ```
    56  
    57  1. Download the binary for [x86][] or [amd64][] and replace runner's executable.
    58     You can download a binary for every available version as described in
    59     [Bleeding Edge - download any other tagged release](bleeding-edge.md#download-any-other-tagged-release).
    60  
    61  1. Start the service:
    62  
    63      ```bash
    64      alloy-runner start
    65      ```
    66  
    67  ## Uninstall
    68  
    69  From elevated command prompt:
    70  
    71  ```bash
    72  cd C:\AlloyCI-Runner
    73  alloy-runner stop
    74  alloy-runner uninstall
    75  cd ..
    76  rmdir /s AlloyCI-Runner
    77  ```
    78  
    79  ## Troubleshooting
    80  
    81  Make sure that you read the [FAQ](../faq/README.md) section which describes
    82  some of the most common problems with AlloyCI Runner.
    83  
    84  If you encounter an error like _The account name is invalid_ try to add `.\` before the username:
    85  
    86  ```shell
    87  alloy-runner install --user ".\ENTER-YOUR-USERNAME" --password "ENTER-YOUR-PASSWORD"
    88  ```
    89  
    90  If you encounter a _The service did not start due to a logon failure_ error
    91  while starting the service, please [look in the FAQ](../faq/README.md#13-the-service-did-not-start-due-to-a-logon-failure-error-when-starting-service-on-windows) to check how to resolve the problem.
    92  
    93  If you don't have a Windows Password, Runner's service won't start but you can
    94  use the Built-in System Account.
    95  
    96  If you have issues with the Built-in System Account, please read
    97  [How to Configure the Service to Start Up with the Built-in System Account](https://support.microsoft.com/en-us/kb/327545#6)
    98  on Microsoft's support website.
    99  
   100  [x86]: https://alloy-runner-downloads.s3.amazonaws.com/latest/binaries/alloy-runner-windows-386.exe
   101  [amd64]: https://alloy-runner-downloads.s3.amazonaws.com/latest/binaries/alloy-runner-windows-amd64.exe
   102  [prompt]: https://www.tenforums.com/tutorials/2790-elevated-command-prompt-open-windows-10-a.html