|
| 1 | +% RGIT(1) version 0.1.2 | User Commands |
| 2 | +% |
| 3 | +% 11 January 2024 |
| 4 | + |
| 5 | +NAME |
| 6 | +==== |
| 7 | + |
| 8 | +rgit - a gitweb interface written in rust |
| 9 | + |
| 10 | +SYNOPSIS |
| 11 | +======== |
| 12 | + |
| 13 | +| **rgit** \[*OPTIONS*] **\--db-store** *path* *bind_address* *scan_path* |
| 14 | + |
| 15 | +DESCRIPTION |
| 16 | +=========== |
| 17 | + |
| 18 | +A gitweb/cgit-like interface for the modern age. Written in Rust using Axum, git2, Askama, and Sled. |
| 19 | + |
| 20 | +_bind_address_ |
| 21 | + |
| 22 | +: Specifies the network address and port to serve the application on. |
| 23 | +(Required) |
| 24 | + |
| 25 | + Example: |
| 26 | + |
| 27 | + : _0.0.0.0:3333_ (localhost, port 3333 on IPv4) |
| 28 | + |
| 29 | + _[::]:3333_ (localhost, port 3333 on IPv6) |
| 30 | + |
| 31 | +_scan_path_ |
| 32 | + |
| 33 | +: Specifies the root directory where git repositories reside. Scans recursively. |
| 34 | +(Required) |
| 35 | + |
| 36 | + For information about bare git repositories, see the manual for **git-init**(1). |
| 37 | + |
| 38 | + Example: |
| 39 | + |
| 40 | + : _/srv/git_ |
| 41 | + |
| 42 | + _$HOME/git_ |
| 43 | + |
| 44 | + |
| 45 | +OPTIONS |
| 46 | +======= |
| 47 | + |
| 48 | +**-d** _path_, **\--db-store** _path_ |
| 49 | + |
| 50 | +: Path to a directory in which the Sled database should be stored, will be created if it doesn't already exist. |
| 51 | + |
| 52 | + The Sled database is very quick to generate, so this can be pointed to temporary storage. (Required) |
| 53 | + |
| 54 | + Example: |
| 55 | + |
| 56 | + : **\--db-store** _/tmp/rgit-cache.db_ |
| 57 | + |
| 58 | +**\--refresh-interval** _interval_ |
| 59 | + |
| 60 | +: Configures the metadata refresh interval. This parameter accepts human-readable time formats. |
| 61 | + |
| 62 | + Default: _5m_ |
| 63 | + |
| 64 | + Example: |
| 65 | + |
| 66 | + : **\--refresh-interval** _60s_ (refresh every 60 seconds) |
| 67 | + |
| 68 | + **\--refresh-interval** _never_ (refresh only on server start) |
| 69 | + |
| 70 | + Documentation: |
| 71 | + |
| 72 | + : https://docs.rs/humantime/latest/humantime/ |
| 73 | + |
| 74 | +EXAMPLES |
| 75 | +======== |
| 76 | + |
| 77 | +``` |
| 78 | +$ rgit -d /tmp/rgit-cache.db [::]:3333 /srv/git |
| 79 | +$ rgit --db-store /tmp/rgit-cache.db 0.0.0.0:3333 /srv/git |
| 80 | +$ rgit -d /tmp/rgit-cache.db [::]:3333 /srv/git --refresh-interval 12h |
| 81 | +
|
| 82 | +``` |
| 83 | + |
| 84 | +BUGS |
| 85 | +==== |
| 86 | + |
| 87 | +https://github.com/w4/rgit/issues |
| 88 | + |
| 89 | +AUTHORS |
| 90 | +======= |
| 91 | + |
| 92 | +Jordan Doyle \<jordan@doyle.la> |
| 93 | + |
| 94 | +REPOSITORY |
| 95 | +========== |
| 96 | + |
| 97 | +https://git.inept.dev/~doyle/rgit.git |
| 98 | + |
| 99 | +https://github.com/w4/rgit |
| 100 | + |
| 101 | +SEE ALSO |
| 102 | +======== |
| 103 | + |
| 104 | +**git**(1), |
| 105 | +**git-init**(1) |
0 commit comments