Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/composer/windows-setup

The Windows installer for the Composer PHP Dependency Manager
https://github.com/composer/windows-setup

Last synced: about 1 month ago
JSON representation

The Windows installer for the Composer PHP Dependency Manager

Awesome Lists containing this project

README 

        
# Composer-Setup



[![build](https://github.com/composer/windows-setup/workflows/build/badge.svg)](https://github.com/composer/windows-setup/actions)



The Windows installer for the [Composer][composer] PHP Dependency Manager. [**Download**][download]

the latest release.



## Contents

* [About](#About)

* [Details](#Details)

* [Php Ini File](#Php-Ini-File)

* [Troubleshooting](#Troubleshooting)

* [Uninstalling](#Uninstalling)

* [Install Locations](#Install-Locations)

* [Environment Variables](#Environment-Variables)

* [Command Line Parameters](#Command-Line-Parameters)

* [Unattended Installation](#Unattended-Installation)

* [License](#License)





## About



Composer-Setup downloads and installs Composer so you can use it easily from the command line.



* it looks for PHP on your computer.

* it creates or modifies `php.ini` if required.

* it adds PHP to the path.

* it installs Composer globally - just type `composer` from any location to use it.

* it lets you use the Command Prompt, Git Bash, Msys, Msys2 and Cygwin.

* it can be deployed unattended for silent installs/uninstalls.



[Download][download] and run the latest release and in the majority of cases this is all you need to

do. The install process is described in more detail below.



Composer-Setup is written with [Inno Setup][inno], which is a powerful free installer for Windows

programs.





## Details



First you must choose the installation type. By default Composer will be installed to a

[fixed location](#Locations) with a Control Panel uninstaller. You can choose _Developer Mode_ if

you want more control, which will install Composer anywhere you want without an uninstaller.



The next step is to find the location of your `php.exe`, which is the PHP command line interpreter.

The installer searches common locations on your computer and presents you with its findings. If PHP

is already in your path then it will display this value. If not, or you want to choose a different

PHP, you must select from the list or hunt around manually.



The installer will then check that PHP and your path are set up correctly. If it finds any errors it

will give you the chance to fix them. It will also offer to either create or modify the `php.ini`

file if required settings do not exist. See [Php Ini File](#Php-Ini-File) for more information.



Next, the installer will ask if you need a proxy server to connect to the internet. If it finds any

values in your *Internet Settings* or your environment, then the proxy url will be displayed.



After you have reviewed and accepted your settings, the installer will download Composer and set

everything up. If your environment has been changed, it is important to close your current terminal

and open a new one so that the changes get loaded. The installer will remind you if this is the case.





## Php Ini File

Composer-Setup will either create a new `php.ini` or modify an existing file if any settings needed

by Composer are missing:



* `allow_url_fopen` set to `On`

* `curl`, `mbstring` and `open_ssl` extensions enabled



When creating a new file, the _php.ini-production_ file is used with `extension_dir` and

`date.timezone` values appropriately set. When modifying an existing file, a backup is created in

the same directory, named `php.ini~orig`.





## Troubleshooting

Composer-Setup creates a log file, which may be useful to review if you experience any installation

issues. This is stored in your temp directory `AppData\Local\Temp` with a formatted filename:

`Setup Log YYYY-MM-DD #nnn.txt`.





## Uninstalling



The uninstall program is available from the Control Panel (or Apps and Features) and is named

`Composer - PHP Dependency Manager`. It offers the option to remove user cache and configuration

data (for all users, if run as an Adminstrator) from:



* `\AppData\Local\Composer`

* `\AppData\Roaming\Composer`



The uninstall program will not be available if you installed in _Developer Mode_. To manually

uninstall you must delete the composer files from the location you installed to and update the

[environment](#Environment-Variables).





## Install Locations



In a default installation, the install directories are pre-determined and depend on whether you have

chosen to install for _All Users_ or the _Current User_.



**All Users install:**



* `C:\\ComposerSetup` - uninstaller.

* `C:\ProgramData\ComposerSetup\bin` - composer files.



**Current User install:**



* `C:\Users\\AppData\Local\ComposerSetup` - uninstaller.

* `C:\Users\\AppData\Local\ComposerSetup\bin` - composer files.



In a _Developer Mode_ installation you can install the composer files to a location of your choice.





## Environment Variables



The installer will modify the System path for _All Users_ installs, or the User path for

_Current User_ installs:



* the path to PHP will be added if missing, or replaced if a different PHP is selected. For default

_All Users_ installs you must confirm that you accept responsibility for the access control of this

location. This is important if other people use the computer because it could enable escalation of

priveleges exploits.

* the path to the composer files directory will be added/replaced.



In addition the installer will add the following to the environment of the current user:



* the `C:\Users\\AppData\Roaming\Composer\vendor\bin` directory to your path.

* an `http_proxy` value, if a proxy is specified in the installer.



The uninstaller will remove the path to the composer files directory and, if the user data was

removed, the `Composer\vendor\bin` path. The PHP path and any `http_proxy` value will be left intact.





## Command Line Parameters



The installer supports _Inno Setup's_ [Setup Command Line Parameters][setupcmds], although not all

of them are relevant. Of interest are the `/VERYSILENT` or `/SILENT` options for

[Unattended Installs](#Unattended-Installs) and the `/SAVEINF=` and `/LOADINF=` directives for

creating and using a settings file. The following additional parameters are available:



* `/PHP="folder-or-exe"` uses PHP from the specified location, adding it to the path if necessary.

* `/DEV="path"` selects _Developer Mode_ and installs Composer to the specified path without an

uninstaller.

* `/PROXY=proxy-url` is the proxy url to use and [save](#Environment-Variables), but only if no

proxy environment variables exist. The [log file](#Troubleshooting) automatically reports the

command line parameters so any sensitive data in the proxy url will be visible. This is not the case

when the proxy url is specified in a settings file.



The uninstall program supports _Inno Setup's_ [Uninstaller Command Line Parameters][uninscmds],

plus the following parameters:



* `/DELETE=local` removes `\AppData\Local\Composer` data.

* `/DELETE=all` additionally removes `\AppData\Roaming\Composer` data.





## Unattended Installs



Unattended installs and uninstalls require the `/VERYSILENT /SUPPRESSMSGBOXES` command line options.



* The confirmation needed to add/replace a PHP folder on the System [path](#Environment-Variables)

is bypassed on unattended installs.

* User cache and configuration data is not removed on unattended uninstalls unless specified with

the `/DELETE=` parameter (as above), which will apply to all users if being run as an Administrator.





## License



Composer-Setup is licensed under the MIT License - see the `LICENSE` file for details



  [composer]:   https://getcomposer.org/

  [download]:   https://github.com/johnstevenson/composer-setup/releases/latest

  [inno]:       https://www.jrsoftware.org/isinfo.php

  [setupcmds]:  https://jrsoftware.org/ishelp/topic_setupcmdline.htm

  [uninscmds]:  https://jrsoftware.org/ishelp/topic_uninstcmdline.htm