Skip to content

Commit 28fb350

Browse files
author
Ric Harvey
authored
Merge pull request #179 from auchri/patch-4
Table for config flags
2 parents 3a1f2c6 + c8db780 commit 28fb350

File tree

1 file changed

+33
-24
lines changed

1 file changed

+33
-24
lines changed

docs/config_flags.md

Lines changed: 33 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,36 @@
11
## Available Configuration Parameters
22
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.
33

4-
- **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
5-
- **GIT_BRANCH** : Select a specific branch (optional)
6-
- **GIT_EMAIL** : Set your email for code pushing (required for git to work)
7-
- **GIT_NAME** : Set your name for code pushing (required for git to work)
8-
- **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
9-
- **SSH_KEY** : Private SSH deploy key for your repository base64 encoded (requires write permissions for pushing)
10-
- **GIT_PERSONAL_TOKEN** : Personal access token for your git account (required for HTTPS git access)
11-
- **GIT_USERNAME** : Git username for use with personal tokens. (required for HTTPS git access)
12-
- **WEBROOT** : Change the default webroot directory from `/var/www/html` to your own setting
13-
- **ERRORS** : Set to 1 to display PHP Errors in the browser
14-
- **HIDE_NGINX_HEADERS** : Disable by setting to 0, default behaviour is to hide nginx + php version in headers
15-
- **PHP_MEM_LIMIT** : Set higher PHP memory limit, default is 128 Mb
16-
- **PHP_POST_MAX_SIZE** : Set a larger post_max_size, default is 100 Mb
17-
- **PHP_UPLOAD_MAX_FILESIZE** : Set a larger upload_max_filesize, default is 100 Mb
18-
- **DOMAIN** : Set domain name for Lets Encrypt scripts
19-
- **REAL_IP_HEADER** : set to 1 to enable real ip support in the logs
20-
- **REAL_IP_FROM** : set to your CIDR block for real ip in logs
21-
- **RUN_SCRIPTS** : Set to 1 to execute scripts
22-
- **PGID** : Set to GroupId you want to use for nginx (helps permissions when using local volume)
23-
- **PUID** : Set to UserID you want to use for nginx (helps permissions when using local volume)
24-
- **REMOVE_FILES** : Use REMOVE_FILES=0 to prevent the script from clearing out /var/www/html (useful for working with local files)
25-
- **APPLICATION_ENV** : set this to development to prevent composer deleteing local dev dependancies
26-
- **SKIP_CHOWN** : set to 1 to avoid running chown -Rf on /var/www/html
27-
- **SKIP_COMPOSER** : set to 1 to avoid installing composer
4+
### Git
5+
6+
| Name | Description |
7+
|--------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
8+
| 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`) |
9+
| GIT_BRANCH | Select a specific branch (optional) |
10+
| GIT_EMAIL | Set your email for code pushing (required for git to work) |
11+
| GIT_NAME | Set your name for code pushing (required for git to work) |
12+
| 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 |
13+
| SSH_KEY | Private SSH deploy key for your repository base64 encoded (requires write permissions for pushing) |
14+
| GIT_PERSONAL_TOKEN | Personal access token for your git account (required for HTTPS git access) |
15+
| GIT_USERNAME | Git username for use with personal tokens. (required for HTTPS git access) |
16+
17+
### Others
18+
19+
| Name | Description |
20+
|-------------------------|----------------------------------------------------------------------------------------------------------------|
21+
| WEBROOT | Change the default webroot directory from `/var/www/html` to your own setting |
22+
| ERRORS | Set to 1 to display PHP Errors in the browser |
23+
| HIDE_NGINX_HEADERS | Disable by setting to 0, default behaviour is to hide nginx + php version in headers |
24+
| PHP_MEM_LIMIT | Set higher PHP memory limit, default is 128 Mb |
25+
| PHP_POST_MAX_SIZE | Set a larger post_max_size, default is 100 Mb |
26+
| PHP_UPLOAD_MAX_FILESIZE | Set a larger upload_max_filesize, default is 100 Mb |
27+
| DOMAIN | Set domain name for Lets Encrypt scripts |
28+
| REAL_IP_HEADER | set to 1 to enable real ip support in the logs |
29+
| REAL_IP_FROM | set to your CIDR block for real ip in logs |
30+
| RUN_SCRIPTS | Set to 1 to execute scripts |
31+
| PGID | Set to GroupId you want to use for nginx (helps permissions when using local volume) |
32+
| PUID | Set to UserID you want to use for nginx (helps permissions when using local volume) |
33+
| REMOVE_FILES | Use REMOVE_FILES=0 to prevent the script from clearing out /var/www/html (useful for working with local files) |
34+
| APPLICATION_ENV | Set this to development to prevent composer deleting local development dependencies |
35+
| SKIP_CHOWN | Set to 1 to avoid running chown -Rf on /var/www/html |
36+
| SKIP_COMPOSER | Set to 1 to avoid installing composer |

0 commit comments

Comments
 (0)