Difference between revisions of "Cgit"

From Alpine Linux
Jump to: navigation, search
(cgit)
m (Run cgit using spawn-fcgi and fcgiwrap)
 
(7 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Draft}}
+
[https://git.zx2c4.com/cgit/ cgit] is a fast web-interface (CGI) for git written in the C programming language. It makes it possible for potential contributors to track and view project source code from the web instead of through a git client.
  
[http://hjemli.net/git/cgit/ cgit] is a CGI-application that was written in C and a web interface for git repositories provides.
+
== Installation ==
 +
{{Note|It is very recommendable that you already have a directory with an active .git working in your server. If you don't have one, install [[gitolite]] or a similar program before going further.}}
 +
Install the package that contains cgit and git.
 +
{{Cmd|apk add cgit git}}
  
Running instance: [http://git.alpinelinux.org/ git.alpinelinux.org]
+
Open up /etc/cgitrc with your favorite editor, in this case is vim.
 +
{{Cmd|vim /etc/cgitrc}}
  
== Lighttpd ==
+
If you want to show an specific repository your configuration should look something like this:
Make sure that [[Lighttpd]] is already installed.
+
{{Cat|/etc/cgitrc|<nowiki>
{{Cmd|rc-service lighttpd status}}
+
virtual-root=/
You will receive the lighttpd status as '''stopped''' or '''started''' if it is already installed. If you receive the answer: '''service `lighttpd' does not exist.''' issue the command below:
+
repo.path=/var/lib/git/repositories/YOUR_GIT_REPO.git/
 +
repo.url=CUSTOM_GIT_URL
 +
</nowiki>
 +
}}
 +
 
 +
If you want to scan and show all the repositories you have, your configuration should look something like this:
 +
{{Cat|/etc/cgitrc|<nowiki>
 +
virtual-root=/
 +
scan-path=/var/lib/git/repositories/
 +
</nowiki>
 +
}}
 +
 
 +
=== Run cgit using spawn-fcgi and fcgiwrap ===
 +
Create a new service by doing a symbolic link.
 +
{{Cmd|ln -s /etc/init.d/spawn-fcgi /etc/init.d/spawn-fcgi.cgit}}
 +
Create a configuration file called spawn-fcgi.cgit in /etc/conf.d/ ; the service will run fcgiwrap automatically everytime is called. It should look exactly like this:
 +
{{Cat|/etc/conf.d/spawn-fcgi.cgit|<nowiki>
 +
FCGI_PORT=1234
 +
FCGI_PROGRAM=/usr/bin/fcgiwrap
 +
</nowiki>
 +
}}
 +
Start the newly created service.
 +
{{Cmd|rc-service spawn-fcgi.cgit start}}
 +
 
 +
== Run cgit with a web service ==
 +
 
 +
=== Configure Lighttpd to work with cgit ===
 +
Install the package that contains lighttpd if you haven't already.
 
{{Cmd|apk add lighttpd}}
 
{{Cmd|apk add lighttpd}}
  
 
Create a cgit.conf file into the lighttpd directory with the following content:
 
Create a cgit.conf file into the lighttpd directory with the following content:
{{Cat|/etc/lighttpd/cgit.conf|<nowiki>server.modules += ("mod_redirect",
+
{{Cat|/etc/lighttpd/cgit.conf|<nowiki>
 +
server.modules += ("mod_redirect",
 
                   "mod_alias",
 
                   "mod_alias",
 
                   "mod_cgi",
 
                   "mod_cgi",
Line 36: Line 68:
 
}}
 
}}
  
== cgit ==
+
Restart the lighttpd service.
Install cgit
+
{{Cmd|rc-service lighttpd restart}}
  
{{cmd|apk add cgit git}}
+
=== Configure NGINX to work with cgit pointing to a subdomain ===
  
Initialize a sample git repository
+
Install the package that contains NGINX if you haven't already.
 +
{{Cmd|apk add nginx}}
  
{{cmd|git init --bare /var/git/sample.git}}
+
Create a custom configuration in the NGINX's conf.d directory.
 +
{{Cmd|vim /etc/nginx/conf.d/git.your_domain.com.conf}}
  
Edit the /etc/cgitrc file:
+
The file should look something like this:
{{cmd|vi /etc/cgitrc}}
 
  
And make sure you have at least the following lines:
+
{{Cat|/etc/nginx/conf.d/git.your_domain.com.conf|<nowiki>
 
+
server {
{{Cat|/etc/cgitrc|css{{=}}/cgit/cgit.css
+
    server_name git.your_domain.com;
logo{{=}}/cgit/cgit.png
+
    root /usr/share/webapps/cgit;
scan-path{{=}}/var/git/
+
    try_files $uri @cgit;
enable-git-config{{=}}1
+
    location @cgit {
 +
        include fastcgi_params;
 +
        fastcgi_pass localhost:1234;
 +
        fastcgi_param SCRIPT_FILE $document_root/cgit.cgi;
 +
        fastcgi_param PATH_INFO $uri;
 +
        fastcgi_param QUERY_STRING $args;
 +
        }
 +
}
 +
</nowiki>
 
}}
 
}}
 
+
Restart the NGINX service.
If you want to group your repositories, add the every repository to a group.
+
{{Cmd|rc-service nginx restart}}
{{Cat|/etc/cgitrc|repo.group{{=}}Sample group}}
 
  
 
[[Category:Server]]
 
[[Category:Server]]
 
[[Category:Git]]
 
[[Category:Git]]

Latest revision as of 03:48, 4 September 2019

cgit is a fast web-interface (CGI) for git written in the C programming language. It makes it possible for potential contributors to track and view project source code from the web instead of through a git client.

Installation

Note: It is very recommendable that you already have a directory with an active .git working in your server. If you don't have one, install gitolite or a similar program before going further.

Install the package that contains cgit and git.

apk add cgit git

Open up /etc/cgitrc with your favorite editor, in this case is vim.

vim /etc/cgitrc

If you want to show an specific repository your configuration should look something like this:

Contents of /etc/cgitrc

virtual-root=/ repo.path=/var/lib/git/repositories/YOUR_GIT_REPO.git/ repo.url=CUSTOM_GIT_URL

If you want to scan and show all the repositories you have, your configuration should look something like this:

Contents of /etc/cgitrc

virtual-root=/ scan-path=/var/lib/git/repositories/

Run cgit using spawn-fcgi and fcgiwrap

Create a new service by doing a symbolic link.

ln -s /etc/init.d/spawn-fcgi /etc/init.d/spawn-fcgi.cgit

Create a configuration file called spawn-fcgi.cgit in /etc/conf.d/ ; the service will run fcgiwrap automatically everytime is called. It should look exactly like this:

Contents of /etc/conf.d/spawn-fcgi.cgit

FCGI_PORT=1234 FCGI_PROGRAM=/usr/bin/fcgiwrap

Start the newly created service.

rc-service spawn-fcgi.cgit start

Run cgit with a web service

Configure Lighttpd to work with cgit

Install the package that contains lighttpd if you haven't already.

apk add lighttpd

Create a cgit.conf file into the lighttpd directory with the following content:

Contents of /etc/lighttpd/cgit.conf

server.modules += ("mod_redirect", "mod_alias", "mod_cgi", "mod_fastcgi", "mod_rewrite" ) var.webapps = "/usr/share/webapps/" $HTTP["url"] =~ "^/cgit" { server.document-root = webapps server.indexfiles = ("cgit.cgi") cgi.assign = ("cgit.cgi" => "") mimetype.assign = ( ".css" => "text/css" ) } url.redirect = ( "^/git/(.*)$" => "/cgit/cgit.cgi/$1", )

Finally, add the following line to the lighttpd.conf file:

Contents of /etc/lighttpd/lighttpd.conf

include "cgit.conf"

Restart the lighttpd service.

rc-service lighttpd restart

Configure NGINX to work with cgit pointing to a subdomain

Install the package that contains NGINX if you haven't already.

apk add nginx

Create a custom configuration in the NGINX's conf.d directory.

vim /etc/nginx/conf.d/git.your_domain.com.conf

The file should look something like this:

Contents of /etc/nginx/conf.d/git.your_domain.com.conf

server { server_name git.your_domain.com; root /usr/share/webapps/cgit; try_files $uri @cgit; location @cgit { include fastcgi_params; fastcgi_pass localhost:1234; fastcgi_param SCRIPT_FILE $document_root/cgit.cgi; fastcgi_param PATH_INFO $uri; fastcgi_param QUERY_STRING $args; } }

Restart the NGINX service.

rc-service nginx restart