doc/install.rst
branchdevel
changeset 252 d0de2ca7201a
child 277 f65edc0382cc
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/install.rst	Sun Mar 25 20:11:34 2012 +0200
@@ -0,0 +1,40 @@
+Installation of Iro
+===================
+
+Start with downloading the source http://BLAFOO. Install the module via ``setup.py install`` und ran ``iro-install``  afterwards, that will create a sample configuration file named ``iro.conf``. Now update the Configuration file and run ``iro-install install``  afterwards, that will create the Database and Offers for you. After that you have to ref:`adding_user`. After that you can start Iro ``twisted -ny extras/iro.tac``.
+
+.. _adding_user:
+
+Add User and Userrights
+-----------------------
+
+You'll need user and right to spefific Offers, that a user can send with a specific Offer. Till now, it is the only way to add/modify user/userrights. 
+
+ 
+You can add users and userright via SQL::
+
+  INSERT INTO user (name,apikey,ng_kunde) VALUES("test","a1b2c3");
+  INSERT INTO userrights (user,offer,default) VALUES ("test",OFFERNAME,NULL);
+
+or use python/ipython::
+
+  >>> import iro.model.schema
+  >>> from iro.model import schema
+  >>> from sqlalchemy import create_engine
+  >>> from iro.model.utils import WithSession
+  >>> engine = create_engine(DBURL)
+  >>> with WithSession(engine) as session:
+  ...   u = schema.User(name="test",apikey="a1a2c3")      
+  ...   session.add(u)
+  ...   o = session.query(Offer).filter_by(name=OFFERNAME).first()
+  ...   u.rights.append(Userright(o, default=None))
+  ...   session.commit()
+  >>>
+
+.. note::
+  Please make sure that, the apikey only using *hex digest [0-9a-f]*
+
+Sample Configuration
+====================
+
+.. literalinclude:: ../iro.conf.inst