rename readme for github

[gwvp-mini.git] / README.md

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..25c8dc8
--- /dev/null
+++ b/README.md
@@ -0,0 +1,60 @@
+GWVP
+====
+
+ALPHA
+
+GWVP stands for "git over web via php". It was written for one purpose of
+being a quick and simple way of getting a git repo online using only usernames
+and passwords rather then having to deal with ssh keys.
+
+Installation
+============
+
+Ubuntu
+You'll need to add following packages:
+
+```
+sudo apt-get install php5-sqlite git apache2 php5-cli
+```
+
+Assuming you clone the repository into /opt/gwvp you will then need to make
+some changes to the rewrite, apache and gwvp configuration (assuming /gwvp
+for the url also)
+
+#### Apache config
+
+This goes in /etc/apache2/conf.d/gwvp.conf
+```
+Alias /gwvp /opt/gwvp/www
+
+<Directory /opt/gwvp/www>
+       DirectoryIndex index.php
+       AllowOverride All
+</Directory>
+```
+
+#### Rewrite
+
+Edit the file /opt/gwvp/www/.htaccess and change the top line to match your
+base url
+
+```
+RewriteBase /gwvp
+...
+```
+
+
+#### GWVP Config
+
+in /opt/gwvp/www/config.php data directory is (by default) /opt/gwvp/data
+This directory must be read/write by the apache user. The following will
+give the apache user write access to the file system:
+
+```
+mkdir -p /opt/gwvp/data
+sudo chown www-data:www-data /opt/gwvp/data
+```
+
+Done - now you should browse to http://yourmachine/gwvp and login as admin
+or user with a password of "password". Hopefully the rest is fairly straight
+forward and self-explanitory, but there will be a help system coming soon(tm)