Commit | Line | Data |
9eaaf804 |
1 | NAME |
f3c25197 |
2 | Gitalist - A modern git web viewer |
4534cd82 |
3 | |
9eaaf804 |
4 | SYNOPSIS |
02404ff5 |
5 | perl script/gitalist_server.pl --repo_dir /home/me/code/git |
4534cd82 |
6 | |
b6d010e1 |
7 | INSTALL |
8 | As Gitalist follows the usual Perl module format the usual approach for |
0556ab26 |
9 | installation should work, e.g.: |
b6d010e1 |
10 | |
02404ff5 |
11 | perl Makefile.PL |
12 | make |
13 | make test |
14 | make install |
b6d010e1 |
15 | |
63f34424 |
16 | or |
17 | |
02404ff5 |
18 | cpan -i Gitalist |
63f34424 |
19 | |
0556ab26 |
20 | You can also check Gitalist out from its git repository and run it, in |
21 | this case you'll additionally need the author modules, but no |
22 | configuration will be needed as it will default to looking for |
23 | repositories the directory above the checkout. |
b6d010e1 |
24 | |
9eaaf804 |
25 | DESCRIPTION |
0556ab26 |
26 | Gitalist is a web frontend for git repositories based on <gitweb.cgi> |
27 | and backed by Catalyst. |
b6d010e1 |
28 | |
29 | History |
0556ab26 |
30 | This project started off as an attempt to port *gitweb.cgi* to a |
31 | Catalyst app in a piecemeal fashion. As it turns out, thanks largely to |
32 | Florian Ragwitz's earlier effort, it was easier to use *gitweb.cgi* as a |
33 | template for building a new Catalyst application. |
4534cd82 |
34 | |
69175e49 |
35 | GETTING GITALIST |
36 | You can install Gitalist from CPAN in the usual way: |
37 | |
38 | cpan -i Gitalist |
39 | |
40 | Alternatively, you can get Gitalist using git. |
41 | |
42 | The canonical repository for the master branch is: |
43 | |
3d0e045e |
44 | git://git.shadowcat.co.uk/catagits/Gitalist.git |
69175e49 |
45 | |
0556ab26 |
46 | Gitalist is also mirrored to GitHub at |
47 | <https://github.com/broquaint/Gitalist>, and a number of people have |
48 | active forks with branches and/or new features in the master branch. |
69175e49 |
49 | |
ccb79ac8 |
50 | BOOTSTRAPPING |
51 | As of 0.002001 Gitalist can now be bootstrapped to run out of its own |
52 | directory by installing its prerequisites locally with the help of |
53 | local::lib. So instead of installing the prerequisites to the system |
54 | path with CPAN they are installed under the Gitalist directory. |
55 | |
56 | To do this clone Gitalist from the Shadowcat repository mentioned above |
0556ab26 |
57 | or grab a snapshot from broquaint's GitHub repository: |
ccb79ac8 |
58 | |
0556ab26 |
59 | https://github.com/broquaint/Gitalist/downloads |
ccb79ac8 |
60 | |
61 | With the source acquired and unpacked run the following from within the |
62 | Gitalist directory: |
63 | |
e2c6e7c1 |
64 | perl script/bootstrap.pl |
ccb79ac8 |
65 | |
66 | This will install the necessary modules for the build process which in |
67 | turn installs the prerequisites locally. |
68 | |
0556ab26 |
69 | NB: The relevant bootstrap scripts aren't available in the CPAN dist as |
e2c6e7c1 |
70 | the bootstrap scripts should not be installed. |
71 | |
69175e49 |
72 | INITIAL CONFIGURATION |
73 | Gitalist is configured using Catalyst::Plugin::Configloader. The |
74 | supplied sample configuration is in Config::General format, however it |
75 | is possible to configure Gitalist using other config file formats (such |
76 | as YAML) if you prefer. |
77 | |
78 | WHEN CHECKING GITALIST OUT OF GIT |
79 | Gitalist from git includes a minimal "gitalist_local.conf", which sets |
80 | the repository directory to one directory higher than the Gitalist |
81 | repository. |
82 | |
83 | This means that if you check Gitalist out next to your other git |
84 | checkouts, then starting the demo server needs no parameters at all: |
85 | |
02404ff5 |
86 | Gitalist [master]$ perl script/gitalist_server.pl |
69175e49 |
87 | You can connect to your server at http://localhost:3000 |
88 | |
89 | FOR CPAN INSTALLS |
63f34424 |
90 | Gitalist can be supplied with a config file by setting the |
91 | "GITALIST_CONFIG" environment variable to point to a configuration file. |
92 | |
69175e49 |
93 | If you install Gitalist from CPAN, a default configuration is installed |
94 | along with gitalist, which is complete except for a repository |
95 | directory. You can get a copy of this configuration by running: |
63f34424 |
96 | |
97 | cp `perl -Ilib -MGitalist -e'print Gitalist->path_to("gitalist.conf")'` gitalist.conf |
98 | |
0556ab26 |
99 | You can then edit this configuration, adding a "repo_dir" path and |
100 | customising other settings as desired. |
69175e49 |
101 | |
102 | You can then start the Gitalist demo server by setting |
103 | "GITALIST_CONFIG". For example: |
104 | |
105 | GITALIST_CONFIG=/usr/local/etc/gitalist.conf gitalist_server.pl |
63f34424 |
106 | |
107 | Alternatively, if you only want to set a repository directory and are |
108 | otherwise happy with the default configuration, then you can set the |
3d0e045e |
109 | "GITALIST_REPO_DIR" environment variable, or pass the "--repo_dir" flag |
110 | to any of the scripts. |
63f34424 |
111 | |
3d0e045e |
112 | GITALIST_REPO_DIR=/home/myuser/code/git gitalist_server.pl |
113 | gitalist_server.pl --repo_dir home/myuser/code/git |
69175e49 |
114 | |
3d0e045e |
115 | The "GITALIST_REPO_DIR" environment variable will override the |
63f34424 |
116 | repository directory set in configuration, and will itself be overridden |
3d0e045e |
117 | by he "--repo_dir" flag. |
63f34424 |
118 | |
69175e49 |
119 | RUNNING |
120 | Once you have followed the instructions above to install and configure |
121 | Gitalist, you may want to run it in a more production facing environment |
122 | than using the single threaded developement server. |
123 | |
124 | The recommended deployment method for Gitalist is FastCGI, although |
0556ab26 |
125 | Gitalist can also be run under <mod_perl> or as pure Perl with |
69175e49 |
126 | Catalyst::Engine::PreFork. |
127 | |
128 | Assuming that you have installed Gitalist's dependencies into a |
129 | local::lib, and you are running from a git checkout, adding a trivial |
130 | FCGI script as "script/gitalist.fcgi" (this file is specifically in |
131 | ".gitignore" so you can have your own copy): |
132 | |
133 | #!/bin/sh |
69175e49 |
134 | exec /home/t0m/public_html/Gitalist/script/gitalist_fastcgi.pl |
f857f98d |
135 | |
69175e49 |
136 | This example can be seen live here: |
137 | |
f857f98d |
138 | http://example.gitalist.com |
139 | |
5111a8ab |
140 | CONFIGURATION |
141 | The Gitalist config is loaded with Catalyst::Plugin::ConfigLoader and |
142 | the available config options are: |
143 | |
144 | Model::CollectionOfRepos |
145 | git Path to the "git" binary. |
146 | |
147 | repo_dir |
148 | A directory containing the directories to show. |
149 | |
8bf1f781 |
150 | repos |
151 | A list of directories containing repositories to show. |
5111a8ab |
152 | |
153 | search_recursively |
154 | A boolean indicating whether to always search recursively for |
155 | repositories within "repo_dir". |
156 | |
157 | whitelist |
158 | Path a file containing a list of repositories that can be shown. |
159 | Each line in the file will represent the name of a repo to show e.g |
160 | |
161 | Gitalist |
162 | some-bare-repo.git |
163 | |
164 | This is compatible with "gitweb"'s "projects.list". |
165 | |
166 | export_ok |
167 | If provided every must contain a file of the same name to be |
168 | visible. This is similar to "gitweb"'s functionality. |
169 | |
170 | paging |
8bf1f781 |
171 | log The number of commits to show in the summary, shortlog and longlog |
172 | views. |
5111a8ab |
173 | |
f857f98d |
174 | FASTCGI |
0556ab26 |
175 | Running Gitalist in FastCGI mode requires a webserver with FastCGI |
176 | support (such as apache with <mod_fcgi> or <mod_fcgid>). Below is a |
177 | sample configuration using Apache2 with mod_fcgid in a dynamic |
178 | configuration (as opposed to static or standalone mode). More |
179 | information on these modes and their configuration can be found at |
180 | "Standalone server mode" in Catalyst::Engine::FastCGI. |
181 | |
182 | In Apache's mime.conf, add "AddHandler fcgid-script .fcgi" (or |
183 | "AddHandler fastcgi-script .fcgi" for mod_fcgi). |
184 | |
185 | And a quick VirtualHost configuration: |
186 | |
187 | <VirtualHost *:80> |
188 | ServerName gitalist.yourdomain.com |
189 | DocumentRoot /path/to/gitalist.fcgi |
190 | <Directory "/path/to/gitalist.fcgi"> |
f857f98d |
191 | AllowOverride all |
192 | Options +ExecCGI -MultiViews +SymLinksIfOwnerMatch |
193 | Order allow,deny |
194 | Allow from all |
0556ab26 |
195 | </Directory> |
f857f98d |
196 | |
197 | # Tell Apache this is a FastCGI application |
198 | <Files gitalist.fcgi> |
199 | #change the below to fastcgi-script if using mod_fcgi |
200 | SetHandler fcgid-script |
201 | </Files> |
0556ab26 |
202 | </VirtualHost> |
203 | |
204 | Now to access your Gitalist instance, you'll go to |
205 | "gitalist.yourdomain.com/gitalist.fcgi/" (do not forget that trailing |
206 | "/"). If you'd like a different URL, of course, you'll likely want to |
207 | use <mod_rewrite> or equivalent. |
208 | |
209 | If you find the need to do some troubleshooting, you can call |
210 | "http://url_to_gitalist.fcgi?dump_info=1" and/or add export |
211 | "GITALIST_DEBUG=1" to the top of your gitalist.fcgi file (just below the |
212 | shebang line). |
213 | |
214 | Also, note that Apache will refuse %2F in Gitalist URLs unless |
215 | configured otherwise. Make sure "AllowEncodedSlashes On" is in your |
216 | httpd.conf file in order for this to run smoothly. |
69175e49 |
217 | |
218 | CONTRIBUTING |
219 | Patches are welcome, please feel free to fork on github and send pull |
220 | requests, send patches from git format-patch to the bug tracker, or host |
221 | your own copy of gitalist somewhere and ask us to pull from it. |
222 | |
223 | SUPPORT |
224 | Gitalist has an active irc community in "#gitalist" on irc.perl.org, |
225 | please feel free to stop by and ask questions, report bugs or |
226 | installation issues or generally for a chat about where we plan to go |
227 | with the project. |
228 | |
9eaaf804 |
229 | SEE ALSO |
b6d010e1 |
230 | Gitalist::Controller::Root |
231 | |
44a9ed75 |
232 | Gitalist::Git::Repository |
b6d010e1 |
233 | |
234 | Catalyst |
8927fe98 |
235 | |
9eaaf804 |
236 | AUTHORS AND COPYRIGHT |
237 | Catalyst application: |
0556ab26 |
238 | © 2009 Venda Ltd and Dan Brook <broq@cpan.org> |
239 | © 2009, Tom Doran <bobtfish@bobtfish.net> |
240 | © 2009, Zac Stevens <zts@cryptocracy.com> |
8927fe98 |
241 | |
9eaaf804 |
242 | Original gitweb.cgi from which this was derived: |
0556ab26 |
243 | © 2005-2006, Kay Sievers <kay.sievers@vrfy.org> |
244 | © 2005, Christian Gierke |
8927fe98 |
245 | |
b6d010e1 |
246 | Model based on http://github.com/rafl/gitweb |
0556ab26 |
247 | © 2008, Florian Ragwitz |
4534cd82 |
248 | |
b6d010e1 |
249 | LICENSE |
250 | Licensed under GNU GPL v2 |
4534cd82 |
251 | |