Giter Club home page Giter Club logo

map-tiles-proxy's Introduction

map-tiles-proxy

Nodejs map tiles caching proxy, to use as middleware or standalone, locally or on a remote server.

You can pass the configuration either when you require the module: var cache=require('map-tiles-proxy')(config); or put in in file cache.config.json.

If both exists, definitions from the file will override defaults passed at require time.

Configuration example:

   {                                                                                                 
    middleware: false,
    cacheDir: 'cache',
    urlFromQueryString: true,
    routes: {
      osm: {
        dir: 'osm', // when this is ommited the route name is used as cache subdirectory name
        url: [
          'a.tile.openstreetmap.org/',
          'b.tile.openstreetmap.org/',
          'c.tile.openstreetmap.org/'
        ]
      }
    }
  }  

You can run it as a middleware (eg: for nodejs http or expressjs)

Or you can run it standalone with npm start for development.

In production you may want to run it with IBM's StrongLoop Process Manager (http://strong-pm.io/getting-started/) or another nodejs cluster manager, since probably you want to load or to serve a lot of tiles simultaneously

The example configuration above allow the following url formats:

A: http://localhost:port/?url=http://a.tile.openstreetmap.org/0/0/0.png&dir=osm

Will pipe the tile to the client and save it to (or read it from) cache/osm/0/0/0.png. If dir=osm is ommitted, the destination path will be cache/a.tile.openstreetmap.org/0/0/0.png.

This can be disabled with config.urlFromQueryString=false;

B: http://localhost:port/osm/0/0/0.png

Will pipe the http://a.tile.openstreetmap.org/0/0/0.png tile to the client and save it to (or read it from) cache/osm/0/0/0.png

C: http://a.tile.openstreetmap.org/0/0/0.png

Will pipe the http://a.tile.openstreetmap.org/0/0/0.png tile to the client and save it to (or read it from) cache/osm/0/0/0.png

map-tiles-proxy's People

Contributors

bugdanov avatar ivesdebruycker avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.