Skip to content

Commit e3533fb

Browse files
committed
Readme change
1 parent b8aabe7 commit e3533fb

File tree

1 file changed

+24
-15
lines changed

1 file changed

+24
-15
lines changed

README.md

Lines changed: 24 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,29 @@ This project allows you to easily create an [infinitely-scalable farm of IIS 8 /
66
![AzureWebFarm.OctopusDeploy logo](https://raw.github.com/MRCollective/AzureWebFarm.OctopusDeploy/master/logo.png)
77
Logo courtesy of Aoife Doyle (thanks so much - it's awesome!)
88

9+
It's really easy to get up and running - more details below, but in short:
10+
11+
1. Configure a standard Web Role project in Visual Studio
12+
2. `Install-Package AzureWebFarm.OctopusDeploy`
13+
3. Configure 4 cloud service variables - `OctopusServer`, `OctopusApiKey`, `TentacleEnvironment` and `TentacleRole`
14+
4. Deploy to Azure and watch the magic happen!
15+
916
tl;dr
1017
-----
11-
* Pre-requisites
12-
* Installation Instructions
13-
* Local Debugging
14-
* Remote Debugging
15-
* What if I want to use Web Roles, but don't want to pay for another VM / don't want to use OctopusDeploy?
16-
* What happens when I install the AzureWebFarm.OctopusDeploy NuGet package?
17-
* What if I want to deploy non-.NET applications?
18-
* Why is this needed?
19-
* If you are using OctopusDeploy for deployments and you want to move to the cloud
20-
* If you are deploying web applications to Windows Azure
21-
* Contributing
22-
* Stay abreast of the latest changes / releases
18+
* [Pre-requisites](#pre-requisites)
19+
* [Installation Instructions](#installation-instructions)
20+
* [Pre-packaged deployment](#pre-packaged-deployment)
21+
* [Custom install](#custom-install)
22+
* [Local debugging](#local-debugging)
23+
* [Remote debugging](#remote-debugging)
24+
* [What if I want to use Web Roles, but don't want to pay for another VM / don't want to use OctopusDeploy?](#what-if-i-want-to-use-web-roles-but-dont-want-to-pay-for-another-vm--dont-want-to-use-octopusdeploy)
25+
* [What happens when I install the AzureWebFarm.OctopusDeploy NuGet package?](#what-happens-when-i-install-the-azurewebfarmoctopusdeploy-nuget-package)
26+
* [What if I want to deploy non-.NET applications?](#what-if-i-want-to-deploy-non-net-applications)
27+
* [Why is this needed?](#why-is-this-needed)
28+
* [If you are using OctopusDeploy for deployments and you want to move to the cloud](##if-you-are-using-octopusdeploy-for-deployments-and-you-want-to-move-to-the-cloud)
29+
* [If you are deploying web applications to Windows Azure](#if-you-are-deploying-web-applications-to-windows-azure)
30+
* [Contributing](#contributing)
31+
* [Stay abreast of the latest changes / releases](#stay-abreast-of-the-latest-changes--releases)
2332

2433
Pre-requisites
2534
--------------
@@ -75,11 +84,11 @@ The installation instructions form two parts - normal web role installation and
7584
1. Execute the following in the Package Manager Console (or use the GUI): `Install-Package AzureWebFarm.OctopusDeploy`
7685
* Make sure it installs into the web project
7786
* When prompted that a file has been modified click **"Reload"**
78-
2. (optional) [Debug locally](#Local_Debugging)
87+
2. (optional) [Debug locally](#local-debugging)
7988
3. Ensure that the `ServiceConfiguration.Cloud.cscfg` file has correct values for the `OctopusServer`, `OctopusApiKey`, `TentacleEnvironment` and `TentacleRole` variables
8089
4. Deploy to Azure as per step 9 above
8190

82-
Local Debugging
91+
Local debugging
8392
---------------
8493
It is a good idea to debug the farm locally to make sure your configuration is correct and your OctopusDeploy server is configured correctly:
8594

@@ -92,7 +101,7 @@ It is a good idea to debug the farm locally to make sure your configuration is c
92101
* If you need to debug the startup script then uncomment the relevant REM'd out lines in Startup\startup.cmd (but remember to recomment them before dpeloying to Azure or your Azure deployment WILL fail
93102
* If you need to debug the RoleEntryPoint code then [set up your Visual Studio to debug using Symbol Source](http://www.symbolsource.org/Public/Home/VisualStudio) and you should be able to step into the AzureWebFarm.OctopusDeploy code
94103

95-
Remote Debugging
104+
Remote debugging
96105
----------------
97106

98107
The following should be able to help you debug what is happening:

0 commit comments

Comments
 (0)