Skip to content

Commit e6f6f31

Browse files
committed
Add readme for install guidelines
1 parent 86f65b5 commit e6f6f31

File tree

1 file changed

+41
-0
lines changed

1 file changed

+41
-0
lines changed

install/README.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
## Naming guidelines
2+
3+
- consists? >= 2 files:
4+
5+
archlinux-gitlab
6+
7+
## General information
8+
9+
If you have an installation guide to provide, fill in the template and place it on top
10+
of the guide or include it in your installation script (commented), again on top.
11+
12+
### Template
13+
14+
```
15+
Distribution :
16+
GitLab version :
17+
Web Server :
18+
Init system :
19+
Maintainer :
20+
Additional Notes :
21+
```
22+
23+
### Explanation
24+
25+
|**Distribution:** | The official name and version of the platform/distribution, case sensitive. |
26+
|**GitLab version** | GitLab version on which the guide/script was tested. |
27+
|**Web Server** | The web server used to serve GitLab. May be two-fold, eg. apache with mod_passenger. |
28+
|**Init system** | (Optional but recommended) The init system used by the platform if any. Examples: sysvinit, systemd, upstart, openrc, etc |
29+
|**Maintainer** | Your github username (recommended in order to track you and give credits) or your real name or both. Example of the latter: thedude (Jeffrey Lebowski) |
30+
|**Additional Notes** | Anything else you want to add. Any deviations form the official guide can be reported here. Eg. using different user than `git`, storing in different locations, etc.|
31+
32+
33+
### Example
34+
35+
```
36+
Distribution : Fedora 19
37+
GitLab version : 5.4
38+
Web Server : apache with mod_passenger
39+
Maintainer : thedude
40+
Additional Notes : the script installs `postgres` instead of `mysql` and user is `gitlab` instead of `git`
41+
```

0 commit comments

Comments
 (0)