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

Commit bdd46e6

Browse files
committed
Added Scripts and ToC to INSTALL.md
1 parent 51e3dc9 commit bdd46e6

File tree

2 files changed

+34
-2
lines changed

2 files changed

+34
-2
lines changed

INSTALL.md

Lines changed: 34 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,14 @@
1+
Installing TFS Aggregator WebHooks is a six step process:
2+
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)
9+
10+
11+
112
# Grant access to VSTS/TFS
213

314
There are three possible options to grant access. In most cases you will have to change the configuration later using the values collected in this step.
@@ -14,7 +25,7 @@ b. Capture Personal Access Token's value and store it for later ![Personal Acces
1425
instead of a PAT, you can give permission to the account running the Application Pool (see https://github.com/tfsaggregator/tfsaggregator/wiki/Troubleshooting)
1526

1627
## 3. [TFS only] Explicit credentials
17-
or put username and password in clear text inside the policy file
28+
or put username and password in clear text in the `/AggregatorConfiguration/runtime/authentication` node of the policy file
1829

1930
If you do not allow access expect a similar error
2031
![Access denied](./media/0-error.png)
@@ -103,7 +114,7 @@ The `runtime/authentication` element accept two new options
103114
1. Explicit credentials
104115
`<authentication username="DOMAIN\user" password="***" />`
105116
not much secure, but handy for testing and some edge scenario
106-
2. Personal Access Token
117+
2. Personal Access Token (obtained on step 1)
107118
`<authentication personalToken="***" />`
108119

109120

@@ -134,6 +145,24 @@ By opening the file you see a snapshot of log file's content.
134145

135146
This is the last step: setup the caller, i.e. configure VSTS/TFS to invoke TFS Aggregator (see also [Web Hooks](https://www.visualstudio.com/en-us/docs/integrate/get-started/service-hooks/services/webhooks)).
136147

148+
## Using Powershell
149+
150+
In the `samples` folder you can find the `Create-Subscriptions.ps1` Powershell script to quickly setup the subscription.
151+
It requires six arguments and creates the subcription for create, update and restore events.
152+
153+
| Argument | Description | Sample value |
154+
|---------------------|---------------------------------------------------------|-----------------------------------------------------------|
155+
| tfsURL | TFS/VSTS base URL | `https://me.visualstudio.com/` |
156+
| ProjectName | TFS/VSTS project name | `My Project` |
157+
| PersonalAccessToken | Personal Access Token generated in step 1 | `jocxco3i7twydcif25bh7yysbodwnq4ppuannhro4yryfcbab4na` |
158+
| aggregatorURL | URL of TFS Aggregator WebHooks API | `https://mytfsaggregator.azurewebsites.net/api/workitem/` |
159+
| aggregatorUsername | Username listed in TFS Aggregator WebHooks `web.config` | `user1` |
160+
| aggregatorPassword | Password for the above | `P@ssw0rd!` |
161+
162+
> The `workitem.deleted` fails with error `TF26198: The work item does not exist, or you do not have permission to access it.`
163+
164+
## Manual configuration
165+
137166
> NOTE: this is a per-project configuration (Project/Admin).
138167
139168
![](./media/4-hooks1.png)
@@ -165,6 +194,9 @@ And after all four events are defined.
165194
![Four service hooks, one per event](./media/4-hooks7.png)
166195

167196

197+
198+
# Final testing
199+
168200
At this point the configuration is complete and you can test, e.g. creating a new work item.
169201

170202
![New Work Item](./media/5-test1.png)

media/0-PAT2.png

4.04 KB
Loading

0 commit comments

Comments
 (0)