pidgin/nest

Add notes about making the dev server accessible from other nodes on the network and fix a typo I caught in the process.

2021-05-24, John Bailey
135bafd43d0b
Parents 36584b992997
Children 38693e55c57c
Add notes about making the dev server accessible from other nodes on the network and fix a typo I caught in the process.

Testing Done:
Verified that added documentation works as expected.

Reviewed at https://reviews.imfreedom.org/r/662/
1 files changed, 14 insertions(+), 1 deletions(-)
  • +14 -1
    readme.md
    • --- a/readme.md Mon May 24 18:46:15 2021 -0500
    +++ b/readme.md Mon May 24 18:50:25 2021 -0500
    @@ -19,6 +19,19 @@
    - `-v --verboseLog` Better logging and debugging experience
    - `--noHTTPCache` To prevent caching issues
    +If you want to have your development server accessible from other computers or
    +devices on your network, you'll want to add some additional arguments to the
    +hugo command line:
    +
    +`hugo server -s hugo -D --disableFastRender -v --verboseLog --noHTTPCache --i18n-warnings --bind=192.168.2.100 --baseURL=http://192.168.2.100:1313`
    +
    +The additional arguments assume that your workstation's local IP address is
    +`192.168.2.100`.
    +
    +- `--bind=192.168.2.100` instructs hugo to bind to the specified IP address.
    +- `--baseURL=http://192.168.2.100:1313` sets the base URL to allow connections
    + from other devices to work with proper URL's.
    +
    ## Docker
    1. `docker build -t pidgin/nest:latest .`
    @@ -26,7 +39,7 @@
    ## Formatting
    -These are some regex's to quickly format templating
    +These are some regexes to quickly format templating
    | regex | replace |
    | -------------------- | -------- |