3.2.1 • Published 3 years ago

bedrock-server v3.2.1

Weekly downloads
357
License
-
Repository
github
Last release
3 years ago

bedrock-server

Bedrock Node.js CI

A bedrock module that provides a basic HTTP and HTTPS server. Other modules, such as bedrock-express, typically provide a routing framework and other features for writing Web applications, but depend on this module for core low-level functionality like listening for incoming connections, redirecting HTTP traffic to the HTTPS port, and configuring SSL/TLS.

Requirements

  • npm v3+

Quick Examples

npm install bedrock-server

An example of attaching a custom request handler to the server once Bedrock is ready.

var bedrock = require('bedrock');
var server = require('bedrock-server');

// once bedrock is ready, attach request handler
bedrock.events.on('bedrock.ready', function() {
  // attach to TLS server
  server.servers.https.on('request', function(req, res) {
    res.writeHead(200, {'Content-Type': 'text/plain'});
    res.end('Hello World\n');
  });
});

bedrock.start();

By default, bedrock-server will redirect any HTTP requests to HTTPS. To replace this default behavior, do the following:

var server = require('bedrock-server');

// once bedrock is ready, attach request handler
bedrock.events.on('bedrock.ready', function() {
  // attach to HTTP server
  server.servers.http.on('request', function(req, res) {
    res.writeHead(200, {'Content-Type': 'text/plain'});
    res.end('Hello World\n');
  });
});

bedrock.start();

Configuration

For documentation on server configuration, see config.js.

Setup

  1. optional Tweak configuration
  2. Map the bedrock.localhost hostname (or whatever you've configured) to your machine:
    1. Edit the /etc/hosts file as the administrator/root.
    2. Add an entry mapping the IP address to bedrock.localhost. For example: 127.0.0.1 localhost bedrock.localhost. (If accessing the server externally, you may need to use the IP address of your primary network device).

To access the server once bedrock is running:

  1. Go to: https://bedrock.localhost:18443/
  2. The certificate warning is normal for development mode. Accept it and continue.

Bedrock Events

List of emitted Bedrock Events:

  • bedrock-server.readinessCheck
    • Emitted before listening starts on any ports.
  • bedrock-server.http.listen
    • Arguments:
      • {address, port}: Object with address and port to listen on.
    • Emitted before listening on a HTTP port.
  • bedrock-server.http.listening
    • Arguments:
      • {address, port}: Object with address and port now listening on.
    • Emitted after listening on a HTTP port.
  • bedrock-server.https.listen
    • Arguments:
      • {address, port}: Object with address and port to listen on.
    • Emitted before listening on a HTTPS port.
  • bedrock-server.https.listening
    • Arguments:
      • {address, port}: Object with address and port now listening on.
    • Emitted after listening on a HTTPS port.
  • bedrock-server.ready
    • Emitted after listening is complete.

How It Works

TODO

3.2.1

3 years ago

3.2.0

3 years ago

3.1.0

4 years ago

3.0.0

4 years ago

2.9.0

4 years ago

2.8.0

4 years ago

2.7.0

5 years ago

2.6.0

5 years ago

2.5.0

5 years ago

2.4.1

6 years ago

2.4.0

6 years ago

2.3.4

6 years ago

2.3.3

6 years ago

2.3.2

7 years ago

2.3.1

8 years ago

2.3.0

8 years ago

2.2.1

8 years ago

2.2.0

9 years ago

2.1.3

9 years ago

2.1.2

9 years ago

2.1.1

9 years ago

2.1.0

10 years ago

1.1.0

10 years ago

2.0.0

10 years ago

1.0.2

10 years ago

1.0.1

10 years ago

1.0.0

10 years ago

0.1.1

11 years ago

0.1.0

11 years ago

0.0.1

11 years ago