# cgit (dockerized)

A dockerized, production-ready version of
[cgit](https://git.zx2c4.com/cgit/about/) - a hyperfast web interface for Git
repositories. This implementation is optimized for Docker deployment with
Lighttpd and seamless Gitea integration.

## ✨ Features

- 🐳 **Docker-Optimized**: Multi-stage builds for minimal image size and fast
  deployment
- ⚡ **Lighttpd Integration**: Lightweight web server with CGI support and Git
  HTTP smart proxy
- 🎨 **Syntax Highlighting**: Highlight v4 integration for beautiful code
  display
- 📊 **Repository Activity Tracking**: Correctly displays the latest activity
  timestamp for each repository in the main repository list
- 🌙 **Dark Mode Support**: Enhanced dark theme for improved readability and
  reduced eye strain
- ✍️ **Better Typography**: Improved font rendering with Source Code Pro for
  optimal code readability
- 🔄 **Latest Git**: Upgraded to Git v2.51.2 for cutting-edge features and
  security fixes
- 🔒 **Production Ready**: Configured for performance, security, and reliability

## 🚀 Quick Start

### Prerequisites

- Docker and Docker Compose installed

### Installation

```bash
# Clone the repository
git clone https://git.bktus.com/pub/cgit.git
cd cgit

# Initialize and update Git submodules
git submodule update --init --recursive

# Build and start the containers
docker-compose up -d

# Verify the service is running
docker-compose ps
```

Access the cgit interface at **http://localhost:8080**

### Configuration

Edit `cgitrc` to customize your cgit installation:

```bash
# Edit the configuration file
vim cgitrc

# Rebuild the container after changes
docker-compose up -d --build
```

## 🛠️ Development

### Building from Source

```bash
# Build the Docker image manually
docker build -t cgit:latest .

# Run with custom configuration
docker run -d \
  -p 8080:80 \
  -v /path/to/repos:/git \
  -v /path/to/cgitrc:/etc/cgitrc:ro \
  cgit:latest
```

### Local Testing

```bash
# Start in development mode
docker-compose up

# View logs
docker-compose logs -f
```

## 📚 Documentation

- **cgit Configuration**: See `README.cgit` or visit the [official
  documentation](https://git.zx2c4.com/cgit/about/)
- **cgitrc Man Page**: Run `man cgitrc` or read `cgitrc.5.txt`
- **Git Submodule**: Mirrored at https://git.bktus.com

## 🤝 Contributing

Contributions are welcome! Please feel free to submit issues or pull requests.

## 📝 License

cgit is licensed under the **GNU General Public License v2.0**. See `COPYING`
for full details.