5.2.0 • Published 23h ago

@bedrock/server

Licence

Apache-2.0

Version

5.2.0

Deps

Size

38 kB

Vulns

Weekly

Stars

Summary Dependency Versions

bedrock-server

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

This software requires and supports maintained recent versions of Node.js. Updates may remove support for older unmaintained platform versions. Please use dependency version lock files and testing to ensure compatibility with this software.

Quick Examples

npm install @bedrock/server

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

import * as bedrock from '@bedrock/core';
import * as server from '@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:

import * as server from '@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

[optional] Tweak configuration
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:

Go to: https://bedrock.localhost:18443/
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.