blob: 6a64b7f9c7b88b49f9d154639d891ac427596587 (
plain) (
blame)
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
|
cgitize
=======
[](https://github.com/egor-tensin/cgitize/actions/workflows/ci.yml)
Self-host your repositories using cgit.
Supports cloning all of your repositories from major hosting providers:
* GitHub,
* Bitbucket,
* GitLab.
Example output can be found at https://git.egort.name/.
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
You can run `cgitize` in a Docker container.
A separate image includes a web server with a configured cgit installation.
Please see [docker/README.md](docker/README.md) for details.
Mirror maintenance
------------------
Update the URL of an existing repository mirror:
git remote set-url origin git@examples.com/username/name.git
Development
-----------
### Virtual environment
Create a virtual environment:
make venv
Load a REPL:
make repl
Upgrade virtual environment packages (this will also update requirements.txt):
make venv/upgrade
### 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
|
