several documentation improvements

*   prefix docker/nvr commands with sudo (fixes #142).
    I was just going to link to the docker documentation on setting
    up non-root access, but that's kind of a personal preference.
    I included a `<details>` about it instead and made all the commands
    work with sudo.

*   take better advantage of github markdown's code block syntax
    highlighting. Use "console" for shell session stuff, put the
    "nvr" wrapper script in its own block with "bash".

*   add some comments to nvr wrapper script where people need to
    make changes and/or will be confused.

*   add a `<details>` that talks about shutting down and restarting
    the session around `nvr config` (see #151). Still not user-friendly
    but at least it's better documented now.
This commit is contained in:
Scott Lamb
2021-08-23 12:40:14 -07:00
parent a16bda8fb1
commit 30cea5cfcb
5 changed files with 111 additions and 70 deletions

View File

@@ -190,10 +190,10 @@ effectively allowing them to lie about the client's IP and protocol.
To make this take effect, you'll need to stop the running Docker container,
delete it, and create/run a new one:
```
$ nvr stop
$ nvr rm
$ nvr run
```console
$ sudo nvr stop
$ sudo nvr rm
$ sudo nvr run
```
## 7. Configure the webserver