docs: clarify setup instructions #947
Conversation
Benchmark Results for generalComparing to 1f28877 |
Codecov Report✅ All modified and coverable lines are covered by tests. @@ Coverage Diff @@
## main #947 +/- ##
=======================================
Coverage 23.22% 23.22%
=======================================
Files 157 157
Lines 15494 15494
Branches 486 486
=======================================
Hits 3599 3599
Misses 11794 11794
Partials 101 101 🚀 New features to boost your workflow:
|
| ```bash | ||
| openssl req -new -nodes -newkey rsa:4096 -keyout root_ca.pem -x509 -out root_ca.crt -days 365 -subj / | ||
| openssl req -nodes -newkey rsa:4096 -keyout game_private_key.pem -out game.csr -subj / | ||
| openssl x509 -req -in game.csr -CA root_ca.crt -CAkey root_ca.pem -CAcreateserial -out game.crt -days 365 -sha256 -extfile <(printf "subjectAltName=DNS:localhost,IP:127.0.0.1") | ||
| rm game.csr | ||
| openssl req -nodes -newkey rsa:4096 -keyout proxy_private_key.pem -out proxy.csr -subj / | ||
| openssl x509 -req -in proxy.csr -CA root_ca.crt -CAkey root_ca.pem -CAcreateserial -out proxy.crt -days 365 -sha256 -extfile <(printf "subjectAltName=DNS:localhost,IP:127.0.0.1") | ||
| rm proxy.csr | ||
| ``` | ||
|
|
||
| Now run the game server. Note that the game server automatically starts the proxy. | ||
|
|
||
| ```bash | ||
| cargo run --release --bin bedwars -- --ip 127.0.0.1 --root-ca-cert root_ca.crt --cert game.crt --private-key game_private_key.pem | ||
| ``` |
There was a problem hiding this comment.
since these are for a dev environment, maybe it would be good to include some of these long commands in the justfile?
There was a problem hiding this comment.
I'd like to avoid relying on external programs like just that people usually don't have installed so that setting up Hyperion is simpler
There was a problem hiding this comment.
I'm not saying remove these instructions necessarily, merely providing the convenience of running a simple command.
My full opinion: installing just is not a hurdle, its a cargo install just and then wait. providing an easy way to have consistent dev environments is way more valuable than the time spent debugging differences in environments, multiplied by however many people start contributing.
No description provided.