mirrors/zap
1
0
Fork 0
mirror of https://github.com/zigzap/zap.git synced 2025-10-20 23:24:09 +00:00
Code Activity

update README: build openssl env var

Browse source
This commit is contained in:
Rene Schallner 2024-01-05 13:55:51 +01:00
parent 5eb57387e8
commit 869a7b8138
1 changed files with 8 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -34,7 +34,9 @@ Exactly the goals I set out to achieve!
on Windows are WSL2 or a docker container. on Windows are WSL2 or a docker container.
- Q: **Does ZAP support TLS / HTTPS?** - Q: **Does ZAP support TLS / HTTPS?**
- A: Yes, ZAP supports using the system's openssl. See the - A: Yes, ZAP supports using the system's openssl. See the
[https](./examples/https/https.zig) example. [https](./examples/https/https.zig) example and make sure to build with
the environment variable `ZAP_USE_OPENSSL=true`:
- `ZAP_USE_OPENSSL=true zig build https`
- Q: **Are there API docs?** - Q: **Are there API docs?**
- A: They are under development. Git clone this, then run `zig build run-docserver`. - A: They are under development. Git clone this, then run `zig build run-docserver`.
@ -115,8 +117,11 @@ port and docs dir: `zig build docserver && zig-out/bin/docserver --port=8989
call `r.sendError(err, status_code)` when you catch an error and a stack trace call `r.sendError(err, status_code)` when you catch an error and a stack trace
will be returned to the client / browser. will be returned to the client / browser.
- [**HTTPS**](examples/https/https.zig): Shows how easy it is to use facil.io's - [**HTTPS**](examples/https/https.zig): Shows how easy it is to use facil.io's
openssl support. Must be compiled with the `-Dopenssl=true` and requires openssl support. Must be compiled with the environment variable
openssl dev dependencies (headers, lib) to be installed on the system. `ZAP_USE_OPENSSL` set to `true` and requires openssl dev dependencies
(headers, lib) to be installed on the system.
- run it like this: `ZAP_USE_OPENSSL=true zig build run-https`
- it will tell you how to generate certificates
I'll continue wrapping more of facil.io's functionality and adding stuff to zap I'll continue wrapping more of facil.io's functionality and adding stuff to zap
to a point where I can use it as the JSON REST API backend for real research to a point where I can use it as the JSON REST API backend for real research