Giter Club home page Giter Club logo

bunginx's Introduction

Bunginx

A fast, lightweight and simple HTTP file server based on Bun and nginx for Linux and Windows:

Bunginx: Fast, lightweight, simple HTTP file server
 bunginx [-pdhc] [--port <port>] [--cluster <count>] [--debug] [cwd]
 --port <port: number>      Set the port for Bunginx [-p]
                            - defaults to $PORT or 8000.
 --cluster <count: number>  Set the threads that Bunginx will spawn [-c]
                            - defaults to the CPU core count.
 --debug                    Display debug messages during run [-d]
 --help                     Display this message [-h]
 [cwd: string]              Directory that Bunginx will run on,
                            - defaults to current directory.

Installation

This installation guide is for linux users, for windows please compile it yourself

  • Download the binary here (Or "bunginx" in the repo)
  • Put it in PATH somewhere idk

Compiling

Prerequisites

Bun installed and is on PATH

Compilation

  • Clone the repository
  • For linux, run bun compile
  • For windows, run bun windows(Result in 90mb binary, and very limited support)
  • Result will be in ./bunginx
  • (Optional)(Linux-only) Apply the application to /usr/bin via bun apply

Contribution

Pull requests are welcomed.

FAQ

Why is bunginx so big?

Bun's Single-file executable integrates and compiles the code into a copy of bun runtime itself, resulting in a pretty large file. However, They will soon make the binary itself smaller.

How to blacklist a file from Bunginx?

Simply just remove read permission of that file from the user that Bunginx runs from, or just remove the read permission entirely. (Sorry windows.)

bunginx's People

Contributors

superdinmc avatar ceqell avatar

Watchers

 avatar

Forkers

ceqell

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.