Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

9 changes: 9 additions & 0 deletions LICENSE.txt
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,12 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

Third-party components
----------------------

ext/hyper_ruby/src/syslog/framing.rs is a port of Vector 0.48.0's
lib/codecs/src/decoding/framing/octet_counting.rs
(https://github.com/vectordotdev/vector) and is licensed under the Mozilla
Public License 2.0 (https://www.mozilla.org/en-US/MPL/2.0/), not the MIT
licence above.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,23 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run

To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## Syslog listeners

Alongside HTTP, the server can accept syslog over a stream socket (Unix socket
or TCP, optionally behind a PROXY v2 header) and over UDP. Each complete message
is yielded to the same `Server#run_worker` block as requests, as a
`HyperRuby::SyslogMessage` the block answers with an admission verdict. See the
configuration keys documented at the top of `lib/hyper_ruby.rb`.

## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

`ext/hyper_ruby/src/syslog/framing.rs` is an exception: it is a port of
Vector 0.48.0's `lib/codecs/src/decoding/framing/octet_counting.rs` and is
licensed under the [Mozilla Public License 2.0](https://www.mozilla.org/en-US/MPL/2.0/),
which is why the gem's metadata lists both licences.

## Code of Conduct

Everyone interacting in the HyperRuby project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/hyper_ruby/blob/master/CODE_OF_CONDUCT.md).
4 changes: 3 additions & 1 deletion ext/hyper_ruby/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name = "hyper_ruby"
version = "0.1.0"
edition = "2021"
authors = ["alistairjevans <alistair@betterstack.com>"]
license = "MIT"
license = "MIT AND MPL-2.0"
publish = false

[lib]
Expand All @@ -26,3 +26,5 @@ async-stream = "0.3.5"
env_logger = "0.11"
log = "0.4"
form_urlencoded = "1.2.1"
tokio-util = { version = "0.7", features = ["codec", "rt"] }
socket2 = "0.5"
Loading
Loading