Added more docs to readme.

netwolfuk · netwolfuk · commit 4dd4d6a53997 · 2016-12-06T15:42:33.000+13:00
diff --git a/TodoList.md b/TodoList.md
@@ -2,7 +2,7 @@
 
 In order of urgency
 
- - [x] Remove artifacts when build cleanup up
+ - [x] Remove artifacts when build cleanup runs
  - [x] Add pool browsing
  - [x] Tidy up editRepository.jsp heading
  - [x] Add rename and project edit dialog to edit screen and validate repo name to be URL friendly
diff --git a/readme.md b/readme.md
@@ -58,4 +58,40 @@ A repository can be deleted by clicking the *Delete repository...* link in the A
 There are links on the Edit Repository pages, and the Debian Repositories page (in the breadcrumb of the Edit page) to browse a repository.  
  ![Screenshot of Repository browser](docs/images/tcdebrepository_browse.png "The Debian File Repository is browsable and publicly available") 
 
- 
+### Configuring a Debian server to use tcDebRepository
+The `/etc/apt/sources.list` file needs to be modified on your Debian computer to include the APT line entry of the Debian Repository located on the TeamCity server. Alternatively, a new file created in `/etc/apt/sources.list.d/` named something like `teamcity.list` containing  the APT line.
+
+Browse your Debian Repository (see section prior to this). Navigate into `dists/<dist_name>/<component_name>` and the exact APT line to add is displayed to allow copy and paste. It will look similar to this following example:
+
+	deb  http://teamcity.mycompany.com/app/debrepo/MyRepoName/  jessie  main
+
+Then run the following on the Debian machine:
+
+	sudo apt-get update
+	sudo apt-get --force-yes install <package_name>
+ 
+The `--force-yes` command tells Debian to trust unsigned packages from the repository. This is only applicable until version 1.1 of tcDebRepository plugin is released which will provide support for authenticated repositories. See [this GitHub issue](https://github.com/tcplugins/tcDebRepository/issues/3 "GitHub issue about signed repositories") for an update. I simply ran out of time to implement that before the December 6th competition deadline.
+
+### tcDebRepository compatibility
+#### TeamCity versions
+The tcDebRepository plugin has been tested on TeamCity 8.1.5, 9.1.7, 10.0.2 on Oracle Java versions 8 or 7.  
+
+ TeamCity version | Java Version | Result
+ ---------------- | ------------ | ------
+ 10.0.2 | 1.8.0_65-b17 | All services and UI working correctly
+ 9.1.7  | 1.7.0_65-b17 | All services and UI working correctly
+ 8.1.5  | 1.7.0_65-b17 | All services working correctly. Repositories need to be manually edited* - .BuildServer/config/deb-repositories.xml
+ 
+ I do intend to resolve UI issues on TC8 in future.
+ 
+#### Debian Versions
+ Distro | Version | Result
+ ------ | ------- | ------
+ Debian | wheezy | Packages install correctly when pass in `--force-yes` option
+ Debian | jessie | Packages install correctly when pass in `--force-yes` option
+ Ubuntu | precise | Packages install correctly when pass in `--force-yes` option
+ Ubuntu | wily | Packages install correctly when pass in `--force-yes` option
+ Ubuntu | xenial | Packages fail to install. Probably due to unsigned repository
+ Ubuntu | zesty  | Packages fail to install. Probably due to unsigned repository
+ 
+
diff --git a/tcdebrepo-server/src/main/java/debrepo/teamcity/web/DebDownloadController.java b/tcdebrepo-server/src/main/java/debrepo/teamcity/web/DebDownloadController.java
@@ -203,7 +203,7 @@ protected ModelAndView doHandle(HttpServletRequest request, HttpServletResponse
 					linkItems.add(LinkItem.builder().text("binary-" + arch).type(LINK_TYPE_REPO_DIR).url("./binary-" + arch + "/").build());
 				}
 				params.put("linkItems", linkItems);
-				params.put("alertInfo", StringUtils.getDebRepoUrl(myServer.getRootUrl(), repoName) + "  " + distName + "  " + component);
+				params.put("alertInfo", "deb  " + StringUtils.getDebRepoUrl(myServer.getRootUrl(), repoName) + "  " + distName + "  " + component);
 				params.put("directoryTitle", repoName);
 				params.put("currentPathLevel", component);
 				

Original file line number	Diff line number	Diff line change
`@@ -203,7 +203,7 @@ protected ModelAndView doHandle(HttpServletRequest request, HttpServletResponse`
`203`	`203`	`linkItems.add(LinkItem.builder().text("binary-" + arch).type(LINK_TYPE_REPO_DIR).url("./binary-" + arch + "/").build());`
`204`	`204`	`}`
`205`	`205`	`params.put("linkItems", linkItems);`
`206`		`- params.put("alertInfo", StringUtils.getDebRepoUrl(myServer.getRootUrl(), repoName) + " " + distName + " " + component);`
	`206`	`+ params.put("alertInfo", "deb " + StringUtils.getDebRepoUrl(myServer.getRootUrl(), repoName) + " " + distName + " " + component);`
`207`	`207`	`params.put("directoryTitle", repoName);`
`208`	`208`	`params.put("currentPathLevel", component);`
`209`	`209`