# GitList: an elegant git repository viewer
Not by Apollia, but modified by Apollia.
09:06:35 06/21/2018. Apollia's note: I hastily and messily modified this:
* To stop it from displaying email addresses.
* To make the .htaccess file work the way I wanted on my web host.
* To make it possible to store the config.ini file outside of the repo folder.
02:02:48 06/27/2018. I made it so if the file "$HOME/apconfig/Gitolite/Default-Version/apstuff/List of most recently modified repos" exists, the repos listed inside it will be put at the top of GitList's list.
To build the list of most recently modified repos automatically, you can use a Gitolite trigger script, such as the one in this repo:
[https://apollia.org/gitlist/GitList-and-Gitolite-Setup-on-DreamHost-Shared-Web-Hosting---Optional-Add-On---Show-Most-Recently-Modified-Repos-at-Top.git](https://apollia.org/gitlist/GitList-and-Gitolite-Setup-on-DreamHost-Shared-Web-Hosting---Optional-Add-On---Show-Most-Recently-Modified-Repos-at-Top.git)
To use that Gitolite trigger script, you'll need to enable that trigger script in your Gitolite rc file, or use the Gitolite rc file included in that repo.
03:07:12 07/10/2018. Now, if you're on a page related to a particular repo, that repo's name will be displayed in the title visible in the title bar of your web browser's window.
I accomplished that by editing a Twig template named layout.twig. (Actually, I edited both copies of that file in this repo - I'm not sure which one GitList actually uses.)
I was surprised to find that my customizations weren't immediately displayed, unless I set "debug" to true in GitList's config.ini.
But, from this page - [https://github.com/klaussilveira/gitlist/wiki/Customizing](https://github.com/klaussilveira/gitlist/wiki/Customizing) - I learned that to see my changes without using debug mode, I had to clear GitList's cache.
I did that by logging into my website's shell account, going to the $HOME/apollia.org/gitlist folder, and running these commands:
mv cache cache-aside
mkdir cache
Then, my customized titles appeared.
**Ideas for new features**
* 20:52:47 08/03/2019. A way for the user to easily choose between displaying the main list of repos in alphabetical order, or with the most recently modified repos at the top.
* 20:55:01 08/03/2019. An RSS feed, and perhaps even a web page, which shows all the most recent updates to any repo. (An XSLT sheet could be used to convert the RSS feed into a web page.)
* 21:28:09 08/03/2019. A theme with a dark background.
* 00:38:39 08/12/2019. A config.ini setting which lets you optionally stop GitList from providing .tar files.
* 00:40:41 08/12/2019. The URLs of old versions of a repo should be something like:
https://apollia.org/gitlist/gitlist.git/old-version/bcd589ee4f7aefe75a5493e1044753c9f7a6581f
...instead of the way it currently is:
https://apollia.org/gitlist/gitlist.git/bcd589ee4f7aefe75a5493e1044753c9f7a6581f
That will make it easier to block old-version GitList pages in robots.txt.
* 00:49:41 08/12/2019. It appears the reason the GitList cache can get so huge is not because of cached PHP pages, but because of old cached zip and tar archives of old versions of repos.
It might be nice to be able to cache only the zip files of tagged old versions.
* 00:55:01 08/12/2019. An config.ini setting which lets you store the cache in a different folder.
* 15:32:08 08/23/2019. The optional ability to have the repo descriptions displayed in HTML format rather than plain text, so the descriptions in the main list can contain hyperlinks.
* 15:25:23 08/24/2019. I'd like to be able to have the repo descriptions shown at the top of repo pages.
* 15:25:55 08/24/2019. On the commit history pages, I'd like to be able to have the entire commit message shown by default, rather than only the first paragraph.
* 14:09:21 08/25/2019. I want the text "LH64_602_B2" (which contains underscores) to display correctly, instead of mistakenly being shown as "LH64602B2" with no underscores.
End of text by Apollia.
----
GitList is an elegant and modern web interface for interacting with multiple git repositories. It allows you to browse repositories using your favorite browser, viewing files under different revisions, commit history, diffs. It also generates RSS feeds for each repository, allowing you to stay up-to-date with the latest changes anytime, anywhere. GitList was written in PHP, on top of the [Silex](http://silex.sensiolabs.org/) microframework and powered by the Twig template engine. This means that GitList is easy to install and easy to customize. Also, the GitList gorgeous interface was made possible due to [Bootstrap](http://twitter.github.com/bootstrap/).
## Features
* Multiple repository support
* Multiple branch support
* Multiple tag support
* Commit history, blame, diff
* RSS feeds
* Syntax highlighting
* Repository statistics
## Requirements
In order to run GitList on your server, you'll need:
* PHP 5.3+
* git
* Webserver (Apache, nginx, lighttpd)
## Installation
* Download GitList from [gitlist.org](http://gitlist.org/) and decompress to your `/var/www/gitlist` folder, or anywhere else you want to place GitList.
* Do not download a branch or tag from GitHub, unless you want to use the development version. The version available for download at the website already has all dependencies bundled, so you don't have to use composer or any other tool
* Rename the `config.ini-example` file to `config.ini`.
* Open up the `config.ini` and configure your installation. You'll have to provide where your repositories are located.
* In case GitList isn't accessed through the root of the website, open `.htaccess` and edit RewriteBase (for example, `/gitlist/` if GitList is accessed through http://localhost/gitlist/).
* Set file permissions for `.htaccess`
```
chmod 644 .htaccess
```
* Create the cache folder and give read/write permissions to your web server user:
```
cd /var/www/gitlist
mkdir cache
chmod 777 cache
```
That's it, installation complete! If you're having problems, check the [Troubleshooting](https://github.com/klaussilveira/gitlist/wiki/Troubleshooting) page.
## Authors and contributors
* [Klaus Silveira](http://www.klaussilveira.com) (Creator, developer)
## License
[New BSD license](http://www.opensource.org/licenses/bsd-license.php)
## Development
GitList uses [Composer](http://getcomposer.org/) to manage dependencies and [Ant](http://ant.apache.org/) to build the project.
Once you have all the dependencies set, you can clone the repository and run Ant:
```
git clone https://github.com/klaussilveira/gitlist.git
ant
```
If you just want to get the project dependencies, instead of building everything:
```
git clone https://github.com/klaussilveira/gitlist.git
curl -s http://getcomposer.org/installer | php
php composer.phar install
```
If you have Composer in your path, things get easier. But you know the drill.
## Contributing
If you are a developer, we need your help. GitList is a young project and we have lots of stuff to do. Some developers are contributing with new features, others with bug fixes. But you can also dedicate yourself to refactoring the current codebase and improving what we already have. This is very important, we want GitList to be a state-of-the-art application, and we need your help for that.
* Stay tuned to possible bugs, suboptimal code, duplicated code, overcomplicated expressions and unused code
* Improve the test coverage by creating unit and functional tests
## Further information
If you want to know more about customizing GitList, check the [Customization](https://github.com/klaussilveira/gitlist/wiki/Customizing) page on the wiki. Also, if you're having problems with GitList, check the [Troubleshooting](https://github.com/klaussilveira/gitlist/wiki/Troubleshooting) page. Don't forget to report issues and suggest new features! :)