Giter VIP home page Giter VIP logo

edgemesh's Introduction

logo

Edgemesh: Dynamic Web Acceleration Platform

npm version npm license XO code style

Build Status Test Coverage Code Climate Issue Count npm npm

๐Ÿš€ edgemesh 1.7.0 drastically improves cache hit rate and stability! Be sure to update your service worker. Your site will not be allowed to participate on the mesh if you are running version <1.7.0

Requirements

  • edgemesh requires that your site be secured with SSL.
  • you will need to create a free account on our portal in order to enable your site.

Documentation

All of our documentation can be found at https://edgemesh.com/docs.

CLI

The edgemesh CLI provides an easy way to install and update the edgemesh service worker. If you have node.js installed on your destination machine you are ready to go.

Install edgemesh globally

npm i -g edgemesh

Install edgemesh files to your static root

edgemesh install /path/to/public/root

This will install edgemesh.sw.min.js at the supplied path. It also stores a config file at /usr/local/etc/edgemesh/edgemesh.conf so you can run:

npm i -g edgemesh && edgemesh update

on subsequent updates. To check if you have the latest version run:

edgemesh check-updates

CLI Api

Usage: edgemesh <command> [options]


Commands:

    install|i <path>  install edgemesh server files at static path
    update|u          update edgemesh server files
    check-updates|v   check for newer version

Options:

    -h, --help     output usage information
    -V, --version  output the version number

Examples:

    $ edgemesh install ./server/static
    $ edgemesh update
    $ edgemesh check-updates

Browser Support

The edgemesh client will install on any browser. If the browser doesn't support edgemesh, it will resume normal operation. On edgemesh compatible browsers our service will self-bootstrap and start working automatically. No need to worry about compatibility! As browsers add support for the latest web features that edgemesh utilizes, your edgemesh installation will be automatically updated to add support.

Browser Market Share Supported Versions Blocked by
Chrome 58% >49 โœ… Implemented
Firefox 12% >58 โœ… Implemented
Edge 5% Not supported โŒ No webrtc support
Safari 3% Not supported โŒ No webrtc support

Troubleshooting

If you come across any bugs please don't hesitate to drop an issue or hop on gitter.

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.