SchultesDev/nginx-php-fpm
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #179 from auchri/patch-4

Browse Source 
Table for config flags
This commit is contained in:
Ric Harvey
2017-10-06 11:26:39 +01:00
committed by GitHub
parent 3a1f2c6b67 c8db7801fe
commit 28fb350eed
1 changed files with 33 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

57
docs/config_flags.md
View File

@@ -1,27 +1,36 @@
## Available Configuration Parameters ## Available Configuration Parameters
The following flags are a list of all the currently supported options that can be changed by passing in the variables to docker with the -e flag. The following flags are a list of all the currently supported options that can be changed by passing in the variables to docker with the -e flag.
- **GIT_REPO** : URL to the repository containing your source code. If you are using a personal token, this is the https URL without https://, e.g github.com/project/ for ssh prepend with git@ e.g git@github.com:project.git ### Git
- **GIT_BRANCH** : Select a specific branch (optional)
- **GIT_EMAIL** : Set your email for code pushing (required for git to work) | Name | Description |
- **GIT_NAME** : Set your name for code pushing (required for git to work) |--------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
- **GIT_USE_SSH** : Set this to 1 if you want to use git over SSH (instead of HTTP), useful if you want to use Bitbucket instead of GitHub | GIT_REPO | URL to the repository containing your source code. If you are using a personal token, this is the https URL without `https://` (e.g `github.com/project/`). For ssh prepend with `git@` (e.g `git@github.com/project.git`) |
- **SSH_KEY** : Private SSH deploy key for your repository base64 encoded (requires write permissions for pushing) | GIT_BRANCH | Select a specific branch (optional) |
- **GIT_PERSONAL_TOKEN** : Personal access token for your git account (required for HTTPS git access) | GIT_EMAIL | Set your email for code pushing (required for git to work) |
- **GIT_USERNAME** : Git username for use with personal tokens. (required for HTTPS git access) | GIT_NAME | Set your name for code pushing (required for git to work) |
- **WEBROOT** : Change the default webroot directory from `/var/www/html` to your own setting | GIT_USE_SSH | Set this to 1 if you want to use git over SSH (instead of HTTP), useful if you want to use Bitbucket instead of GitHub |
- **ERRORS** : Set to 1 to display PHP Errors in the browser | SSH_KEY | Private SSH deploy key for your repository base64 encoded (requires write permissions for pushing) |
- **HIDE_NGINX_HEADERS** : Disable by setting to 0, default behaviour is to hide nginx + php version in headers | GIT_PERSONAL_TOKEN | Personal access token for your git account (required for HTTPS git access) |
- **PHP_MEM_LIMIT** : Set higher PHP memory limit, default is 128 Mb | GIT_USERNAME | Git username for use with personal tokens. (required for HTTPS git access) |
- **PHP_POST_MAX_SIZE** : Set a larger post_max_size, default is 100 Mb
- **PHP_UPLOAD_MAX_FILESIZE** : Set a larger upload_max_filesize, default is 100 Mb ### Others
- **DOMAIN** : Set domain name for Lets Encrypt scripts
- **REAL_IP_HEADER** : set to 1 to enable real ip support in the logs | Name | Description |
- **REAL_IP_FROM** : set to your CIDR block for real ip in logs |-------------------------|----------------------------------------------------------------------------------------------------------------|
- **RUN_SCRIPTS** : Set to 1 to execute scripts | WEBROOT | Change the default webroot directory from `/var/www/html` to your own setting |
- **PGID** : Set to GroupId you want to use for nginx (helps permissions when using local volume) | ERRORS | Set to 1 to display PHP Errors in the browser |
- **PUID** : Set to UserID you want to use for nginx (helps permissions when using local volume) | HIDE_NGINX_HEADERS | Disable by setting to 0, default behaviour is to hide nginx + php version in headers |
- **REMOVE_FILES** : Use REMOVE_FILES=0 to prevent the script from clearing out /var/www/html (useful for working with local files) | PHP_MEM_LIMIT | Set higher PHP memory limit, default is 128 Mb |
- **APPLICATION_ENV** : set this to development to prevent composer deleteing local dev dependancies | PHP_POST_MAX_SIZE | Set a larger post_max_size, default is 100 Mb |
- **SKIP_CHOWN** : set to 1 to avoid running chown -Rf on /var/www/html | PHP_UPLOAD_MAX_FILESIZE | Set a larger upload_max_filesize, default is 100 Mb |
- **SKIP_COMPOSER** : set to 1 to avoid installing composer | DOMAIN | Set domain name for Lets Encrypt scripts |
| REAL_IP_HEADER | set to 1 to enable real ip support in the logs |
| REAL_IP_FROM | set to your CIDR block for real ip in logs |
| RUN_SCRIPTS | Set to 1 to execute scripts |
| PGID | Set to GroupId you want to use for nginx (helps permissions when using local volume) |
| PUID | Set to UserID you want to use for nginx (helps permissions when using local volume) |
| REMOVE_FILES | Use REMOVE_FILES=0 to prevent the script from clearing out /var/www/html (useful for working with local files) |
| APPLICATION_ENV | Set this to development to prevent composer deleting local development dependencies |
| SKIP_CHOWN | Set to 1 to avoid running chown -Rf on /var/www/html |
| SKIP_COMPOSER | Set to 1 to avoid installing composer |