Skip to content

Commit c67d9c1

Browse files
committed
Improve readme
1 parent 04f46a2 commit c67d9c1

File tree

2 files changed

+11
-6
lines changed

2 files changed

+11
-6
lines changed

README.md

+9-5
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,23 @@
55

66
A daemon to mirror remote Git repositories and serve them over HTTP, automatically updating the mirror as needed.
77

8-
It can be used in CI environments to improve the performance of Git clone operations.
8+
It was developed to be used in CI environments to improve the performance of Git clone operations.
99

10-
This is a C++/CURL clone of jonasmalacofilho's [git-cache-http-server](https://github.com/jonasmalacofilho/git-cache-http-server).
10+
The project is a C++/CURL clone of jonasmalacofilho's [git-cache-http-server](https://github.com/jonasmalacofilho/git-cache-http-server).
1111

1212
## Build Instructions
1313

1414
* Clone the repository and initialize submodules.
1515
* Build the project with `cmake`.
1616
* You can build a `deb` package using the target `package` in CMake.
1717

18-
## Setup
18+
## Server Setup
1919

2020
* Install `gchsd` from the `deb` package.
21-
* Configure a cache directory in `/etc/gchsd.conf`.
21+
* Configure a cache directory (default is `/tmp/gchsd`) and listen port (default is `80`) in `/etc/gchsd.conf`.
2222
* Start the `gchsd` daemon with `sudo systemctl start gchsd`.
23-
* You can use `sudo systemctl enable gchsd` to start the daemon automatically after a system restart.
23+
* You can use `sudo systemctl enable gchsd` to start the daemon automatically after a system restart.
24+
25+
## Client Setup
26+
27+
* Run `git config --global url."http://<mirror_server_addr>/".insteadOf https://` to use the mirror instead of the original source.

etc/gchsd.conf

+2-1
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,6 @@
33
# The default is:
44
#listenAddr 0.0.0.0:80
55

6-
# The directory in which cached Git repositories are stored
6+
# The directory in which cached Git repositories are stored.
7+
# The default is:
78
#cacheDir /tmp/gchsd

0 commit comments

Comments
 (0)