source: subversion/applications/utils/tirex/README @ 21343

Last change on this file since 21343 was 21247, checked in by jochen, 9 years ago

documentation update, some has been moved to the wiki

File size: 2.0 KB
Line 
1
2Tirex Tile Rendering System
3===========================
4
5Tirex is a bunch of tools that let you run a tile server. A tile server
6is a web server that hands out pre-rendered map raster images to clients.
7
8The web page for Tirex is at http://wiki.openstreetmap.org/wiki/Tirex .
9See there for more information.
10
11Further documentation is in the doc/ subdirectory.
12
13PREREQUISITES
14-------------
15
16You'll need the following Perl modules to run Tirex:
17
18* IPC::ShareLite (Debian/Ubuntu: libipc-sharelite-perl)
19* JSON           (Debian/Ubuntu: libjson-perl)
20* GD             (Debian/Ubuntu: libgd-gd2-perl)
21* LWP            (Debian/Ubuntu: libwww-perl)
22
23You'll need a C++ compiler and build tools to compile the Mapnik backend.
24
25BUILDING
26--------
27
28To build Tirex run
29
30  make
31
32in the main directory. This will compile the mapnik backend and create
33the man pages for the Perl modules.
34
35Call 'make clean' to cleanup after a 'make'.
36
37INSTALLING
38----------
39
40To install Tirex call
41
42  make install
43
44as root user. This will install the main parts of Tirex including the
45tirex-master, tirex-backend-manager and the Mapnik backend.
46
47This will not install the example map, or the munin or nagios plugins.
48To install those, call
49
50  make install-example-map
51  make install-munin
52  make install-nagios
53
54respectively. You can also install everything with
55
56  make install-all
57
58DEBIAN/UBUNTU
59-------------
60
61To create Debian/Ubuntu packages you need the package 'devscripts'
62installed. Call
63
64  make deb
65
66to create the packages. The following packages will be created in the parent
67directory:
68
69  tirex-core
70  tirex-backend-mapnik
71  tirex-backend-wms
72  tirex-example-map
73  tirex-munin-plugin
74  tirex-nagios-plugin
75  tirex-syncd
76
77Call 'make deb-clean' to cleanup after a 'make deb'.
78
79TESTS
80-----
81
82Call 'prove' in the main directory to run Perl unit tests. You need Test::More
83(Debian/Ubuntu: libtest-simple-perl) and Test::Harness (Debian/Ubuntu:
84libtest-harness-perl) installed.
85
86There are some other tests in the 'test' directory. See the description at the
87beginning of the scripts for information on how to use them.
88
Note: See TracBrowser for help on using the repository browser.