Add example to README
This commit is contained in:
parent
2c91d30b1d
commit
263778400c
1 changed files with 28 additions and 0 deletions
28
README.md
28
README.md
|
@ -1,3 +1,31 @@
|
|||
# ngx
|
||||
|
||||
Opinionated nginx config generation for Deno.
|
||||
|
||||
## Example
|
||||
|
||||
Generate an nginx configuration to permanently redirect some routes from a.com to their new locations at b.com:
|
||||
|
||||
```typescript
|
||||
import ngx from "jsr:@char/ngx@0.1";
|
||||
|
||||
const redirects = {
|
||||
"/a": "https://b.com/new-a",
|
||||
"/b": "https://b.com/b-v2",
|
||||
};
|
||||
|
||||
const config = ngx("server", [
|
||||
[
|
||||
"server_name a.com",
|
||||
...ngx.listen(),
|
||||
...ngx.letsEncrypt("a.com"),
|
||||
],
|
||||
Object.entries(redirects).map(([path, uri]) =>
|
||||
ngx(`location = ${path}`, [
|
||||
`return 301 ${uri}`
|
||||
])
|
||||
)
|
||||
])
|
||||
|
||||
if (import.meta.main) console.log(config.build());
|
||||
```
|
||||
|
|
Loading…
Reference in a new issue