Skip to content

Commit 7fcae5d

Browse files
committed
docs(git_cdn): add GCDN001 help header/footer markdown
module_git_cdn (id GCDN001) had a config.software.json entry but no help header/footer markdown. Add them in the APT001 (apt-cacher-ng) style: overview + key features in the header, tabbed access / client config / directories / logs in the footer. Signed-off-by: Igor Pecovnik <igor@armbian.com>
1 parent b397894 commit 7fcae5d

2 files changed

Lines changed: 38 additions & 0 deletions

File tree

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
=== "Access to the service"
2+
3+
The proxy listens on port **8000**:
4+
5+
- URL: `http://<your.IP>:8000`
6+
7+
=== "Client configuration"
8+
9+
On each git host on the LAN, redirect GitHub through the proxy:
10+
11+
```sh
12+
git config --global \
13+
url."http://<your.IP>:8000/".insteadOf https://github.com/
14+
```
15+
16+
Then clone normally — fetches are served from the local cache:
17+
18+
```sh
19+
git clone https://github.com/<owner>/<repo>.git
20+
```
21+
22+
=== "Directories"
23+
24+
- Cache: `/armbian/git_cdn/cache/`
25+
26+
=== "View logs"
27+
28+
```sh
29+
docker logs -f git_cdn
30+
```
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
**git_cdn** is a caching git+HTTP(s) proxy that mirrors an upstream git server (GitHub) close to your build/CI hosts. The first clone or fetch of a repository populates the cache; every subsequent clone/fetch of the same repo from any host on the LAN pulls only new objects from upstream — saving WAN bandwidth and speeding up repeated GitHub clones.
2+
3+
**Key Features**
4+
5+
- git+http(s) proxy in front of `https://github.com`
6+
- Single-port (`8000`), single-container deployment
7+
- Pack-level object cache, configurable size (default 500 GB)
8+
- Survives container restart — cache lives on a host bind-mount

0 commit comments

Comments
 (0)