Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/Z-Bolt/OctoScreen.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJeffB42 <10328858+JeffB42@users.noreply.github.com>2020-12-10 08:33:37 +0300
committerGitHub <noreply@github.com>2020-12-10 08:33:37 +0300
commit3ae8e431c3f6a5f29036bd7f3f9955e7d1ddb444 (patch)
treef83ee6b1730318a72e9da6d4f7bae35cee683887
parent17191d149b676e69d48f85f25b36e973c88ba430 (diff)
Update README.md
-rwxr-xr-xREADME.md10
1 files changed, 5 insertions, 5 deletions
diff --git a/README.md b/README.md
index d7a03ae..48a2e88 100755
--- a/README.md
+++ b/README.md
@@ -96,9 +96,9 @@ The basic configuration is handled via environment variables, if you are using t
#### Required Configuration Settings
-- `OCTOPRINT_HOST` - OctoPrint HTTP address, example `http://localhost:5000`, if OctoPrint is locally installed will be read from the config file.
+- `OCTOPRINT_HOST` - OctoPrint HTTP address, example `http://octopi.local` or `http://localhost:5000`. Note: the protocol (`http://' or `https://') is required. If the setting for OCTOPRINT_HOST does not contain the protocol, an error will be displayed when the OctoScreen starts up.
-- `OCTOPRINT_APIKEY` - OctoScreen expects an [API key]( http://docs.octoprint.org/en/master/api/general.html) to be supplied. This API key can be either the globally configured one or a user specific one if “Access Control”. if OctoPrint is locally installed will be read from the config file.
+- `OCTOPRINT_APIKEY` - OctoScreen expects an [API key]( http://docs.octoprint.org/en/master/api/general.html) to be supplied. This API key can be either the globally configured key, or a user-specific one if “Access Control” is enabled.
- `OCTOSCREEN_STYLE_PATH` - Several themes are supported, and style configurations can be done through CSS. This variable defines the location of the application theme.
@@ -107,11 +107,11 @@ The basic configuration is handled via environment variables, if you are using t
- `OCTOPRINT_CONFIG_FILE` - The location of the OctoPrint's config.yaml file. If empty, the file path used will be the `pi` home folder of the current user. Only used for locally installed OctoPrint servers.
-- `OCTOSCREEN_LOG_LEVEL` - Controls the level of logging. Accepted values are (with increasing levels): Debug, Info, Warn, and Error. If no value is provided, the log level will default to Warn.
-
- `OCTOSCREEN_LOG_FILE_PATH` - The file path to where the log file will be saved. The file path must be in the location of where the app is run, and can not use external paths (eq, ~/ or / are out). The file path should not only include the path to the log file, but the name of the log file as well (eq logs/logfile.txt). The log file is appended to, and never automatically truncated and will grow over time. If you turn log file logging on (by specifying a path), be sure to turn it off (by setting the value to "").
-- `OCTOSCREEN_RESOLUTION` - Resolution of the application, should be configured to the resolution of your screen. Optimal resolution for OctoScreen is no less than 800x480, so if the physical resolution of your screen is 480x320, it's recommended to set the software resolution 800x533. If you are using Raspbian you can do it by changing [`hdmi_cvt`](https://www.raspberrypi.org/documentation/configuration/config-txt/video.md) param in `/boot/config.txt` file.
+- `OCTOSCREEN_LOG_LEVEL` - Controls the level of logging. Accepted values are (with increasing levels): debug, info, warn, and error. If no value is provided, the log level will default to warn.
+
+- `OCTOSCREEN_RESOLUTION` - Resolution of the application, and should be configured to the resolution of your screen. Optimal resolution for OctoScreen is no less than 800x480, so if the physical resolution of your screen is 480x320, it's recommended to set the software resolution 800x533. If you are using Raspbian you can do it by changing [`hdmi_cvt`](https://www.raspberrypi.org/documentation/configuration/config-txt/video.md) param in `/boot/config.txt` file. Please see [Setting Up OctoScreen and Your Display](https://github.com/Z-Bolt/OctoScreen/wiki/Setting-Up-OctoScreen-and-Your-Display) and [Installing OctoScreen with a 3.5" 480x320 TFT screen](https://github.com/Z-Bolt/OctoScreen/wiki/Installing-OctoScreen-with-a-3.5%22-480x320-TFT-screen) for more information.