Added README and INSTALL

1 files changed, 56 insertions, 0 deletions

diff --git a/INSTALL b/INSTALL
new file mode 100644
index 0000000..60d78b1
--- /dev/null
+++ b/INSTALL
@@ -0,0 +1,56 @@
+======================= Collagen INSTALL =========================
+
+
+Dependencies:
+ * common   - Python 2.5+
+ * Matchbox - Django 1.x (with psycopg2 support)
+            - Working PostgreSQL database
+ * Tinderbox - running as root
+
+
+
+
+  ==================== INSTALLING Matchbox ====================
+
+First we need to setup database connection. This is done by setting
+variables in src/matchbox/db/settings.py. Now initialization of db
+schema is in order. We use django tools to create it for us from model
+description. For initialization do this(in collagen root directory):
+
+cd src/
+django-admin.py syncdb --settings=matchbox.db.settings --pythonpath=.
+
+If the database schema exists and you need to fix it, drop the tables
+beforehand, because django-admin.py will skips tables that exist
+already.
+
+All we need to do now is start the server:
+
+python matchbox.py
+
+
+  ==================== INSTALLING Tinderbox ====================
+
+This is a little bit easier than Matchbox. We need to set path of
+mktinderboxchroot.sh script in src/tinderbox/config.py. This is done
+by setting variable MK_CHROOT_SCRIPT.
+
+Other variables that need to be setup are:
+MATCHBOX_HOST - ip or hostname of matchbox host
+MATCHBOX_PORT - port where matchbox is listening
+STAGE_TARBALL - tarball used to create basic chroot environment (which
+                you can modify afterwards)
+
+WORKDIR - work directory. Usually someplace where you have enough
+          space to store another installation (I'd recommend at least
+          6 GB, probably more)
+
+CHROOT_LOGS - this is directory inside WORK_CHROOT where logging and
+              similar files will be stored temporarily.
+
+LOG_LEVEL - you can leave this to log.DEBUG until collagen is
+            rock-solid :-)
+
+Now we need to run tinderbox:
+
+sudo python tinderbox.py
\ No newline at end of file