2023-10-14 11:10:56 +13:00
|
|
|
# Wayfarer
|
2023-10-13 18:46:21 +13:00
|
|
|
|
2024-03-06 19:28:10 +13:00
|
|
|
[![Build Status](https://drone.harton.dev/api/badges/james/wayfarer/status.svg?ref=refs/heads/main)](https://drone.harton.dev/james/wayfarer)
|
2023-10-14 11:16:31 +13:00
|
|
|
[![Hippocratic License HL3-FULL](https://img.shields.io/static/v1?label=Hippocratic%20License&message=HL3-FULL&labelColor=5e2751&color=bc8c3d)](https://firstdonoharm.dev/version/3/0/full.html)
|
|
|
|
|
|
|
|
Wayfarer is a runtime-configurable HTTP reverse proxy using
|
|
|
|
[Bandit](https://hex.pm/packages/bandit) and
|
|
|
|
[Mint](https://hex.pm/packages/mint).
|
|
|
|
|
|
|
|
## Status
|
|
|
|
|
|
|
|
Wayfarer is yet to handle it's first HTTP request. Please hold.
|
2023-10-13 18:46:21 +13:00
|
|
|
|
|
|
|
## Installation
|
|
|
|
|
2024-03-06 19:28:10 +13:00
|
|
|
Wayfarer is [available in Hex](https://hex.pm/packages/wayfarer), the package
|
|
|
|
can be installed by adding `wayfarer` to your list of dependencies in `mix.exs`:
|
2023-10-13 18:46:21 +13:00
|
|
|
|
|
|
|
```elixir
|
|
|
|
def deps do
|
|
|
|
[
|
2024-06-23 20:44:45 +12:00
|
|
|
{:wayfarer, "~> 0.4.1"}
|
2023-10-13 18:46:21 +13:00
|
|
|
]
|
|
|
|
end
|
|
|
|
```
|
|
|
|
|
2024-03-06 19:28:10 +13:00
|
|
|
Documentation for the latest release can be found on
|
|
|
|
[HexDocs](https://hexdocs.pm/wayfarer) and for the `main` branch on
|
|
|
|
[docs.harton.nz](https://docs.harton.nz/james/wayfarer).
|
2023-10-14 11:16:31 +13:00
|
|
|
|
2024-03-06 18:05:41 +13:00
|
|
|
## Github Mirror
|
|
|
|
|
2024-03-06 19:28:10 +13:00
|
|
|
This repository is mirrored [on Github](https://github.com/jimsynz/wayfarer)
|
2024-03-08 14:48:41 +13:00
|
|
|
from it's primary location [on my Forgejo instance](https://harton.dev/james/wayfarer).
|
2024-03-06 18:05:41 +13:00
|
|
|
Feel free to raise issues and open PRs on Github.
|
|
|
|
|
2023-10-14 11:16:31 +13:00
|
|
|
## License
|
|
|
|
|
|
|
|
This software is licensed under the terms of the
|
|
|
|
[HL3-FULL](https://firstdonoharm.dev), see the `LICENSE.md` file included with
|
|
|
|
this package for the terms.
|
|
|
|
|
|
|
|
This license actively proscribes this software being used by and for some
|
|
|
|
industries, countries and activities. If your usage of this software doesn't
|
|
|
|
comply with the terms of this license, then [contact me](mailto:james@harton.nz)
|
|
|
|
with the details of your use-case to organise the purchase of a license - the
|
|
|
|
cost of which may include a donation to a suitable charity or NGO.
|