## Description Tiny web server is disain for SPA (Single Page Application). This project is a tiny web server that serves static files, supports HTTPS, subdomains, middleware, and service workers. This module is part of the ['conextra'](https://www.npmjs.com/package/conextra) framework, which is a simple and easy-to-use single-page application (SPA) framework. You have to try it! A different solution than MVC (model–view–controller). When you run the server, it will serve the files in the `public` directory. You can add your own files to the `public` directory and access them through the server. The server also supports subdomains, so you can access different files based on the subdomain. For example, if you have a file called `index.html` in the `public` directory, you can access it through `https://localhost/index.html`. If you have a file called `index.html` in the `public/subdomain` directory, you can access it through `https://subdomain.localhost/index.html`. The server also supports middleware, so you can add your own middleware functions to the server. The server also supports service workers. For testing uses a self-signed certificate, so you may see a warning in your browser when you access the server. You can ignore the warning and proceed to the server. Yor can mount the express.js style middleware to the server. Example: ```javascript const WebCluster = require('tiny-https-server'); const express = require('express'); const admin = express(); admin.get('/', (req, res) => { res.send('Admin Homepage'); }); consr cluster = WebCluster({ //isDebug: true, parallelism: 'auto 2' }, function _initServer(server) { // Mount express.js style middleware to the server under /admin path, url: 'http://localhost/admin' or 'http://yourdomain.com/admin' server.addRequest({ path: '/admin/*' }, admin); // Mount express.js style middleware to the server under admin subdomain, url: 'http://admin.localhost' or 'http://admin.yourdomain.com' server.addRequest({ host: 'admin' }, admin); }); ``` ## Features - HTTPS support - HTTP to HTTPS redirection - static file serving - subdomain support - service worker support - blacklist support - middleware support - mounting support express.js style - clastering support automatic scaling up and down - compression support - cache control support - path validation support - traffic-advice support - security.txt support - acme-challenge support for letsencrypt - test self-signed certificate support - configurable in JSON format file `config-sets.json` - command line support, example: `tiny-https-server --help` or `tiny-https-server --parallelism='auto 1'` ## Installation You can install 'tiny-https-server' using this command: `npm install tiny-https-server` You can also install 'tiny-https-server' globally using this command: `npm install -g tiny-https-server` ## Testing You can test 'tiny-https-server' on your system using this command: `node ./node_modules/tiny-https-server/index.test` or in the 'tiny-https-server' project directory: `npm test` ## How to use You can use 'tiny-https-server' in your project like this: ```javascript const WebCluster = require('tiny-https-server'); consr cluster = WebCluster({ isDebug: true, // Enable debug mode to see logs in the console parallelism: 'auto 2' // Start 2 workers and scale up and down automatically }, function _initServer(server) { // Add a request handler for the /hello path server.on('request', (req, res, next) => { if (req.url.startsWith('/hello')) { res.writeHead(200, { 'Content-Type': 'text/plain' }); res.end('Hello World'); return; } next(); }); }); ```
You can create a separate initServer.js file and use it like this: ```javascript const WebCluster = require('tiny-https-server'); const initServer = require('./initServer.js'); const cluster = WebCluster({ isDebug: true, // Enable debug mode to see logs in the console parallelism: 'auto 2' // Start 2 workers and scale up and down automatically }, initServer); ```
in `initServer.js` file: ```javascript module.exports = function _initServer(server) { // Add your own code here // This function is called when the server is initialized // For example, you can add request handlers, middleware, etc. const express = require('express'); const admin = express(); admin.get('/', (req, res) => { res.send('Admin Homepage'); }); // Mount express.js style middleware to the server under /admin path, url: 'http://localhost/admin' or 'http://yourdomain.com/admin' server.addRequest({ path: '/admin/*' }, admin); // Mount express.js style middleware to the server under admin subdomain, url: 'http://admin.localhost' or 'http://admin.yourdomain.com' server.addRequest({ host: 'admin' }, admin); }; ```
If you install 'tiny-https-server' globally, can use command line like this: ```bash tiny-https-server --port=8080 --host=localhost --docroot=./public --parallelism=auto 2 --isDebug=true ``` ## Let's Encrypt support 'tiny-https-server' supports Let's Encrypt for obtaining free SSL certificates.
This allows you to use HTTPS on your server without having to pay for a certificate.
How to add Let's Encrypt support using Certbot > webroot method: - See [Certbot](https://certbot.eff.org/) for more information on how to use Certbot to obtain a certificate. - See [Certbot webroot method](https://certbot.eff.org/docs/using.html#webroot) for more informatsion on how to use the webroot method. - Install Certbot on your system. - Run the following command to obtain a certificate:
``` certbot certonly --webroot -w /path/to/tiny-https-server/public -d www.yourdomain.com -d yourdomain.com ```
Replace `/path/to/tiny-https-server/public` with the path to your 'tiny-https-server' public directory and `yourdomain.com` with your domain name. - Certbot saving the certificate to `/etc/letsencrypt/live/` and renewing it on a regular schedule. - In the 'tiny-https-server' configuration file `config-sets.json`, set the `pathToCert` and `pathToPrivkey` options to the path of the certificate and key files: ```json { "production": { "tiny-https-server": { "pathToCert": "/etc/letsencrypt/live/yourdomain.com/fullchain.pem", "pathToPrivkey": "/etc/letsencrypt/live/yourdomain.com/privkey.pem" } } } ``` Replace `yourdomain.com` with your domain name. - Run the 'tiny-https-server'. ## License This project is licensed under the MIT License. Copyright © Manuel Lõhmus [](https://www.paypal.com/donate?hosted_button_id=H2ZHLF8U2HGVA) Donations are welcome and will go towards further development of this project.