Skip to content
This repository was archived by the owner on Jan 6, 2019. It is now read-only.

Commit cde53cc

Browse files
committed
Edit INSTALL.md, fixing ToC and little things
1 parent bdd46e6 commit cde53cc

File tree

1 file changed

+16
-15
lines changed

1 file changed

+16
-15
lines changed

INSTALL.md

+16-15
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
Installing TFS Aggregator WebHooks is a six step process:
22

3-
1. [Grant access to VSTS/TFS](#Grant-access-to-VSTS-TFS)
4-
2. [Deploy TfsAggregator WebHooks web application](#Deploy-TfsAggregator-WebHooks-web-application)
5-
3. [Edit `web.config` file](#Edit-web.config-file)
6-
4. [Define the policy](#Define-the-policy)
7-
5. [Setup logging (optional)](#Setup-logging--optional-)
8-
6. [Setup the Web Hooks in TFS/VSTS](#Setup-the-Web-Hooks-in-TFS-VSTS)
3+
1. [Grant access to VSTS/TFS](#grant-access-to-vststfs)
4+
2. [Deploy TfsAggregator WebHooks web application](#deploy-tfsaggregator-webhooks-web-application)
5+
3. [Configure TFS Aggregator](#configure-tfs-aggregator)
6+
4. [Define the policy](#define-the-policy)
7+
5. [Setup logging (optional)](#setup-logging-optional)
8+
6. [Setup the Web Hooks in TFS/VSTS](#setup-the-web-hooks-in-tfsvsts)
99

1010

1111

@@ -61,22 +61,22 @@ You can check that the deploy worked, by opening a browser to the above URL appe
6161

6262

6363

64-
# Edit `web.config` file
64+
# Configure TFS Aggregator
6565

6666
To edit the deployed files, use Kudu console
6767

6868
![Kudu console](./media/2-config1.png)
6969

70-
at the `https://`<name_chosen_in_previous_step>`scm.azurewebsites.net` URL. Navigate to `site\wwwroot` folder.
70+
at the `https://`<name_chosen_in_previous_step>`.scm.azurewebsites.net` URL. Navigate to `site\wwwroot` folder via **Debug console** menu.
7171

7272
![](./media/2-config2.png)
7373

74-
## Add users
74+
## Add users to `web.config` file
7575

7676
Add at least one user in the `Users` section
7777
```
7878
<Users>
79-
<add key="vsts" value="P@ssword1" />
79+
<add key="vsts" value="P@ssw0rd!" />
8080
</Users>
8181
```
8282

@@ -102,10 +102,6 @@ Navigate to the `App_Data` folder to edit the policy files
102102

103103
![](./media/2-config4.png)
104104

105-
In the policies you may have to set the credentials chosen in the first step, e.g. the PAT.
106-
107-
![Personal Access Token in Policy file](./media/2-config5.png)
108-
109105
> The default HelloWorld policy works for any kind of work items.
110106
111107
## Specify Authentication in the policy
@@ -117,6 +113,10 @@ The `runtime/authentication` element accept two new options
117113
2. Personal Access Token (obtained on step 1)
118114
`<authentication personalToken="***" />`
119115

116+
In the policies you may have to set the credentials chosen in the first step, e.g. the PAT.
117+
118+
![Personal Access Token in Policy file](./media/2-config5.png)
119+
120120

121121

122122
# Setup logging (optional)
@@ -156,10 +156,11 @@ It requires six arguments and creates the subcription for create, update and res
156156
| ProjectName | TFS/VSTS project name | `My Project` |
157157
| PersonalAccessToken | Personal Access Token generated in step 1 | `jocxco3i7twydcif25bh7yysbodwnq4ppuannhro4yryfcbab4na` |
158158
| aggregatorURL | URL of TFS Aggregator WebHooks API | `https://mytfsaggregator.azurewebsites.net/api/workitem/` |
159-
| aggregatorUsername | Username listed in TFS Aggregator WebHooks `web.config` | `user1` |
159+
| aggregatorUsername | Username listed in TFS Aggregator WebHooks `web.config` | `vsts` |
160160
| aggregatorPassword | Password for the above | `P@ssw0rd!` |
161161

162162
> The `workitem.deleted` fails with error `TF26198: The work item does not exist, or you do not have permission to access it.`
163+
> This is an issue with VSTS/TFS that we cannot solve.
163164
164165
## Manual configuration
165166

0 commit comments

Comments
 (0)