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 Note: the installation assumes the locations for things like "git" and
  19 git-http-backened, if yours arent in the normal ubuntu locale for that then
  20 you will need to edit a number of files to point it at the proper location
  21
  22 Ubuntu
  23 You'll need to add following packages:
  24
  25 ```
  26 sudo apt-get install php5-sqlite git apache2 php5-cli
  27 ```
  28
  29 Assuming you clone the repository into /opt/gwvp you will then need to make
  30 some changes to the rewrite, apache and gwvp configuration (assuming /gwvp
  31 for the url also)
  32
  33 #### Apache config
  34
  35 This goes in /etc/apache2/conf.d/gwvp.conf
  36 ```
  37 Alias /gwvp /opt/gwvp/www
  38
  39 <Directory /opt/gwvp/www>
  40         DirectoryIndex index.php
  41         AllowOverride All
  42 </Directory>
  43 ```
  44
  45 #### Rewrite
  46
  47 Edit the file /opt/gwvp/www/.htaccess and change the top line to match your
  48 base url
  49
  50 ```
  51 RewriteBase /gwvp
  52 ...
  53 ```
  54
  55
  56 #### GWVP Config
  57
  58 in /opt/gwvp/www/config.php data directory is (by default) /opt/gwvp/data
  59 This directory must be read/write by the apache user. The following will
  60 give the apache user write access to the file system:
  61
  62 ```
  63 mkdir -p /opt/gwvp/data
  64 sudo chown www-data:www-data /opt/gwvp/data
  65 ```
  66
  67 Done - now you should browse to http://yourmachine/gwvp and login as admin
  68 or user with a password of "password". Hopefully the rest is fairly straight
  69 forward and self-explanitory, but there will be a help system coming soon(tm)