blob: a899b2d3e780fe54477a3c48656631e292f99955 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
|
# 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.
|
