Skip to content

Latest commit

 

History

History
131 lines (91 loc) · 3.11 KB

README.md

File metadata and controls

131 lines (91 loc) · 3.11 KB
Raw

TileStream

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

Features

  • MBTiles-based tile server
  • Minimal gallery view and map viewer for 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
    • Tested: node 0.4.7
    • Tested: npm v1.0.3
    • At least 613MB memory
    • May work: Older versions, other POSIX-compliant systems

Installation: Mac OS X 10.6

Install Xcode for Mac OS X.

Install node and npm. You may want to use nvm which can install and manage your node installation for you.

Download and unpack TileStream. Build & install:

git clone git://github.com/mapbox/tilestream.git
cd tilestream
npm install .

Start TileStream:

./index.js

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

Installation: Ubuntu 10.10

Install build requirements:

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

Install node and npm. You may want to use nvm which can install and manage your node installation for you.

Download and unpack TileStream. Build & install:

git clone git://github.com/mapbox/tilestream.git
cd tilestream
npm install .

If you already cloned the master repository then do:

cd tilestream
git checkout master-ndistro
./ndistro

Start TileStream:

./index.js

TileStream should now be accessible from a browser at http://localhost:8888. If you intend to run TileStream as a server on a hostname or an IP rather than as localhost, specify that hostname when you run TileStream:

./index.js --host 127.0.0.1
./index.js --host yourhost.com

Usage

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

Tileset filenames:

  • May contain letters (lower or upper case), numbers, underscores or dashes.

      world-light.mbtiles
  control_room.mbtiles
  PartyLikeIts1999.mbtiles

  • May not contain periods, spaces, non ASCII characters or other punctuation.

      World Light.mbtiles
  BlueWorld-1.0.mbtiles

To see the options available for use with TileStream, run

./index.js start --help

Tests

TileStream tests use Expresso.

npm install -g expresso
cd tilestream
npm test

Contributors