| author | Sandro Knauß <knauss@netzguerilla.net> |
| Fri, 10 Aug 2012 13:58:28 +0200 | |
| branch | devel |
| changeset 290 | 21601a54c44c |
| parent 277 | f65edc0382cc |
| permissions | -rw-r--r-- |
|
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 |
|
|
277
f65edc0382cc
prepare for release:
Sandro Knauß <knauss@netzguerilla.net>
parents:
252
diff
changeset
|
4 |
Start with downloading the `source <../index.html#files>`_. |
|
f65edc0382cc
prepare for release:
Sandro Knauß <knauss@netzguerilla.net>
parents:
252
diff
changeset
|
5 |
Afterwards install the module via ``setup.py install`` und ran ``iro-install``. That will create a sample configuration file named ``iro.conf``. |
|
f65edc0382cc
prepare for release:
Sandro Knauß <knauss@netzguerilla.net>
parents:
252
diff
changeset
|
6 |
Update the configuration file and run ``iro-install install`` afterwards. That will create the Database and Offers for you. |
|
f65edc0382cc
prepare for release:
Sandro Knauß <knauss@netzguerilla.net>
parents:
252
diff
changeset
|
7 |
After that you have to :ref:`adding_user`. |
|
290
21601a54c44c
doc: update installing documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
277
diff
changeset
|
8 |
Now you are ready to start Iro ``twisted iro``. |
|
277
f65edc0382cc
prepare for release:
Sandro Knauß <knauss@netzguerilla.net>
parents:
252
diff
changeset
|
9 |
|
|
252
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 |
.. _adding_user: |
|
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 |
Add User and Userrights |
|
d0de2ca7201a
using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff
changeset
|
14 |
----------------------- |
|
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 |
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
|
17 |
|
|
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 |
You can add users and userright via SQL:: |
|
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 |
INSERT INTO user (name,apikey,ng_kunde) VALUES("test","a1b2c3"); |
|
d0de2ca7201a
using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff
changeset
|
22 |
INSERT INTO userrights (user,offer,default) VALUES ("test",OFFERNAME,NULL); |
|
d0de2ca7201a
using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff
changeset
|
23 |
|
|
d0de2ca7201a
using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff
changeset
|
24 |
or use python/ipython:: |
|
d0de2ca7201a
using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff
changeset
|
25 |
|
|
d0de2ca7201a
using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff
changeset
|
26 |
>>> import iro.model.schema |
|
290
21601a54c44c
doc: update installing documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
277
diff
changeset
|
27 |
>>> from iro.model.schema import * |
|
252
d0de2ca7201a
using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff
changeset
|
28 |
>>> from sqlalchemy import create_engine |
|
d0de2ca7201a
using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff
changeset
|
29 |
>>> from iro.model.utils import WithSession |
|
d0de2ca7201a
using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff
changeset
|
30 |
>>> engine = create_engine(DBURL) |
|
d0de2ca7201a
using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff
changeset
|
31 |
>>> with WithSession(engine) as session: |
|
290
21601a54c44c
doc: update installing documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
277
diff
changeset
|
32 |
... u = User(name="test",apikey="a1a2c3") |
|
252
d0de2ca7201a
using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff
changeset
|
33 |
... session.add(u) |
|
d0de2ca7201a
using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff
changeset
|
34 |
... o = session.query(Offer).filter_by(name=OFFERNAME).first() |
|
d0de2ca7201a
using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff
changeset
|
35 |
... u.rights.append(Userright(o, default=None)) |
|
d0de2ca7201a
using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff
changeset
|
36 |
... session.commit() |
|
d0de2ca7201a
using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff
changeset
|
37 |
>>> |
|
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 |
.. note:: |
|
d0de2ca7201a
using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff
changeset
|
40 |
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
|
41 |
|
|
d0de2ca7201a
using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff
changeset
|
42 |
Sample Configuration |
|
d0de2ca7201a
using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff
changeset
|
43 |
==================== |
|
d0de2ca7201a
using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff
changeset
|
44 |
|
|
d0de2ca7201a
using sphinx for documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff
changeset
|
45 |
.. literalinclude:: ../iro.conf.inst |