]> git.codecow.com Git - nano-pow.git/commitdiff
Update server instructions.
authorChris Duncan <chris@codecow.com>
Fri, 22 May 2026 21:16:02 +0000 (14:16 -0700)
committerChris Duncan <chris@codecow.com>
Fri, 22 May 2026 21:16:02 +0000 (14:16 -0700)
README.md

index e27a51b13d4d5553c31dfcecff582b174c5ca5fd..e24f4a053af45f94045b116a230843e334e6d1e1 100644 (file)
--- a/README.md
+++ b/README.md
@@ -173,25 +173,46 @@ official Nano node software. The installed command will launch the server in a
 detached process, and it can also be started manually to customize behavior by
 executing the server script directly.
 
-#### Environment Variables
+#### Configuration
 
-`NANO_POW_DEBUG`: enable additional logging saved to the HOME directory
+NanoPow will look for a configuration file in the user home directory at the
+location `${HOME}/.nano-pow/config` and read the following variables:
 
-`NANO_POW_EFFORT`: increase or decrease demand on the GPU
+- `DEBUG`: enable additional logging saved to the HOME directory
+- `EFFORT`: increase or decrease demand on the GPU
+- `PORT`: override the default port 5040
 
-`NANO_POW_PORT`: override the default port 5040
+It will then fall back to environment variables for any values not found in the
+config file. The same variable names are used, prefixed with `NANO_POW_`:
+
+- `NANO_POW_DEBUG`: enable additional logging saved to the HOME directory
+- `NANO_POW_EFFORT`: increase or decrease demand on the GPU
+- `NANO_POW_PORT`: override the default port 5040
+
+Environment variables can also be specified inline at time of execution.
+
+```console
+$ # Launch the server and detach from the current session to run in the background
+$ NANO_POW_PORT=8080 nano-pow --server
+```
+
+```console
+$ # View process ID for "NanoPow Server"
+$ cat ~/.nano-pow/server.pid
+```
+
+```console
+$ # Display list of server logs
+$ ls ~/.nano-pow/logs/
+```
 
 ```console
-# Launch the server and detach from the current session
-NANO_POW_PORT=8080 nano-pow --server
-# View process ID for "NanoPow Server"
-cat ~/.nano-pow/server.pid
-# Display list of server logs
-ls ~/.nano-pow/logs/
-# Find process ID manually
-pgrep NanoPow
+$ # Find process ID manually
+$ pgrep NanoPow
 ```
 
+#### Usage
+
 Work is generated or validated by sending an HTTP `POST` request to the
 configured hostname or IP address of the machine. Some basic help is available
 via `GET` request.