CreatBot/CreatBotMoonraker
7
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: Note changes to the file manager path restrictions

Browse Source 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
This commit is contained in:
Arksine 2020-12-31 20:23:48 -05:00
parent 1814a11a8d
commit 933622adda
4 changed files with 15 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -18,7 +18,7 @@ to see if any action is necessary on their part. The date of the most
recent change is included.
Users:\
[user_changes.md](/docs/user_changes.md) - December 6th 2020
[user_changes.md](/docs/user_changes.md) - December 31st 2020
Developers:\
[api_changes.md](/docs/api_changes.md) - November 28th 2020
[api_changes.md](/docs/api_changes.md) - December 30th 2020

10
docs/configuration.md
View File

@ -44,13 +44,9 @@ config_path:
# The path to a directory where configuration files are located. This
# directory may contain Klipper config files (printer.cfg) or Moonraker
# config files (moonraker.conf). Clients may also write their own config
# files to this directory. There are restrictions on the location of
# this path, it must be located within the users HOME directory or within
# "/etc/moonraker". The path may not be the HOME directory itself. It is
# valid for the path to be "/etc/moonraker", however this is not recommended.
# Something like "/etc/moonraker/config" would be a more appropriate option.
# If you choose to locate files in "/etc/moonraker" be sure that Moonraker
# has read/write permissions in this directory.
# files to this directory. Note that this may not be the system root
# (ie: "/") and moonraker must have read and write access permissions
# for this directory.
```
## authorization

11
docs/installation.md
View File

@ -149,15 +149,8 @@ missing one or both, you can simply add the bare sections to printer.cfg:
path: ~/gcode_files
```
NOTES:
- While Klipper does not set any hard limits on the location of the
`path` option for the `virtual_sdcard`, Moonraker does have specific
requirements for the location of this folder:
- It must be directory located in the HOME path or in `/etc/moonraker`
- It may not be the HOME directory itself. It is ok for this folder
to be `/etc/moonraker`, however that is not recommended. Something
like `/etc/moonraker/gcode_files` would be more appropriate.
- If you choose to place files in `/etc/moonraker` you must be sure that
Moonraker has permission to read/write to the directory.
- Make sure that Moonraker (and Klipper) has read and write access to the
directory set in the `path` option for the `virtual_sdcard`.
- Upon first starting Moonraker is not aware of the gcode file path, thus
it cannot serve gcode files, add directories, etc. After Klippy enters
the "ready" state it sends Moonraker the gcode file path.

8
docs/user_changes.md
View File

@ -1,6 +1,14 @@
This file will track changes that require user intervention,
such as a configuration change or a reinstallation.
### December 31st 2020
- The file manager no longer restricts the `config_path` to a folder
within the HOME directory. The path may not be the system root,
however it can reside anywhere else on the file system as long as
Moonraker has read and write access to the directory. This applies
to gcode path received from Klipper via the `virtual_sdcard` section
as well.
### December 6th 2020
- Moonraker is now installed as a systemd service. This allows logging
to stdout which can be viewed with the `journalctl -u moonraker` command.