You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+10-46Lines changed: 10 additions & 46 deletions
Original file line number
Diff line number
Diff line change
@@ -10,14 +10,15 @@ Hazel is Noelware's microservice to proxy our objects that we publish (like `art
10
10
11
11
## Installation
12
12
### Install Script
13
-
**WARNING** -- Please install the scripts first and audit them before running.
13
+
> [!IMPORTANT]
14
+
> Please install the scripts first and audit them before running.
14
15
15
16
```shell
16
17
# Unix:
17
-
$ curl -fsSL https://i.noelware.org/hazel | sh -
18
+
$ curl -fsSL https://noelware.org/x/hazel | sh -
18
19
19
20
# Windows:
20
-
$ irm https://i.noelware.org/hazel.ps1 | iex
21
+
$ irm https://noelware.org/x/hazel.ps1 | iex
21
22
```
22
23
23
24
### Docker
@@ -37,22 +38,21 @@ The image can consist with multiple tags for styles on how to deploy to your env
37
38
> ```shell
38
39
> $ docker volume create hazel
39
40
>```
40
-
41
-
> [!NOTE]
41
+
>
42
42
> You can substitute `hazel` with any volume name, but you will have to change `hazel` to the volume
43
43
> name in later examples if you went with creating a volume with `docker volume`.
44
44
>
45
45
> For regular filesystem-mounted directories, you will need to change the ownership of the directory so
46
-
> the server can read& write to it. You can use the `chown`command to do so:
46
+
> the server can readand write to it. You can use the `chown`command to do so:
47
47
>
48
48
>```shell
49
49
> $ chown -R 1001:1001 <directory>
50
50
>```
51
51
52
-
Now, we can pull the image from [Noelware's Container Registry](https://docker.noelware.org):
52
+
Now, we can pull the image from [Noelware's Container Registry](https://cr.noelware.cloud):
53
53
54
54
```shell
55
-
$ docker pull docker.noelware.org/noelware/hazel
55
+
$ docker pull cr.noelware.cloud/noelware/hazel
56
56
```
57
57
58
58
Now, we can run the container!
@@ -62,7 +62,7 @@ Now, we can run the container!
62
62
$ docker run -d-p 8989:8989 --name hazel \
63
63
-e HAZEL_SERVER_NAME=my-hazel-instance \
64
64
-v /var/lib/noelware/hazel/data:my-volume \
65
-
docker.noelware.org/noelware/hazel
65
+
cr.noelware.cloud/noelware/hazel
66
66
```
67
67
68
68
### Helm Chart
@@ -77,43 +77,7 @@ On a NixOS machine, you can use the [`nixpkgs-noelware`] overlay to install a Ha
77
77
}
78
78
```
79
79
80
-
It'll use a filesystem mapping in `/var/lib/noelware/hazel/data`, but can be overwritten with `services.hazel.fsPath`.
81
-
82
-
<!--
83
-
Now, we can pull the image from [Noelware's Container Registry](https://cr.noelware.cloud):
84
-
85
-
```shell
86
-
$ docker pull cr.noelware.cloud/hazel/hazel
87
-
```
88
-
89
-
Now, we can run the container!
90
-
91
-
```shell
92
-
# Using -v is an optional step if you're not using the local
93
-
# filesystem.
94
-
$ docker run -d-p 8989:8989 --name hazel \
95
-
-e HAZEL_SERVER_NAME=my-hazel-instance \
96
-
cr.noelware.cloud/hazel/hazel
97
-
```
98
-
99
-
### Helm
100
-
Hazel does provide a Helm distribution, but it is not available as of yet!
101
-
102
-
## Configuration
103
-
Hazel uses a standard YAML configuration file that can be used to configure the proxy, as **Hazel** is convention over configuration, it will proxy over the local filesystem under `/var/lib/noelware/hazel` on Linux or `$ROOT/.data` on other operating systems as there is no convention yet.
104
-
105
-
Hazel supports the local filesystem and Amazon S3 as Hazel is powered by the [remi-rs](https://github.com/Noelware/remi-rs) library.
106
-
107
-
<!--
108
-
### Secure Strings
109
-
To prevent leaking sensitive data in configuration files, you can embed environment variables to create a secure string, which will allow you to use the `${}` syntax to load up an environment variable and be used by that, like in Bash.
110
-
111
-
```yaml
112
-
sentry_dsn: ${HAZEL_SENTRY_DSN:-}
113
-
```
114
-
115
-
This will look-up the `HAZEL_SENTRY_DSN` environment variable, if it exists, the result will be the contents of the environment variable, otherwise it'll return "null" (or anything after `:-`).
Thanks for considering contributing to **hazel**! Before you boop your heart out on your keyboard ✧ ─=≡Σ((( つ•̀ω•́)つ, we recommend you to do the following:
0 commit comments