Handle not ready repos
[gitorious:mainline.git] / README.md
1 # Gitorious.org
2
3 Gitorious is a web application for hosting, managing and contributing on Git
4 repositories.
5
6 # Contributing
7
8 Please see HACKING
9
10 # License
11
12 Please see the LICENSE file
13
14 # Performing tasks on the command line
15
16 Gitorious 3 ships with a set of high-level abstractions called use cases and
17 commands. These can be used to carry out many tasks e.g. from the command-line.
18 Using the use cases ensures that every step of a certain task is carried out,
19 and you don't end up with inconsistent data. See the app/use_cases directory
20 for further information.
21
22 # Installation
23
24 To install Gitorious locally visit [getgitorious.com](http://getgitorious.com).
25
26 # Messaging server
27
28 Many Gitorious operations are performed asynchronously to ensure good
29 performance. Examples of such tasks includes updating the database when pushing
30 to Gitorious, creating bare git repositories when creating repositories in the
31 web UI and more. To process these asynchronous actions, Gitorious uses a
32 messaging system where it sends messages to a queue, and a worker (i.e. another
33 process, usually some kind of daemon) fetches messages back for processing.
34
35 Gitorious provides several messaging implementations ("adapters"). The
36 alternatives along with how to install and run them are presented below. You
37 only need one of these alternatives.
38
39 ## Sync adapter
40
41 Processes messages synchronously, which means that no extra process is
42 required. This is a very simple solution, but will yield poor performance. It's
43 intended use is for development, but may also fit small setups where performance
44 is not an issue (e.g. if resources are scarce). To use it, simply set
45 messaging_adapter in gitorious.yml to "sync":
46
47   messaging_adapter: sync
48
49 ## Resque adapter
50
51 Resque uses Redis as a backend for messaging. It comes with a nice
52 administration interface that allows for resending of messages, introspection
53 and general statistics about your queue. To use it, set messaging_adapter to
54 "resque" in gitorious.yml:
55
56     messaging_adapter: resque
57
58 To use Resque, you need to install and run Redis. This is described in detail on
59 the official Resque page: https://github.com/resque/resque
60
61 To process messages from the queue with Resque, you need to run rake:
62
63     RAILS_ENV=production QUEUE=* bin/rake resque:work
64
65 You can also run a worker for a single, or a handful of queues too. This allows
66 you to assign different priority to different queues. The list of queues in use
67 can be found in lib/gitorious/messaging/resque_adapter.rb.
68
69 Note that Gitorious generally uses JMS style queue names, e.g.
70 /queue/GitoriousPostReceiveWebHook. Because the Resque web frontend does not
71 handle queue names with slashes in them, we strip queue names such that the
72 aforementioned queue will be named GitoriousPostReceiveWebHook under Resque.
73
74
75 # More Help
76
77 * Consult the mailinglist (http://groups.google.com/group/gitorious) or drop
78   by #gitorious on irc.freenode.net if you have questions.
79
80
81 # Gotchas
82
83 Gitorious will add a 'forced command' to your ~/.ssh/authorized_keys file for
84 the target host: if you start finding ssh oddities suspect this first. Don't
85 log out until you've ensured you can still log in remotely.