Skip to content

Commit 5d98cd1

Browse files
author
Cory Fowler
committed
Added some useful information to the readme
1 parent 0f76aa7 commit 5d98cd1

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

README.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,33 @@
1+
# Azure App Service Web App Composer Site Extension
12

3+
This site extension adds [Composer](http://getcomposer.org) support to Web App to enable dependency management for PHP applications.
4+
5+
## Installation
6+
7+
Follow the instructions outlined in the article [How to enable a Site Extension in Azure App Service Web App](http://blog.syntaxc4.net/post/2015/02/05/how-to-enable-a-site-extension-in-azure-websites.aspx) when selecting an extension look for the list item for [Composer](http://www.siteextensions.net/packages/ComposerExtension/).
8+
9+
## Usage
10+
11+
There are multiple ways to use Composer from Web App.
12+
13+
### Continuous Deployment
14+
15+
This sample application demonstrates the usage of the `composer.json` file in Web App.
16+
17+
* Place a `composer.json` file in the root of your repository
18+
* vendor folder will be created in `d:\home\site\vendor`
19+
* reference to the autoload.php file `require_once "../vendor/autoload.php";`
20+
21+
### Command-Line
22+
23+
* Open the Kudu Debug Console (http://<site-name>.scm.azurewebsites.net/DebugConsole) or Install [KuduExec](https://github.com/projectkudu/kuduexec)
24+
* run composer from the command line `composer selfupdate`
25+
26+
## AppSettings
27+
28+
| Name | Value |Notes |
29+
|---------------------|---------------------------------------|------------------------------------------|
30+
| APPSETTING_COMMAND | %XDT_EXTENSIONPATH%\Hooks\deploy.cmd | Deployment Hook Command. (causes .deployment file not to function [[bug](https://github.com/projectkudu/kudu/issues/1519)]) |
31+
| PATH | %PATH%;%XDT_EXTENSIONPATH%\Commands | Overwrites the Path. Last Extension Wins |
32+
| COMPOSER_ARGS | --prefer-dist --no-dev --optimize-autoloader --no-progress | Command line arguments for composer during deploy.cmd execution |
33+
| COMPOSER_VENDOR_DIR | d:\home\site\vendor\ | Moves the vendor folder out of wwwroot for security purposes.

0 commit comments

Comments
 (0)