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
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
|
cgitize
=======
[](https://github.com/egor-tensin/cgitize/actions/workflows/ci.yml)
Mirror your git repositories and make them cgit-ready.
Supports cloning all of your repositories from major hosting providers:
* GitHub,
* Bitbucket,
* GitLab.
Example output can be found at https://egort.name/git/.
Installation
------------
pip install cgitize
Usage
-----
Pass the path to the config to `cgitize` (/etc/cgitize/cgitize.toml by
default):
cgitize --config path/to/cgitize.toml
See an example config file at [examples/cgitize.toml].
cgitize uses the `git` executable, which might use `ssh` internally.
Make sure the required keys are loaded to a ssh-agent (or use access
tokens/application passwords).
[examples/cgitize.toml]: examples/cgitize.toml
### Docker
The image is **egortensin/cgitize**.
| Path | Description
| ------------------------- | -----------
| /etc/cgitize/cgitize.toml | Configuration file path.
| /mnt/cgitize | Default output directory for cloned repositories.
| /ssh-agent.sock | If SSH is required, map the socket here.
| Environemnt variable | Description
| -------------------- | -----------
| SCHEDULE | cron job schedule \[1\].
1. cgitize is executed as a cron job inside the container.
The `SCHEDULE` environment variable controls how often it gets run.
By default, it's set to `once`, which makes the container exit after the first
run.
You can also set it to `15min`, `hourly`, `daily`, `weekly`, `monthly` or a
custom 5-part cron schedule like `*/5 * * * *`.
#### Frontend
There's a web server image with a working cgit installation:
**egortensin/cgitize-frontend**.
| Path | Description
| ------------ | -----------
| /etc/cgitrc | If you use a custom cgit configuration, map it here \[1\].
| /mnt/cgitize | Map cgitize's output directory here.
1. A custom cgitrc might look like this:
# Include most common useful settings.
include=/etc/cgit/common
# If you serve from a subdirectory.
virtual-root=/secret/
root-title=Custom title
root-desc=Custom description
#### Compose
See the root docker-compose.yml file for a possible services definition.
In this configuration, cgitize pulls my repositories from GitHub every 3 hours.
You can test it by running
docker-compose build
docker-compose up -d
and visiting http://localhost:80/.
Mirror maintenance
------------------
Update the URL of an existing repository mirror:
git remote set-url origin git@examples.com/username/name.git
Development
-----------
### Packaging
The [packaging tutorial] (as it was in April 2021) on python.org was used to
make a PyPI package.
Basically, it looks to me like the Python ecosystem is currently moving from
the older setup.py to the newer setup.cfg/pyproject.toml.
It's still a bit clunky: you have to install the `build` package, placeholder
setup.py is required for `pip install -e` to work, etc.
[packaging tutorial]: https://packaging.python.org/tutorials/packaging-projects
### Linting
Requires [Pylint].
pylint cgitize
[Pylint]: https://www.pylint.org/
License
-------
Distributed under the MIT License.
See [LICENSE.txt] for details.
[LICENSE.txt]: LICENSE.txt
|
