path: root/gitweb/README
AgeCommit message (Collapse)Author
2009-12-03gitweb: Describe (possible) gitweb.js minification in gitweb/READMEJakub Narebski
Signed-off-by: Jakub Narebski <> Signed-off-by: Junio C Hamano <>
2009-12-01Merge branch 'jn/gitweb-blame'Junio C Hamano
* jn/gitweb-blame: gitweb: Add link to other blame implementation in blame views gitweb: Make linking to actions requiring JavaScript a feature gitweb.js: fix padLeftStr() and its usage gitweb.js: Harden setting blamed commit info in incremental blame gitweb.js: fix null object exception in initials calculation gitweb: Minify gitweb.js if JSMIN is defined gitweb: Create links leading to 'blame_incremental' using JavaScript gitweb: Colorize 'blame_incremental' view during processing gitweb: Incremental blame (using JavaScript) gitweb: Add optional "time to generate page" info in footer Conflicts: Makefile gitweb/gitweb.css
2009-09-01gitweb: Incremental blame (using JavaScript)Jakub Narebski
Add 'blame_incremental' view, which uses "git blame --incremental" and JavaScript (Ajax), where 'blame' use "git blame --porcelain". * gitweb generates initial info by putting file contents (from "git cat-file") together with line numbers in blame table * then gitweb makes web browser JavaScript engine call startBlame() function from gitweb.js * startBlame() opens XMLHttpRequest connection to 'blame_data' view, which in turn calls "git blame --incremental" for a file, and streams output of git-blame to JavaScript (gitweb.js) * XMLHttpRequest event handler updates line info in blame view as soon as it gets data from 'blame_data' (from server), and it also updates progress info * when 'blame_data' ends, and gitweb.js finishes updating line info, it fixes colors to match (as far as possible) ordinary 'blame' view, and updates information about how long it took to generate page. Gitweb deals with streamed 'blame_data' server errors by displaying them in the progress info area (just in case). The 'blame_incremental' view tries to be equivalent to 'blame' action; there are however a few differences in output between 'blame' and 'blame_incremental' view: * 'blame_incremental' always used query form for this part of link(s) which is generated by JavaScript code. The difference is visible if we use path_info link (pass some or all arguments in path_info). Changing this would require implementing something akin to href() subroutine from gitweb.perl in JavaScript (in gitweb.js). * 'blame_incremental' always uses "rowspan" attribute, even if rowspan="1". This simplifies code, and is not visible to user. * The progress bar and progress info are still there even after JavaScript part of 'blame_incremental' finishes work. Note that currently no link generated by gitweb leads to this new view. This code is based on patch by Petr Baudis <> patch, which in turn was tweaked up version of Fredrik Kuivinen <>'s proof of concept patch. This patch adds GITWEB_JS compile configuration option, and modifies to take gitweb.js into account. The code for was taken from Pasky's patch. Signed-off-by: Fredrik Kuivinen <> Signed-off-by: Petr Baudis <> Signed-off-by: Jakub Narebski <> Signed-off-by: Junio C Hamano <>
2009-08-05gitweb/README: Document $base_urlJakub Narebski
Signed-off-by: Jakub Narebski <> Signed-off-by: Junio C Hamano <>
2009-06-27gitweb/README: fix AliasMatch in exampleGiuseppe Bilotta
When combining "dumb client" and human-friendly access by using the '.git' extension to switch between the two, make sure the AliasMatch covers the entire request. Without a full match, a request for would result in a 404 because the server would try to access the the project 'project/shortlog/branch.' The solution is still not bulletproof, so document the possible failing case. Signed-off-by: Giuseppe Bilotta <> Signed-off-by: Junio C Hamano <>
2009-04-20Documentation: fix typos / spelling mistakesMike Ralphson
Signed-off-by: Mike Ralphson <> Signed-off-by: Junio C Hamano <>
2009-02-09Merge branch 'maint'Junio C Hamano
* maint: gitweb: add $prevent_xss option to prevent XSS by repository content rev-list: fix showing distance when using --bisect-all
2009-02-09gitweb: add $prevent_xss option to prevent XSS by repository contentMatt McCutchen
Add a gitweb configuration variable $prevent_xss that disables features to prevent content in repositories from launching cross-site scripting (XSS) attacks in the gitweb domain. Currently, this option makes gitweb ignore README.html (a better solution may be worked out in the future) and serve a blob_plain file of an untrusted type with "Content-Disposition: attachment", which tells the browser not to show the file at its original URL. The XSS prevention is currently off by default. Signed-off-by: Matt McCutchen <> Signed-off-by: Junio C Hamano <>
2009-02-02gitweb: Update README that gitweb works better with PATH_INFOJakub Narebski
One had to configure gitweb for it to find static files (stylesheets, images) when using path_info URLs. Now that it is not necessary thanks to adding BASE element to HTML head if needed, update README to reflect this fact. Signed-off-by: Jakub Narebski <> Signed-off-by: Junio C Hamano <>
2009-01-31gitweb: webserver config for PATH_INFOGiuseppe Bilotta
Document some possible Apache configurations when the path_info feature is enabled in gitweb. Signed-off-by: Giuseppe Bilotta <> Acked-by: Jakub Narebski <> Signed-off-by: Junio C Hamano <>
2008-07-27gitweb: More about how gitweb gets 'owner' of repositoryJakub Narebski
Signed-off-by: Jakub Narebski <> Acked-by: Petr Baudis <> Signed-off-by: Junio C Hamano <>
2008-07-07gitweb: Describe projects_index format in more detailJakub Narebski
Update and extend information about $projects_list file format in gitweb/README and in gitweb/INSTALL. Signed-off-by: Jakub Narebski <> Signed-off-by: Junio C Hamano <>
2008-06-08gitweb setup instruction: rewrite HEAD and root as wellAsk Bjørn Hansen
Also add a few more hints for how to setup and configure gitweb as described [jc: with a fix from Mike Hommey] Signed-off-by: Junio C Hamano <>
2008-04-22Spelling fixes in the gitweb documentationRafael Garcia-Suarez
Mostly spelling and grammar nits. Signed-off-by: Rafael Garcia-Suarez <> Signed-off-by: Junio C Hamano <>
2008-03-27gitweb: fallback to system-wide config file if default config does not existGerrit Pape
From a distribution point of view, configuration files for applications should reside in /etc/. On the other hand it's convenient for multiple instances of gitweb (e.g. virtual web servers on a single machine) to have a per-instance configuration file, just as gitweb currently supports through the file gitweb_config.perl next to the cgi. To support both at runtime, this commit introduces GITWEB_CONFIG_SYSTEM as a system-wide configuration file which will be used as a fallback if the config file sprecified throug GITWEB_CONFIG does not exist. See also Signed-off-by: Gerrit Pape <> Acked-by: Jakub Narebski <> Signed-off-by: Junio C Hamano <>
2008-02-10gitweb: Use the config file to set repository owner's name.Bruno Ribas
Now gitweb checks if gitweb.owner exists before trying to get filesystem's owner. Allow to use configuration variable gitweb.owner set the repository owner, it checks the gitweb.owner, if not set it uses filesystem directory's owner. Useful when we don't want to maintain project list file, and all repository directories have to have the same owner (for example when the same SSH account is shared for all projects, using ssh_acl to control access instead). Signed-off-by: Bruno Ribas <> Signed-off-by: Junio C Hamano <>
2008-01-30gitweb: Add info about $projectroot and $projects_list to gitweb/READMEJakub Narebski
Those two configuration variables are important enough that it is worth to explicitely write about them in the "Gitweb config file variables" section even if they are usually set during build by GITWEB_PROJECTROOT and GITWEB_LIST build (Makefile) configuration variables. Signed-off-by: Jakub Narebski <> Signed-off-by: Junio C Hamano <>
2007-12-03gitweb: Update and improve gitweb/README fileJakub Narebski
Update list of build configuration variables, add references to gitweb/INSTALL, add description of runtime and per-repository runtime configuration. Signed-off-by: Jakub Narebski <> Signed-off-by: Junio C Hamano <>
2007-06-07War on whitespaceJunio C Hamano
This uses "git-apply --whitespace=strip" to fix whitespace errors that have crept in to our source files over time. There are a few files that need to have trailing whitespaces (most notably, test vectors). The results still passes the test, and build result in Documentation/ area is unchanged. Signed-off-by: Junio C Hamano <>
2006-10-19Merge branch 'mw/pathinfo'Junio C Hamano
* mw/pathinfo: gitweb: Fix search form when PATH_INFO is enabled gitweb: Document features better gitweb: warn if feature cannot be overridden. gitweb: start to generate PATH_INFO URLs. Conflicts: gitweb/README
2006-10-08gitweb: Document features betterPetr Baudis
This expands gitweb/README to talk some more about GITWEB_CONFIG, moves feature-specific documentation in gitweb.cgi to the inside of the %features array, and adds some short description of all the features. Signed-off-by: Petr Baudis <> Signed-off-by: Junio C Hamano <>
2006-10-04Update the gitweb/README file to include setting the GITWEB_CONFIG environmentAlan Chandler
Signed-off-by: Alan Chandler <> Signed-off-by: Junio C Hamano <>
2006-10-03gitweb: document webserver configuration for common gitweb/repo URLs.Martin Waitz
Add a small apache configuration which shows how to use apache to put gitweb and GIT repositories at the same URL. Signed-off-by: Martin Waitz <> Signed-off-by: Junio C Hamano <>
2006-08-02gitweb: require $ENV{'GITWEB_CONFIG'}Matthias Lederhofer
With this patch it is possible to use gitweb.perl for developing by loading the configuration from $GITWEB_CONFIG. This might also be useful for normal usage of gitweb. Example: % cat cfg $GIT = '/usr/bin/git'; $projectroot = '/home/matled/src/git'; $projects_list = '/home/matled/src/git/git/gitweb/list'; % cat run #!/bin/sh export GATEWAY_INTERFACE="CGI/1.1" export HTTP_ACCEPT="*/*" export REQUEST_METHOD="GET" export GITWEB_CONFIG='./cfg' export QUERY_STRING=""$1"" exec ./gitweb.perl % time ./run p=git/.git > /dev/null This makes it easy to check for warnings and do performance tests after changes, you can also pipe this to lynx -dump -force-html /dev/stdin to get more than just html. This also documents the original patch adding require $GITWEB_CONFIG. Signed-off-by: Matthias Lederhofer <> Signed-off-by: Junio C Hamano <>
2006-08-01gitweb/README: do not bug Kay with gitweb questions anymoreJunio C Hamano
Signed-off-by: Junio C Hamano <>
2006-08-01gitweb: use out-of-line GIT logo.Martin Waitz
Use the normal web server instead of the CGI to provide the git logo, just like the gitweb.css. Signed-off-by: Martin Waitz <> Signed-off-by: Junio C Hamano <>
2006-08-01gitweb: fill in gitweb configuration by MakefileMartin Waitz
Generate gitweb/gitweb.cgi to reduce the need to patch gitweb.cgi by the end user. The GIT installation directory is already known by the Makefile, and can be inserted directly into gitweb. All other gitweb configuration parameters can now be specified by providing GITWEB_* variables while building GIT. These are described in gitweb/README. Signed-off-by: Martin Waitz <> Signed-off-by: Junio C Hamano <>
2006-06-17Update gitweb README: gitweb is now included with gitJakub Narebski
Signed-off-by: Junio C Hamano <>
2006-06-10Merge git:// C Hamano