source: osmose-backend/README

Last change on this file was 4ca12a4, checked in by Jocelyn Jaubert <jocelyn.jaubert@…>, 5 years ago

Add support for directly POSTing results instead of using a http server

Note that this needs a new python module, called poster.

  • Property mode set to 100644
File size: 2.3 KB
Line 
1Backend part of Osmose tool
2===========================
3
4This is the part of osmose [http://osmose.openstreetmap.fr] which analyses OSM
5and send results to frontend. This works as following:
6
7  - an .osm.bz2 or .osm.pbf extract is downloaded from a path
8  - downloaded file is converted to .osm, with bunzip2 or osmconvert
9  - if necessary, an osmosis dump is generated in a local database
10  - analyses are run directly on .osm file, or on the database
11  - analyses are stored on a local webserver, and a link is sent to the
12    frontend so that it can download the results
13  - temporary extract files and database are purged
14
15
16Dependencies
17------------
18  python > 2.6 recommended
19  python-dateutil
20  python-imposm-parser     # for pbf support in analyser_sax
21  python-lockfile
22  python-polib
23  python-poster            # optional, for direct upload of results to frontend
24  python-psycopg2 > 2.4
25  python-shapely >= 1.2
26  postgresql-9.1           # for osmosis database dumps
27  postgresql-9.1-postgis
28  postgresql-contrib-9.1
29  openjdk-6-jre-headless   # for osmosis
30
31osmosis is installed in osmosis/osmosis-0.41/.
32osmconvert is installed in osmconvert/.
33
34
35To run tests, additional packages are needed.
36  python-nose
37  python-xmltodict
38
39
40Configuration
41-------------
42A few paths are hardcoded in modules/config.py, and should be adapted or created.
43
44  - dir_osmose is the path of where files are installed
45  - dir_work is where extracts are stored, and results generated.
46  - url_frontend_update is the url used to send results generated by analyses
47
48
49The local postgresql database should be configured in osmose_config.py:
50
51  - db_base = database name
52  - db_user = database user
53  - db_password = database password
54  - db_host = database hostname
55
56You may want to include this info in ~/.pgpass to avoid entering the database
57password while processing the files.
58
59See https://wiki.postgresql.org/wiki/Pgpass for more info.
60
61The following postgresql extensions should be enabled:
62  hstore
63  postgis
64  fuzzystrmatch
65  unaccent
66
67Connection to the "official" frontend at http://osmose.openstreetmap.fr
68-----------------------------------------------------------------------
69
70When you have configured the backend for the country you want to add, please
71send an email to osmose-contact@openstreetmap.fr. We will then send you the
72password to use to connect to the frontend.
Note: See TracBrowser for help on using the repository browser.