minor typo
[gwvp-mini.git] / README.md
1 GWVP
2 ====
3
4 ALPHA
5
6 GWVP stands for "git over web via php". It was written entirely for myself and
7 its intention was to have a simple way of managing some git repos that can be
8 pulled and pushed to without the overhead of dealing with ssh keys. It also 
9 allows the owner to give permissions to a repo such that you can control who
10 reads and writes to it. All access to a repo is via http/https using usernames
11 and passwords.
12
13 Currently the code-base is a bit messy but that will improve over time.
14
15 Installation
16 ============
17
18 Ubuntu
19 You'll need to add following packages:
20
21 ```
22 sudo apt-get install php5-sqlite git apache2 php5-cli
23 ```
24
25 Assuming you clone the repository into /opt/gwvp you will then need to make
26 some changes to the rewrite, apache and gwvp configuration (assuming /gwvp
27 for the url also)
28
29 #### Apache config
30
31 This goes in /etc/apache2/conf.d/gwvp.conf
32 ```
33 Alias /gwvp /opt/gwvp/www
34
35 <Directory /opt/gwvp/www>
36         DirectoryIndex index.php
37         AllowOverride All
38 </Directory>
39 ```
40
41 #### Rewrite
42
43 Edit the file /opt/gwvp/www/.htaccess and change the top line to match your
44 base url
45
46 ```
47 RewriteBase /gwvp
48 ...
49 ```
50
51
52 #### GWVP Config
53
54 in /opt/gwvp/www/config.php data directory is (by default) /opt/gwvp/data
55 This directory must be read/write by the apache user. The following will
56 give the apache user write access to the file system:
57
58 ```
59 mkdir -p /opt/gwvp/data
60 sudo chown www-data:www-data /opt/gwvp/data
61 ```
62
63 Done - now you should browse to http://yourmachine/gwvp and login as admin
64 or user with a password of "password". Hopefully the rest is fairly straight
65 forward and self-explanitory, but there will be a help system coming soon(tm)