Skip to content

Commit 433fac4

Browse files
committed
Move guidelines to main README, add info for epel repo in CentOS guide
1 parent 2b552fb commit 433fac4

File tree

3 files changed

+119
-81
lines changed

3 files changed

+119
-81
lines changed

README.md

Lines changed: 66 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,81 @@
11
gitlab-recipes
22
==============
33

4-
GitLab recipes for setup on different platforms, update etc.
4+
Unofficial guides for using GitLab with different software (operating systems, webservers, etc.)
5+
provided by the community, for systems other than the officially supported (Debian/Ubuntu).
56

6-
## Guidelines on community contributions
7+
Bare in mind that this repository is co-maintained by volunteers/contributors like you.
78

8-
Here you will find installation guides or automation scripts provided by the community,
9-
for systems other than the officially supported (Debian/Ubuntu).
9+
# Contributing
1010

11-
Bare in mind that this repository is co-maintained by volunteers/contributors like you.
11+
## Naming guidelines
1212

13-
### Accepting Pull Requests
13+
For better maintainance and clarity, some naming guidelines should be followed.
14+
15+
* Installation guides should be provided in README files so that they render first when viewing the repository.
16+
17+
* Installation scripts reside in a `scripts/` directory inside every platform folder.
18+
19+
### Scripts
20+
21+
There are scripts doing similar things
22+
23+
? Scripts should be named after the following scheme: platform-platform_version
24+
Example: `ubuntu-server-12.04.sh`
25+
26+
## Install information
27+
28+
If you have an installation guide to provide, fill in the template and place it on top
29+
of your guide or include it in your installation script (commented), again on top.
1430

15-
In each parent directory (install, init, web-server, etc.) you will find some conventions
16-
you need to follow in order for your Pull Request to be accepted.
31+
### Template
32+
33+
```
34+
Distribution :
35+
GitLab version :
36+
Web Server :
37+
Init system :
38+
Database :
39+
Contributor :
40+
Additional Notes :
41+
```
42+
43+
### Explanation
44+
45+
| Label | Explanation |
46+
| ---------------- | ------------------------- |
47+
| Distribution | The official name and version of the platform/distribution, case sensitive. |
48+
| GitLab version | GitLab version on which the guide/script was tested. |
49+
| Web Server | The web server used to serve GitLab. May be two-fold, eg. apache with mod_passenger. |
50+
| Init system | (Optional but recommended) The init system used by the platform if any. Examples: `sysvinit`, `systemd`, `upstart`, `openrc`, etc |
51+
| Database | The database used for installation. Examples: `mysql`, `postrgres`, `mariadb`.
52+
| Contributor | 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)** |
53+
| Additional Notes | Anything else you want to add. Any deviations form the official guide can be reported here. Eg. using rvm for ruby install, storing in different locations, etc.|
54+
55+
56+
### Example
57+
58+
```
59+
Distribution : Fedora 19
60+
GitLab version : 5.4
61+
Web Server : apache with mod_passenger
62+
Init system : systemd
63+
Database : mariadb
64+
Contributor : thedude
65+
Additional Notes : the script uses rvm to install ruby
66+
```
67+
68+
### Accepting Pull Requests
1769

1870
Please stick as close as possible to the guidelines. That way we ensure quality guides
1971
and easy to merge requests.
2072

2173
Your Pull Request will be reviewed by one of our volunteers and you will be
2274
asked to reformat it if needed. We don't bite and we will try to be as flexible
2375
as possible, so don't get intimidated by the extent of the quidelines :)
76+
77+
## Notes
78+
79+
* We try to test everything before accepting PRs, in a clean, newly installed platform.
80+
* You should read a script and understand what it does prior to running it.
81+
* If something goes wrong during installation and you think the guide/script needs fixing, file a bug report or a Pull Request.

install/README.md

Lines changed: 2 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -1,61 +1,2 @@
1-
## Naming guidelines
2-
3-
For better maintainance and clarity, some naming guidelines should be followed.
4-
5-
* Guides should be provided in README files so that they render first when viewing the repository.
6-
* Installation scripts reside in a `scripts/` directory inside every platform folder.
7-
8-
### Scripts
9-
10-
TODO: How to name multiple scripts doing similar things?
11-
12-
? Scripts should be named after the following scheme: platform-platform_version
13-
Example: `ubuntu-server-12.04.sh`
14-
15-
## General information
16-
17-
If you have an installation guide to provide, fill in the template and place it on top
18-
of your guide or include it in your installation script (commented), again on top.
19-
20-
### Template
21-
22-
```
23-
Distribution :
24-
GitLab version :
25-
Web Server :
26-
Init system :
27-
Database :
28-
Contributor :
29-
Additional Notes :
30-
```
31-
32-
### Explanation
33-
34-
| Label | Explanation |
35-
| ---------------- | ------------------------- |
36-
| Distribution | The official name and version of the platform/distribution, case sensitive. |
37-
| GitLab version | GitLab version on which the guide/script was tested. |
38-
| Web Server | The web server used to serve GitLab. May be two-fold, eg. apache with mod_passenger. |
39-
| Init system | (Optional but recommended) The init system used by the platform if any. Examples: `sysvinit`, `systemd`, `upstart`, `openrc`, etc |
40-
| Database | The database used for installation. Examples: `mysql`, `postrgres`, `mariadb`.
41-
| Contributor | 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)** |
42-
| Additional Notes | Anything else you want to add. Any deviations form the official guide can be reported here. Eg. using rvm for ruby install, storing in different locations, etc.|
43-
44-
45-
### Example
46-
47-
```
48-
Distribution : Fedora 19
49-
GitLab version : 5.4
50-
Web Server : apache with mod_passenger
51-
Init system : systemd
52-
Database : mariadb
53-
Contributor : thedude
54-
Additional Notes : the script uses rvm to install ruby
55-
```
56-
57-
## Notes
58-
59-
* We try to test everything before accepting PRs, in a clean, newly installed platform.
60-
* You should read the script and understand what it does prior to running it.
61-
* If something goes wrong during installation and you think the guide/script needs fixing, file a bug report or a Pull Request.
1+
In this directory you will find installation guides and scripts for various platforms.
2+
If you have something to contribute please read the [contributing guidelines](../README.md#Contributing).

install/centos/README.md

Lines changed: 51 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ Additional Notes : Selinux is not disabled but properly configured.
1515

1616
Please read `doc/install/requirements.md` for hardware and platform requirements.
1717

18-
This guide installs gitlab on a bare system from scratch using MySQL as the database.
19-
All Postgress installation steps are absent as they have not been tested yet.
18+
This guide installs GitLab on a bare system from scratch, using MySQL as the database.
19+
All Postgres installation steps are absent as they have not been tested yet.
2020

2121
### Important Notes
2222

@@ -27,12 +27,12 @@ violate any assumptions GitLab makes about its environment.
2727
#### If you find a bug
2828

2929
If you find a bug/error in this guide please submit an issue or pull request
30-
following the contribution guide (see `CONTRIBUTING.md`).
30+
following the contribution guide (see `install/README.md`).
3131

3232
#### Security
3333

3434
Many setup guides of Linux software simply state: "disable selinux and firewall".
35-
The original gitlab installation for ubuntu disables StrictHostKeyChecking completely.
35+
The original GitLab installation for Ubuntu disables StrictHostKeyChecking completely.
3636
This guide does not disable any of them, we simply configure them as they were intended.
3737

3838
- - -
@@ -51,28 +51,65 @@ The GitLab installation consists of setting up the following components:
5151

5252
# 1. Installing the operating system (CentOS 6.4 Minimal)
5353

54-
We start with a completely clean CentOS 6.4 "minimal" installation which can be accomplished by downloading the appropriate installation iso file. Just boot the system of the iso file and install the system.
54+
We start with a completely clean CentOS 6.4 "minimal" installation which can be
55+
accomplished by downloading the appropriate installation iso file. Just boot the
56+
system of the iso file and install the system.
57+
58+
Note that during the installation you use the *"Configure Network"* option (it's a
59+
button in the same screen where you specify the hostname) to enable the *"Connect automatically"*
60+
option for the network interface and hand (usually eth0).
5561

56-
Note that during the installation you use the *"Configure Network"* option (it's a button in the same screen where you specify the hostname) to enable the *"Connect automatically"* option for the network interface and hand (usually eth0).
5762
**If you forget this option the network will NOT start at boot.**
5863

5964
The end result is a bare minimum CentOS installation that effectively only has network connectivity and (almost) no services at all.
6065

6166
## Updating and adding basic software and services
67+
6268
### Add EPEL repository
6369

64-
*logged in as **root***
70+
[EPEL][] is a volunteer-based community effort from the Fedora project to create
71+
a repository of high-quality add-on packages that complement the Fedora-based
72+
Red Hat Enterprise Linux (RHEL) and its compatible spinoffs, such as CentOS and Scientific Linux.
6573

66-
rpm -Uvh http://dl.fedoraproject.org/pub/epel/6/x86_64/epel-release-6-8.noarch.rpm
74+
As part of the Fedora packaging community, EPEL packages are 100% free/libre open source software (FLOSS).
6775

68-
### Install the required tools for gitlab
76+
Download the GPG key for EPEL repository from [fedoraproject][keys] and install it on your system:
6977

70-
*logged in as **root***
78+
sudo wget -O /etc/pki/rpm-gpg/RPM-GPG-KEY-EPEL-6 https://fedoraproject.org/static/0608B895.txt
79+
sudo rpm --import /etc/pki/rpm-gpg/RPM-GPG-KEY-EPEL-6
80+
81+
Verify that the key got installed successfully:
82+
83+
sudo rpm -qa gpg*
84+
gpg-pubkey-0608b895-4bd22942
85+
86+
Now install the `epel-release-6-8.noarch` package, which will enable EPEL repository on your system:
87+
88+
sudo rpm -Uvh http://dl.fedoraproject.org/pub/epel/6/x86_64/epel-release-6-8.noarch.rpm
89+
90+
**Note:** Don't mind the `x86_64`, if you install on a i686 system you can use the same commands.
91+
92+
Verify that the EPEL repository is enabled as shown below. Now, you’ll see epel
93+
repository (apart from the standard base, updates and extras repositories):
94+
95+
sudo yum repolist
96+
repo id repo name status
97+
base CentOS-6 - Base 4,802
98+
epel Extra Packages for Enterprise Linux 6 - x86_64 7,879
99+
extras CentOS-6 - Extras 12
100+
updates CentOS-6 - Updates 814
101+
repolist: 13,507
102+
103+
If you can't see it listed use the folowing command to enable it:
104+
105+
sudo yum-config-manager --enable epel
106+
107+
### Install the required tools for GitLab
71108

72-
yum -y groupinstall 'Development Tools'
109+
sudo yum -y groupinstall 'Development Tools'
73110

74111
### 'Additional Development'
75-
yum -y install vim-enhanced httpd readline readline-devel ncurses-devel gdbm-devel glibc-devel \
112+
sudo yum -y install vim-enhanced httpd readline readline-devel ncurses-devel gdbm-devel glibc-devel \
76113
tcl-devel openssl-devel curl-devel expat-devel db4-devel byacc \
77114
sqlite-devel gcc-c++ libyaml libyaml-devel libffi libffi-devel \
78115
libxml2 libxml2-devel libxslt libxslt-devel libicu libicu-devel \
@@ -469,3 +506,5 @@ The setup has created an admin account for you. You can use it to log in:
469506
470507
5iveL!fe
471508

509+
[EPEL]: https://fedoraproject.org/wiki/EPEL
510+
[keys]: https://fedoraproject.org/keys

0 commit comments

Comments
 (0)