updated the default config file2.6.1-dev

1 files changed, 34 insertions, 17 deletions

diff --git a/debian/local/octoscreen/config b/debian/local/octoscreen/config
index 6c6c88c..002dd80 100755
--- a/debian/local/octoscreen/config
+++ b/debian/local/octoscreen/config
@@ -1,32 +1,49 @@
 # Required Configuration Settings
 
-# Location of the OctoPrint's config.yaml file. If empty the file will
-# be search at the `pi` home folder or the current user. Only used for locally
-# installed OctoPrint servers.
-OCTOPRINT_CONFIG_FILE=/home/pi/.octoprint/config.yaml
-
-# OctoPrint HTTP address, example `http://localhost:5000`, if OctoPrint is
-# locally installed will be read from the config file.
+# The URL to the OctoPrint server.
+# 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 OctoScreen starts.
 OCTOPRINT_HOST=http://localhost:5000
 
-# OctoScreen expects an API key to be supplied. This API key can be either
-# the globally configured one or a user specific one if “Access Control”.
-# http://docs.octoprint.org/en/master/api/general.html, if OctoPrint is
-# locally installed will be read from the config file.
+
+# OctoScreen expects an API key to be supplied. The API key can
+# either be set in OctoScreen's config file, or in OctoPrint's config
+# file (OCTOPRINT_CONFIG_FILE below)
 OCTOPRINT_APIKEY=
 
 
+# Location of the application theme
+OCTOSCREEN_STYLE_PATH=/opt/octoscreen/styles/z-bolt/
+
+
 
 # Optional Configuration Settings
 
-# Location of file for logging (optional)
-OCTOSCREEN_LOG_LEVEL=Warn
+# The location of OctoPrint's config.yaml file.
+# If empty, the file path used will be the pi home folder of the current user.
+# The OCTOPRINT_APIKEY is required, and if it isn't defined in OctoScreen's
+# config file (see OCTOPRINT_APIKEY above), it needs to be defined in OctoPrint's
+# config file.
+OCTOPRINT_CONFIG_FILE=/home/pi/.octoprint/config.yaml
 
-# Location of file for logging (optional)
-OCTOSCREEN_LOG_FILE_PATH=logs/logfile.txt
 
-# Location of the application theme (optional)
-OCTOSCREEN_STYLE_PATH=/opt/octoscreen/styles/z-bolt/
+# The file path to where the log file will be saved.
+# The file path should be a fully qualified path and not only include the path
+# to the log file, but the name of the log file as well
+# (eg /home/pi/logs/logfile.txt).
+# The log file is appended to and is 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_LOG_FILE_PATH=
+#OCTOSCREEN_LOG_FILE_PATH=/home/pi/logs/logfile.txt
+
+
+# Controls the level of logging.
+# Accepted values are (with increasing levels): debug, info, warn, and error.
+OCTOSCREEN_LOG_LEVEL=Error
+
 
 # Resolution of the application, and should be configured to the resolution of your
 # screen, for example 800x480.