https://github.com/noelware/hazel
🪶 Minimal, and easy HTTP proxy to map storage provider items into HTTP endpoints, made in Rust.
https://github.com/noelware/hazel
axum cdn content-delivery rust
Last synced: 2 months ago
JSON representation
🪶 Minimal, and easy HTTP proxy to map storage provider items into HTTP endpoints, made in Rust.
- Host: GitHub
- URL: https://github.com/noelware/hazel
- Owner: Noelware
- License: apache-2.0
- Created: 2022-01-23T07:09:37.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-04-28T09:24:33.000Z (about 1 year ago)
- Last Synced: 2024-05-01T10:14:03.283Z (about 1 year ago)
- Topics: axum, cdn, content-delivery, rust
- Language: Rust
- Homepage:
- Size: 617 KB
- Stars: 17
- Watchers: 3
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
🪶 hazel
Easy to use read-only proxy to map objects to URLs
Hazel is Noelware's microservice to proxy our objects that we publish (like `artifacts.noelware.org` for all binary artifacts) to URLs that are mapped by their object storage location.
**Hazel** was originally maintained only by [Noel Towa](https://floofy.dev) but now is maintained and controlled by the Noelware team.
## Installation
### Install Script
**WARNING** -- Please install the scripts first and audit them before running.
```shell
# Unix:
$ curl -fsSL https://i.noelware.org/hazel | sh -
# Windows:
$ irm https://i.noelware.org/hazel.ps1 | iex
```
### Docker
Running Hazel as a Docker container is the most recommended way to run the Hazel server with minimal configuration for smaller deployments. You can pull the `docker.noelware.org/noelware/hazel` image to run the Hazel server.
The image can consist with multiple tags for styles on how to deploy to your environment. We typically build the Hazel images with `linux/amd64` and `linux/arm64` architectures. Windows containers is not planned at the moment.
- `latest` - Uses a specific channel to pull the image from. `latest` will be the latest stable version, `beta` will be the latest beta version.
- `alpine` - This tag will use [Alpine](https://hub.docker.com/_/alpine) as the base image due to its low size to make Hazel run on low systems without a lot of system resources.
> [!NOTE]
> Hazel only holds persistence over files that are served from the local filesystem. If you wish to use
> other providers, this is not a required step.
>
> You can create a volume with `docker volume create`:
> ```shell
> $ docker volume create hazel
> ```
> [!NOTE]
> You can substitute `hazel` with any volume name, but you will have to change `hazel` to the volume
> name in later examples if you went with creating a volume with `docker volume`.
>
> For regular filesystem-mounted directories, you will need to change the ownership of the directory so
> the server can read & write to it. You can use the `chown` command to do so:
>
> ```shell
> $ chown -R 1001:1001
> ```
Now, we can pull the image from [Noelware's Container Registry](https://docker.noelware.org):
```shell
$ docker pull docker.noelware.org/noelware/hazel
```
Now, we can run the container!
```shell
# Using -v is an optional step if you're not using the local filesystem.
$ docker run -d -p 8989:8989 --name hazel \
-e HAZEL_SERVER_NAME=my-hazel-instance \
-v /var/lib/noelware/hazel/data:my-volume \
docker.noelware.org/noelware/hazel
```
### Helm Chart
Refer to the [`Noelware/helm-charts`](https://github.com/Noelware/helm-charts/tree/master/charts/noelware/hazel) repository for more information.
### NixOS
On a NixOS machine, you can use the [`nixpkgs-noelware`] overlay to install a Hazel server on a NixOS server:
```nix
{
services.hazel.enable = true;
}
```
It'll use a filesystem mapping in `/var/lib/noelware/hazel/data`, but can be overwritten with `services.hazel.fsPath`.
## Contributing
Thanks for considering contributing to **hazel**! Before you boop your heart out on your keyboard ✧ ─=≡Σ((( つ•̀ω•́)つ, we recommend you to do the following:
- Read the [Code of Conduct](./.github/CODE_OF_CONDUCT.md)
- Read the [Contributing Guide](./.github/CONTRIBUTING.md)
If you read both if you're a new time contributor, now you can do the following:
- [Fork me! ＊*♡( ⁎ᵕᴗᵕ⁎ ）](https://github.com/Noelware/hazel/fork)
- Clone your fork on your machine: `git clone https://github.com/your-username/hazel`
- Create a new branch: `git checkout -b some-branch-name`
- BOOP THAT KEYBOARD!!!! ♡┉ˏ͛ (❛ 〰 ❛)ˊˎ┉♡
- Commit your changes onto your branch: `git commit -am "add features （｡>‿‿<｡ ）"`
- Push it to the fork you created: `git push -u origin some-branch-name`
- Submit a Pull Request and then cry! ｡･ﾟﾟ･(థ Д థ。)･ﾟﾟ･｡
## License
Hazel is released under the **Apache 2.0** License and with love :purple_heart: by [Noelware](https://noelware.org). :3