Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
node.js mbtiles tile server

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
bin
client
examples
mvc
server
templates
test
.gitignore
LICENSE.md
README.md
index.js

README.md

TileStream

A high performance tile server and simple web viewer for MBTiles files.

Features

  • MBTiles-based tile server
  • Minimal gallery view and OpenLayers based viewer of tiles
  • Support for MBTiles interaction using Wax

Requirements

  • TileStream client
    • Tested: Chrome 6+, Firefox 3+, IE8+
    • May work: Opera 11
  • TileStream server
    • Tested: Mac OS X 10.6, Ubuntu 10.10
    • At least 613MB memory
    • May work: Older versions, other POSIX-compliant systems
    • The prerequisites for node (python, libssl-dev)

Installation: Mac OS X 10.6

Install Xcode for Mac OS X.

Download and unpack TileStream. Build & install:

git clone -b master-ndistro git://github.com/mapbox/tilestream.git
cd tilestream
./ndistro

Start TileStream:

bin/node bin/tilestream

TileStream should now be accessible from a browser at http://localhost:8888.

Installation: Ubuntu 10.10

Install build requirements:

sudo apt-get install build-essential libssl-dev libsqlite3-0 libsqlite3-dev

Download and unpack TileStream. Build & install:

git clone -b master-ndistro git://github.com/mapbox/tilestream.git
cd tilestream
./ndistro

Start TileStream:

bin/node bin/tilestream

TileStream should now be accessible from a browser at http://localhost:8888.

Syslog setup

If you want tilestream to sent messages to syslog instead of stdout, use the --syslog option or specify "syslog": true in the settings JSON file.

Tilestream uses the standard syslog format, and expects a syslog daemon (rsyslogd is known to work) to run on localhost:514, that has to accept TCP connections. To filter tilestream's messages to a particular log file, add

if $programname == 'tilestream' then /var/log/tilestream.log
& ~

to your /etc/rsyslog.conf file and restart the daemon.

Usage

MBTiles files should be placed in the tiles directory. Each tileset can be previewed at http://localhost:8888/tileset/[filename] where [filename] is the name of the tileset file without the .mbtiles extension.

Commandline options:

Usage: tilestream [COMMAND] [OPTION]
Commands:
  start
    start server
    --config=PATH      Pass options via JSON config file at PATH.
    --uiPort=PORT      UI server port. Defaults to 8888.
    --tilePort=PORT    Tile server port. Defaults to 8888.
    --subdomains=LIST  Comma separated list of subdomains to use for tiles.
    --tiles=PATH       Path to tiles directory.
    --syslog           Log to syslog instead of stdout.

Tests

You can run the TileStream tests using expresso:

PATH=bin expresso modules/tilestream/test/tilestream.test.js

Contributors

Something went wrong with that request. Please try again.