websocketd
MkDocs
Our great sponsors
websocketd | MkDocs | |
---|---|---|
14 | 114 | |
17,085 | 18,293 | |
- | 1.6% | |
0.0 | 9.0 | |
6 months ago | 3 days ago | |
Go | Python | |
BSD 2-clause "Simplified" License | BSD 2-clause "Simplified" License |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
websocketd
- Ask HN: Tips to get started on my own server
-
Pipexec – Handling pipe of commands like a single command
Somewhat related: https://github.com/joewalnes/websocketd
> websocketd is a small command-line tool that will wrap an existing command-line interface program, and allow it to be accessed via a WebSocket.
-
Structured Logging with Slog
I hadn't even considered collecting traces/spans in this way yet, and have taken the approach of "stuff outputting logs in JSON format to stderr/local file". I usually end up writing a (temporary, structured) log message with the relevant span tags, but wouldn't it would be much better to run the actual trace/span code and be able to verify it locally without the ad-hoc log message?
The prototype I built is a web application that creates websocket connections, and if those connections receive messages that are JSON, log lines are added. Columns are built dynamically as log messages arrive, and then you can pick which columns to render in the table. If you're curious here's the code, including a screenshot: https://github.com/corytheboyd-smartsheet/json-log-explorer
With websockets, it's very easy to use websocketd (http://websocketd.com), which will watch input files for new lines, and write them verbatim as websocket messages to listeners (the web app).
To make the idea real, would want to figure out how to not require the user to run websocketd out of band, but watching good ol' files is dead simple, and very easy to add to most code (add a new log sink, use existing log file, etc.)
-
Ask HN: WebSocket server transforming channel subscriptions to gRPC streams
* Additionally, client can stream data to the backend server (if bidirectional GRPC streams are used). I.e. client sends WebSocket messages, those will be transformed to GRPC messages by WebSocket server and delivered to the application backend.
As a result we have a system which allows to quickly create individual streams by using strict GRPC contract but terminating connections over WebSocket transport. So it works well in web browsers. After that no need to write WebSocket protocol, client implementation, handle WebSocket connection. This all will be solved by a suggested WebSocket server and its client SDKs.
The mechanics is similar to Websocketd (https://github.com/joewalnes/websocketd), but instead of creating OS processes we create GRPC streams. The difference from grpc-web (https://github.com/grpc/grpc-web) is that we provide streaming capabilities but not exposing GRPC contract to the client - just allowing to stream any data as payload (both binary and text) with some wrappers from our client SDKs side for managing subscriptions. I.e. it's not native GRPC streams on the client side - we expose just Connection/Subscription object to stream in both directions. GRPC streams used only for communication between WebSocket server and backend. To mention - grpc-web does not support all kinds of streaming now (https://github.com/grpc/grpc-web#streaming-support) while proposed solution can. This all should provide a cross-platform way to quickly write streaming apps due to client SDKs and language-agnostic nature of GRPC.
I personally see both pros and cons in this scheme (without concentrating on both too much here to keep the question short). I spent some time thinking about this myself, already have some working prototypes – but turned out need more opinions before moving forward with the idea and releasing this, kinda lost in doubts.
My main question - whether this seems interesting for someone here? Do you find this useful and see practical value?
-
WebSocket to TCP bridge for game servers? Alternative to websockify?
I also used to use this (http://websocketd.com/) along with netcat(1) before just biting the bullet and writing my own websocket library for our server as we needed to scale up slightly.
-
A library for exposing simple scripts? (Scripts As A Service)
Another option if you’re ready to implement the frontend part is https://github.com/joewalnes/websocketd which has the advantage of streaming the output of your script
- websocketd
-
Show HN: How did I live without Pipe Watch?
Wanted to add websocketd [1]. It's an amazing tool to stream debugging logs to another system where you can build your webapps that accumulate alerts.
Use it only for debugging builds and not for production (obviously).
[1] https://github.com/joewalnes/websocketd
- Websocketd – It's like CGI, twenty years later, for WebSockets
MkDocs
- I am stepping down from MkDocs
-
Alternatives to Docusaurus for product documentation
MkDocs is BSD-2-Clause licensed and has a vibrant community; GitHub Discussion is used for questions and high-level discussion, while the Gitter/Matrix chat room is used to discuss less complex topics. These communities provide essential resources and support.
- Ask HN: Tips to get started on my own server
-
Enhance Your Project Quality with These Top Python Libraries
MkDocs is a fast, simple and downright gorgeous static site generator that’s geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file.
-
Top 5 Open-Source Documentation Development Platforms of 2024
MkDocs is a popular static site generator designed explicitly for building project documentation. Its minimalist approach, flexibility, and ease of use have made it a favorite among developers and ideal for non-technical users.
-
5 Best Static Site Generators in Python
MkDocs is a popular static site generator specifically designed for project documentation. It is built on Python's Markdown processing engine and comes with a clean and responsive default theme. MkDocs is easy to configure, and its simplicity makes it an excellent choice for quickly creating documentation for your projects.
-
Creating a knowledge base website for work, do I need a database or can it be only front end designed?
Take a look at https://www.mkdocs.org
- MdBook – Create book from Markdown files. Like Gitbook but implemented in Rust
-
Examples with Github Pages?
I was thinking about using MkDocs, its usually used for documentation but I don't see why it couldn't be used for a normal wiki aswell. Since It's markdown you can just customize it like if it were a wiki, and a wiki doesn't really need backend stuff so I don't see a problem with it
What are some alternatives?
websocat - Command-line client for WebSockets, like netcat (or curl) for ws:// with advanced socat-like functions
sphinx - The Sphinx documentation generator
Crow - A Fast and Easy to use microframework for the web.
pdoc - API Documentation for Python Projects
quickserv - Dangerously user-friendly web server for quick prototyping and hackathons
DocFX - Static site generator for .NET API documentation.
ArduinoWebsockets - A library for writing modern websockets applications with Arduino (ESP8266 and ESP32)
Hugo - The world’s fastest framework for building websites.
IncludeOS - A minimal, resource efficient unikernel for cloud services
Docusaurus - Easy to maintain open source documentation websites.
sish - HTTP(S)/WS(S)/TCP Tunnels to localhost using only SSH.
BookStack - A platform to create documentation/wiki content built with PHP & Laravel