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

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

Fixed logging in backend-mapnik
Better docs

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