grunt-fileserver

Fast customizable development server

Getting Started

This plugin requires Grunt ~0.4.4

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-fileserver --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-fileserver');

The "fileserver" task

Overview

In your project's Gruntfile, add a section named fileserver to the data object passed into grunt.initConfig().

grunt.initConfig({
  fileserver: {
    server1: {
      options: {
        port: 8080,
        hostname: '0.0.0.0',
        cwd: '.'
        root: 'test',
        dirAlias: {
          'dist': 'dist'
        },
        keepalive: false,
        onStart: function(){ console.log('server started'); },
        onStop: function(){ console.log('server stopped'); },
        openInBrowser: true,   // true (for default browser) or app name (eg: 'chrome', 'firefox')
        addExtension: 'html',   // add extension to url not ended in '/'
        headers: {
          'Access-Control-Allow-Origin': '*',
          'Access-Control-Allow-Methods': 'GET,PUT,POST,DELETE',
          'Access-Control-Allow-Headers': 'Content-Type'
        }
      }
    }
  }
});

Options

options.port

Type: Number Default value: 8080

TCP connection port

options.hostname

Type: String Default value: 0.0.0.0

Hostname which will listen the requests

options.cwd

Type: String Default value: .

Current Working directory. All referencies will be relative to this.

options.root

Type: String Default value: ``

Folder to use as server root directory

options.dirAlias

Type: Object Default value: {}

List of directories alias. This allows using directories outside root directory to be served as them was in.

options.keepalive

Type: Boolean Default value: false

Enable or Disable keep server running. You may choose keep server running by other way. For example running watch after fileserver.

Release History

• 2014-05-13 v0.1.16 Now supports dir alias.
• 2014-11-17 v0.1.25 Added openInBrowser and addExtension
• 2014-11-18 v0.1.26 Updating README
• 2014-11-18 v0.1.27 addExtension fix