doc/install.rst
author Sandro Knauß <knauss@netzguerilla.net>
Wed, 25 Apr 2012 00:04:47 +0200
branchdevel
changeset 274 1653470ccaff
parent 252 d0de2ca7201a
child 277 f65edc0382cc
permissions -rw-r--r--
doc: adding sipgate documentation writing a new provider
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
252
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
     1
Installation of Iro
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
     2
===================
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
     3
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
     4
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``.
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
     5
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
     6
.. _adding_user:
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
     7
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
     8
Add User and Userrights
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
     9
-----------------------
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    10
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    11
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. 
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    12
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    13
 
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    14
You can add users and userright via SQL::
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    15
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    16
  INSERT INTO user (name,apikey,ng_kunde) VALUES("test","a1b2c3");
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    17
  INSERT INTO userrights (user,offer,default) VALUES ("test",OFFERNAME,NULL);
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    18
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    19
or use python/ipython::
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    20
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    21
  >>> import iro.model.schema
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    22
  >>> from iro.model import schema
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    23
  >>> from sqlalchemy import create_engine
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    24
  >>> from iro.model.utils import WithSession
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    25
  >>> engine = create_engine(DBURL)
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    26
  >>> with WithSession(engine) as session:
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    27
  ...   u = schema.User(name="test",apikey="a1a2c3")      
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    28
  ...   session.add(u)
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    29
  ...   o = session.query(Offer).filter_by(name=OFFERNAME).first()
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    30
  ...   u.rights.append(Userright(o, default=None))
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    31
  ...   session.commit()
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    32
  >>>
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    33
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    34
.. note::
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    35
  Please make sure that, the apikey only using *hex digest [0-9a-f]*
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    36
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    37
Sample Configuration
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    38
====================
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    39
d0de2ca7201a using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    40
.. literalinclude:: ../iro.conf.inst