How do I serve static files with httpuv in R?

Use the staticPaths option in the app list when calling startServer, specifying directories to serve from disk. This operates in the I/O thread, so it doesn't block R processes, as explained in the static paths example.

httpuv vs Shiny: which should I use for web apps in R?

httpuv is for low-level control and custom servers, ideal if you need direct protocol access or are building foundational packages. Shiny is a high-level framework for interactive UIs with less coding; choose based on whether you prioritize control or convenience.

Can httpuv handle JSON API requests?

Yes, but you must parse and serialize JSON manually in the call function. Unlike higher-level frameworks, httpuv doesn't provide automatic JSON handling, so you'll need to use R packages like jsonlite for processing.

How to set up a WebSocket echo server with httpuv?

Define an onWSOpen function in the app list that uses ws$onMessage to receive and send messages back, as shown in the README example. Test it with the websocket client package for full functionality.

Is httpuv suitable for production web servers?

Yes, it's robust and used by frameworks like Shiny in production, but you're responsible for implementing security, scaling, and monitoring features, as it's a low-level library without built-in production tools.

What are common debugging tips for httpuv servers?

Enable debugging options by setting PKG_CPPFLAGS with -DDEBUG_TRACE and -DDEBUG_THREAD during installation, as described in the debugging section. This prints detailed event logs and thread assertions to help trace issues.

Open-Awesome

httpuv

NOASSERTIONCv1.6.17

A low-level HTTP and WebSocket server library for R, built on libuv and http-parser.

Visit Website GitHub

252 stars89 forks0 contributors

What is httpuv?

httpuv is an HTTP and WebSocket server library for R that provides low-level socket and protocol support for handling web requests directly within the R environment. It solves the problem of building performant, real-time web servers and applications in R by leveraging a multithreaded architecture and robust C libraries.

Target Audience

R developers and package authors who need to create custom web servers, real-time applications, or foundational layers for higher-level web frameworks in R.

Value Proposition

Developers choose httpuv for its reliable, low-level performance, multithreaded design that prevents blocking, and its role as the backbone for many popular R web frameworks, offering direct control over HTTP and WebSocket protocols.

Overview

HTTP and WebSocket server package for R

Use Cases

Best For

Building custom HTTP servers with R callbacks
Creating real-time applications using WebSockets in R
Developing foundational packages for R web frameworks
Serving static files efficiently from R applications
Handling low-level socket communication in R projects
Prototyping web services directly within the R environment

Not Ideal For

Projects needing a full-stack web framework with built-in UI components, templating, and data binding out of the box
Environments where avoiding compiled dependencies and system-level setup is critical for deployment simplicity
Teams looking for extensive community plugins, middleware, or tutorials for rapid application development without custom coding

Pros & Cons

Pros

Multithreaded Performance

Separates I/O handling from R callbacks using libuv, enabling non-blocking operations like static file serving without impacting R performance, as highlighted in the static paths section.

Robust Low-Level Foundation

Built on proven C libraries (libuv and http-parser) by Joyent, ensuring reliable HTTP and WebSocket protocol support for stable server operations.

Flexible Protocol Control

Provides direct access to HTTP requests and WebSocket events via customizable callbacks, allowing developers to implement custom server logic and real-time applications, as shown in the basic usage examples.

Efficient Static Serving

Serves files from disk in the I/O thread without blocking R, demonstrated through the staticPaths feature that handles file requests independently.

Cons

Steep Learning Curve

Requires manual handling of low-level HTTP details; no built-in routing, templating, or middleware, making it challenging for developers accustomed to higher-level frameworks.

Compilation and Dependency Hassles

Installation can be complex on systems without C toolchains or libuv packages, and building from source if libuv isn't found may fail on some platforms, as noted in the installing section.

Limited High-Level Features

Lacks conveniences like authentication, session management, or database integration, forcing users to build custom solutions for common web tasks, which increases development time.

Frequently Asked Questions

Related Projects

shiny <img class="emoji" alt="heart" src="https://cdn.jsdelivr.net/gh/qinwf/awesome-R@3c66da6e291bcc0520b1649125b0bed750896a9a/heart.png" height="20" align="absmiddle" width="20">

Easy interactive web applications with R

Stars5,703

Forks1,890

Last commit7 days ago

rvest <img class="emoji" alt="heart" src="https://cdn.jsdelivr.net/gh/qinwf/awesome-R@3c66da6e291bcc0520b1649125b0bed750896a9a/heart.png" height="20" align="absmiddle" width="20">

Simple web scraping for R

Stars1,526

Forks349

Last commit14 days ago

plumber

Turn your R code into a web API.

Stars1,440

Forks258

Last commit8 months ago

httr <img class="emoji" alt="heart" src="https://cdn.jsdelivr.net/gh/qinwf/awesome-R@3c66da6e291bcc0520b1649125b0bed750896a9a/heart.png" height="20" align="absmiddle" width="20">

httr: a friendly http package for R

Stars983

Forks1,954

Last commit1 month ago

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub