Skip to content
Normal view History Permalink
README.md 1 KiB
Newer Older
nimrod's avatar
Scaffolding.
nimrod committed
1 2 
# cgit
nimrod's avatar
Updates.  
nimrod committed
3 4 
[![coverage report](https://git.shore.co.il/shore/cgit-docker/badges/master/coverage.svg)](https://git.shore.co.il/shore/cgit-docker/-/commits/master)
nimrod's avatar
Scaffolding.
nimrod committed
5 6 
> cgit Docker image.
nimrod's avatar
Various improvements.  
nimrod committed
7 8 9 
## Usage

This container runs Apache that is configured with cgit at `/cgit`. It exposes
nimrod's avatar
Use file capabilities to run as a limited user.  
nimrod committed
10 
port 80 and serves the repositories under `/srv/git`. The container runs as
nimrod's avatar
Various improvements.  
nimrod committed
11 12 13 14 15 16 17 
a limited user (`www-data`), so make sure to have the content of `/srv/git`
readble by it. Also, if you wish to persist the cache, the location is
`/var/cache/cgit`.

## Example usage

```
nimrod's avatar
Use file capabilities to run as a limited user.  
nimrod committed
18 
docker -v '/srv/git:/srv/git:ro' -p '80:80' adarnimrod/cgit
nimrod's avatar
Various improvements.  
nimrod committed
19 20 21 22 
```

There's also a `docker-compose.yml` as further example.
nimrod's avatar
Scaffolding.
nimrod committed
23 24 25 26 27 28 
## License

This software is licensed under the MIT license (see `LICENSE.txt`).

## Author Information
nimrod's avatar
Updates.  
nimrod committed
29 30 31 
Nimrod Adar, [contact me](mailto:nimrod@shore.co.il) or visit my
[website](https://www.shore.co.il/). Patches are welcome via
[`git send-email`](http://git-scm.com/book/en/v2/Git-Commands-Email). The repository
nimrod's avatar
Fix typo.  
nimrod committed
32 
is located at: <https://git.shore.co.il/explore/>.