Skip to content

Commit d4dbf9e

Browse files
committed
Readme config table test
1 parent dc906bd commit d4dbf9e

File tree

1 file changed

+12
-49
lines changed

1 file changed

+12
-49
lines changed

README.md

Lines changed: 12 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -40,58 +40,21 @@ Provider and edit the `config/git-hook.php` file to make it fit your needs.
4040

4141
Custom configuration can be made within the `config/git-hook.php` file:
4242

43-
Get notified by mail. Just add your credentials:
44-
```
45-
'email_recipients' => [
46-
[
47-
['name' => 'Admin', 'address' => '[email protected]'],
48-
...
49-
]
50-
],
51-
```
52-
53-
Specify a custom email sender address:
54-
```
55-
'email_sender' => ['address' => null, 'name' => null],
56-
```
57-
58-
Perhaps your repository is somehow specially structured, if that's the case, specify yozr
59-
repository path below:
60-
```
61-
'repo_path' => '',
62-
```
63-
64-
If you want to secure the deployment process a bit more, whitelist the repository IPs:
65-
```
66-
'allowed_sources' => [],
67-
```
68-
69-
Your remote branch
70-
```
71-
'remote' => 'origin',
72-
```
73-
74-
Where is the git binary located? By default /usr/bin/git will be used.
75-
```
76-
'git_path' => '',
77-
```
78-
79-
How sould the logfile be named?
80-
```
81-
'logfile' => 'git-hook',
82-
```
43+
| Parameter | Default | Options | Description |
44+
| --------------------- | :---------------------------------: | :------------------------------------------------------------------:| --------------------------------------------------------------------------------------------------------: |
45+
| email_recipients | [] | [ ['name' => 'Admin', 'address' => '[email protected]'], ... ] | Get notified by mail. Just add your credentials |
46+
| email_email_sender | ['address' => null, 'name' => null] | ['address' => null, 'name' => null] | Specify a custom email sender address |
47+
| repo_path | null | Leave empty to ato detect the vcs root | Perhaps your repository is somehow specially structured, if that's the case, specify your repository path |
48+
| allowed_sources | [] | ['192.168.1.1', '192.168.1.2', ...] | If you want to secure the deployment process a bit more, whitelist the remote repository IPs |
49+
| remote | origin | | Your remote branch name |
50+
| git_path | /usr/bin/git | | Where is the git binary located |
51+
| logfile | git-hook | | Name of the logfile. It will be stored under storage/logs |
52+
| service | github | `github`, `gitbucket` | Define your remote git service. This is required to identify the payload |
53+
| url | git-hook | | Define the deployment url. Keep in mind, that the given parameter will be added to your app.url |
8354

84-
Define your remote git service. This is required to identify the payload.
85-
Currently supported: `github`, `gitbucket`
86-
```
87-
'service' => 'github',
88-
```
8955

90-
How should your deployment url (git hook) look like? You can be as creative as you want ;)
9156
If you are concerned someone could guess it, use a more cryptic url such as: `JHFUjhd67567JHFGhsd78236784wegfJHFghdgf`
92-
```
93-
'url' => 'git-hook'
94-
```
57+
9558

9659
## Potential problems:
9760

0 commit comments

Comments
 (0)