README.md

   1 <p align="center">
   2   <a href="https://svrjs.org" target="_blank">
   3     <img src="assets/logo.png" width="384">
   4   </a>
   5 </p>
   6 <p align="center">
   7   <b>SVR.JS</b> - a web server running on Node.js<br/>
   8   It's free as in freedom, scalable, secure, and configurable.
   9 </p>
  10 <p align="center">
  11   <a href="https://svrjs.org/docs" target="_blank"><img alt="Static Badge" src="https://img.shields.io/badge/Documentation-green"></a>
  12   <a href="https://svrjs.org" target="_blank"><img alt="Website" src="https://img.shields.io/website?url=https%3A%2F%2Fsvrjs.org"></a>
  13   <a href="https://hub.docker.com/r/svrjs/svrjs" target="_blank"><img alt="Docker Pulls" src="https://img.shields.io/docker/pulls/svrjs/svrjs"></a>
  14   <a href="https://github.com/svr-js/svrjs" target="_blank"><img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/svr-js/svrjs"></a>
  15   <a href="https://x.com/SVR_JS" target="_blank"><img alt="X (formerly Twitter) Follow" src="https://img.shields.io/twitter/follow/SVR_JS"></a>
  16   <a href="https://mastodon.social/@svrjs" target="_blank"><img alt="Mastodon Follow" src="https://img.shields.io/mastodon/follow/111643338718098121"></a>
  17 </p>
  18
  19 * * *
  20
  21 ## Features
  22
  23 ### Static file handling
  24
  25 *   Static file serving (even above 2GB)
  26 *   Directory listing serving
  27 *   Protection against path traversal
  28 *   Content-Range support (for non-HTML static files; also for HTML files from SVR.JS 3.15.1)
  29 *   Serving from web root different than SVR.JS installation directory
  30
  31 ### Security
  32
  33 *   HTTPS support
  34 *   HTTP/2 support
  35 *   Built-in block list
  36 *   Protection against HTTP authentication brute force attacks (from SVR.JS 3.4.8; enabled by default)
  37 *   Ability to hide server version
  38 *   OCSP stapling support (from SVR.JS 3.4.9)
  39
  40 ### Configuration and customization
  41
  42 *   Configurability via _config.json_ file
  43 *   Expandability via server-side JavaScript and mods
  44 *   Ability to serve non-standard error pages
  45 *   URL rewriting engine
  46 *   Event driven architecture powered by Node.js, along with clustering.
  47
  48 ### Compression and content delivery
  49
  50 *   Brotli, gzip and Deflate HTTP compression (Brotli supported since SVR.JS 3.4.11)
  51 *   SNI (Server Name Indication) support
  52 *   ETag support (from SVR.JS 3.6.1)
  53 *   Reverse proxy functionality (requires reverse-proxy-mod SVR.JS mod)
  54 *   Forward proxy functionality (requires forward-proxy-mod SVR.JS mod)
  55
  56 ### Authentication and access control
  57
  58 *   HTTP basic authentication
  59
  60 ### Gateway interfaces
  61
  62 *   CGI (Common Gateway Interface) support (requires RedBrick mod)
  63 *   SCGI (Simple Common Gateway Interface) support (requires OrangeCircle mod)
  64 *   JSGI (JavaScript Gateway Interface) support (requires YellowSquare mod)
  65 *   PHP support (PHP-CGI with RedBrick mod or PHP-FPM with GreenRhombus mod)
  66
  67 ### Additional functionality
  68
  69 *   Logging
  70 *   Ability to display IP addresses, from which originally request was made (from reverse proxies; via X-Forwarded-For)
  71
  72 ## Building SVR.JS
  73
  74 To build SVR.JS, you need Node.js 18.0.0 or newer.
  75
  76 Before building SVR.JS, install the npm packages using this command:
  77 ```bash
  78 npm install
  79 ```
  80 After installing the packages, build SVR.JS with this command:
  81 ```bash
  82 npm run build
  83 ```
  84 After running the command, you will get bundled SVR.JS script, around with built-in utilities and assets in the `dist` directory. You will also get a zip archive in `out` directory, that can be installed using SVR.JS installer. Additionally, you will get the SVR.JS Core package contents in the `core` directory, which you can publish by running `npm publish` in the `core` directory.
  85
  86 ## Installation (built from source)
  87
  88 To install SVR.JS you just built from the source code, you can install it via SVR.JS installer for GNU/Linux or manually.
  89
  90 If you want to install SVR.JS manually, you can read the [server documentation](https://svrjs.org/docs).
  91
  92 If you want to install via SVR.JS installer for GNU/Linux, run this command:
  93 ```bash
  94 curl -fsSL https://downloads.svrjs.org/installer/svr.js.installer.linux.20240509.sh > /tmp/installer.sh && sudo bash /tmp/installer.sh
  95 ```
  96
  97 You will be then prompted about the type of installation. Choose option “2” to install SVR.JS from the zip archive, and type in the path to the zip archive (hint: it is in the `out` directory).
  98
  99 After typing the path, you may be prompted to install dependencies via GNU/Linux distribution’s package manager. Proceed with the installation of dependencies.
 100
 101 After installation, SVR.JS should be listening at http://localhost.
 102
 103 ## SVR.JS documentation
 104
 105 You can read the [SVR.JS documentation](https://svrjs.org/docs) to get information on how to use SVR.JS.
 106
 107 ## npm scripts
 108
 109 - To build SVR.JS along with the default page and the zip archive, run `npm run build`.
 110 - To build the default page, run `npm run build:page`.
 111 - To test SVR.JS itself, run `npm run dev`. This removes existing configuration.
 112 - To run the development server for the default page (built with Astro), run `npm run dev:page`.
 113 - To check SVR.JS code and default page for errors with ESLint, run `npm run lint`.
 114 - To fix and beautify SVR.JS code and default page with ESLint and Prettier, run `npm run lint:fix`.
 115 - To run SVR.JS from the "dist" folder, run `npm start`.
 116 - To perform unit tests with Jest, run `npm test`.
 117
 118 ## Contribute
 119
 120 See [SVR.JS contribution page](https://svrjs.org/contribute) for details.
 121
 122 ## License
 123
 124 This project is licensed under the MIT/X11 License - see the [LICENSE](LICENSE) file for details.