about summary refs log tree commit diff
path: root/README
blob: 8e4ed53640c6a53589559635712eecb6a6de2b61 (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
83
84
85
86

                       cgit - cgi for git


This is an attempt to create a fast web interface for the git scm, using a
builtin cache to decrease server io-pressure.


Installation

Building cgit involves building a proper version of git. How to do this
depends on how you obtained the cgit sources:

a) If you're working in a cloned cgit repository, you first need to
initialize and update the git submodule:

  $ git submodule init     # register the git submodule in .git/config
  $ $EDITOR .git/config    # if you want to specify a different url for git
  $ git submodule update   # clone/fetch and checkout correct git version

b) If you're building from a cgit tarball, you can download a proper git
version like this:

  $ make get-git


When either a) or b) has been performed, you can build and install cgit like
this:

  $ make
  $ sudo make install

This will install cgit.cgi and cgit.css into "/var/www/htdocs/cgit". You can
configure this location (and a few other things) by providing a "cgit.conf"
file (see the Makefile for details).


Dependencies:
  -git 1.7.4
  -zip lib
  -crypto lib
  -openssl lib


Apache configuration

A new Directory-section must probably be added for cgit, possibly something
like this:

  <Directory "/var/www/htdocs/cgit/">
      AllowOverride None
      Options +ExecCGI
      Order allow,deny
      Allow from all
  </Directory>


Runtime configuration

The file /etc/cgitrc is read by cgit before handling a request. In addition
to runtime parameters, this file may also contain a list of repositories
displayed by cgit (see cgitrc.5.txt for further details).


The cache

When cgit is invoked it looks for a cachefile matching the request and
returns it to the client. If no such cachefile exist (or if it has expired),
the content for the request is written into the proper cachefile before the
file is returned.

If the cachefile has expired but cgit is unable to obtain a lock for it, the
stale cachefile is returned to the client. This is done to favour page
throughput over page freshness.

The generated content contains the complete response to the client, including
the http-headers "Modified" and "Expires".


Online presence

* The cgit homepage is hosted by cgit at <http://git.zx2c4.com/cgit/about/>

* Patches, bugreports, discussions and support should go to the cgit
  mailing list: <cgit@lists.zx2c4.com>. To sign up, visit 
  <http://lists.zx2c4.com/mailman/listinfo/cgit>
ref='/shulker/commit/src/Shulker.ts?id=ccc8e3d182ebd05173c6a243c590eb78cff54a66&follow=1'>Add config deprecation noticeDaniel Matthies 2021-04-21Fixing death message false positivesDaniel Matthies 2020-10-31update packagesdestruc7i0n 2020-10-29Add option to output server status into discordelveskevtar Signed-off-by: elveskevtar <kevtar@gmail.com> 2020-10-01new config stuffsurepy 2020-10-01Add compatibility options for minecraft versions lower than 1.7.2surepy 2020-08-04Update regex for replaceDiscordMentionsMarshall Oliver 2020-08-04Add nickname to variables objMarshall Oliver To use, add %nickname% to your MINCRAFT_TELLRAW_TEMPLATE var in config. 2020-07-22Fixed coding styleFeiko Joosten Fixed the coding style based on @destruc7i0n's feedback. 2020-07-17Changed tail to make use of watch file.Feiko Joosten Fixed an issue where the log file required a manual refresh before the new lines were detected. 2020-05-23Fixed user mention detectionZachery Notz 2020-05-23Improved regex so that TELLRAW templates can use variables more than onceZachery Notz 2020-04-29backwards compat with new optiondestruc7i0n 2020-04-29add the ability to handle webhook messagesdestruc7i0n 2020-04-19Fixed tellraw components not being encoded properlyBen Landin 2020-02-11Update README.mddestruc7i0n 2020-02-05Precedencedestruc7i0n 2020-02-05Allow specification of the channel name rather than iddestruc7i0n 2020-02-05Some more cleanupdestruc7i0n 2020-02-05More config handlingdestruc7i0n 2020-02-04Update typesdestruc7i0n 2020-02-04Docs updatesdestruc7i0n 2020-02-04Code cleanupdestruc7i0n 2020-02-04Refactor and rebuild to TypeScriptdestruc7i0n 2019-02-11Local file supportdestruc7i0n 2018-11-11Let's make this usable again!destruc7i0n 2018-02-23Allow configurable discord formatArcensoth 2018-02-23Revert example tellraw format to mimic the originalArcensoth 2018-02-23Update readme with new tellraw config optionArcensoth 2018-02-23Allow configurable tellraw formatArcensoth 2018-02-23Allow config file to be passed as a parameterArcensoth