Skip to content

Commit a37a639

Browse files
committed
docs: update paths for moonraker and klipper
1 parent c17b4ca commit a37a639

File tree

2 files changed

+35
-39
lines changed

2 files changed

+35
-39
lines changed

docker/klipper/README.md

Lines changed: 19 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ Create a configfile `printer.cfg` and a directory `run` and execute:
1717
docker run \
1818
--privileged \
1919
-v /dev:/dev \
20-
-v $(pwd)/run:/ \
21-
-v $(pwd)/printer.cfg:/opt/cfg/printer.cfg \
20+
-v $(pwd)/run:/opt/printer_data/run \
21+
-v $(pwd)/printer.cfg:/opt/printer_data/config/printer.cfg \
2222
mkuf/klipper:latest
2323
```
2424

@@ -30,8 +30,8 @@ services:
3030
privileged: true
3131
volumes:
3232
- /dev:/dev
33-
- ./printer.cfg:/opt/cfg/printer.cfg
34-
- ./run:/opt/run
33+
- ./printer.cfg:/opt/printer_data/config/printer.cfg
34+
- ./run:/opt/printer_data/run
3535
```
3636
3737
### With Moonraker
@@ -41,21 +41,21 @@ To limit klippers access to system devices (`/dev`), the printers physical seria
4141

4242
Further Info on how to use the Moonraker Image can be found in its [README.md](../moonraker/README.md)
4343

44-
Create `moonraker.cfg` and `printer.cf` as well as the directories `run` and `gcode`, then run the containers.
44+
Create `moonraker.conf` and `printer.cfg` as well as the directories `run` and `gcode`, then run the containers.
4545

4646
#### Run
4747
```bash
4848
docker run \
4949
--device /dev/ttymxc3:/dev/ttymxc3 \
50-
-v $(pwd)/run:/ \
51-
-v $(pwd)/gcode:/opt/gcode \
52-
-v $(pwd)/printer.cfg:/opt/cfg/printer.cfg \
50+
-v $(pwd)/run:/opt/printer_data/run \
51+
-v $(pwd)/gcode:/opt/printer_data/gcodes \
52+
-v $(pwd)/printer.cfg:/opt/printer_data/config/printer.cfg \
5353
mkuf/klipper:latest
5454
5555
docker run \
56-
-v $(pwd)/run:/ \
57-
-v $(pwd)/gcode:/opt/gcode \
58-
-v $(pwd)/moonraker.cfg:/opt/cfg/moonraker.cfg \
56+
-v $(pwd)/run:/opt/printer_data/run \
57+
-v $(pwd)/gcode:/opt/printer_data/gcodes \
58+
-v $(pwd)/moonraker.conf:/opt/printer_data/config/moonraker.conf \
5959
-p 7125:7125 \
6060
mkuf/moonraker:latest
6161
```
@@ -68,18 +68,18 @@ services:
6868
devices:
6969
- /dev/ttymxc3:/dev/ttymxc3
7070
volumes:
71-
- ./printer.cfg:/opt/cfg/printer.cfg
72-
- ./run:/opt/run
73-
- ./gcode:/opt/gcode
71+
- ./printer.cfg:/opt/printer_data/config/printer.cfg
72+
- ./run:/opt/printer_data/run
73+
- ./gcode:/opt/printer_data/gcodes
7474
7575
moonraker:
7676
image: mkuf/moonraker:latest
7777
ports:
7878
- "7125:7125"
7979
volumes:
80-
- ./moonraker.cfg:/opt/cfg/moonraker.cfg
81-
- ./run:/opt/run
82-
- ./gcode:/opt/gcode
80+
- ./moonraker.conf:/opt/printer_data/config/moonraker.conf
81+
- ./run:/opt/printer_data/run
82+
- ./gcode:/opt/printer_data/gcodes
8383
```
8484

8585
## Defaults
@@ -88,17 +88,15 @@ services:
8888
|User| `klipper (1000:1000)` |
8989
|Workdir|`/opt`|
9090
|Entrypoint|`/opt/venv/bin/python klipper/klipper/klippy.py`|
91-
|Cmd|`-I run/klipper.tty -a run/klipper.sock cfg/printer.cfg`|
91+
|Cmd|`-I printer_data/run/klipper.tty -a printer_data/run/klipper.sock printer_data/config/printer.cfg`|
9292

9393
## Ports
9494
none
9595

9696
## Volumes
9797
|Volume|Description|
9898
|---|---|
99-
|`/opt/run`| Default Location for runtime Files generated by Klipper. <br>Namely `klipper.tty`, the emulated Serial device <br>and `klipper.sock`, the unix socket that is used for communation with moonraker |
100-
|`/opt/cfg`|Config directory to host `printer.cfg`|
101-
|`/opt/gcode`|Stores GCODE Files to be used by Klipper|
99+
|`/opt/printer_data`| Default Location for printer data as proposed by Moonraker |
102100

103101
## Tags
104102
|Tag|Description|Static|

docker/moonraker/README.md

Lines changed: 16 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -7,23 +7,23 @@ _via https://moonraker.readthedocs.io/en/latest/_
77

88
## Usage
99
Moonraker requires Klipper to operate. See the Images' [README.md](../klipper/README.md) on how to run the Klipper Image.
10-
Both Containers need to share their `run` Volume in order to be able to communicate via klippers unix socket. Configure Moonraker to use `/opt/run/klipper.sock` as klippys uds address.
10+
Both Containers need to share their `run` Volume in order to be able to communicate via klippers unix socket. Configure Moonraker to use `/opt/printer_data/run/klipper.sock` as klippys uds address.
1111

12-
Create `moonraker.cfg` and `printer.cf` as well as the directories `run` and `gcode`, then run the containers.
12+
Create `moonraker.conf` and `printer.cfg` as well as the directories `run` and `gcode`, then run the containers.
1313

1414
#### Run
1515
```bash
1616
docker run \
1717
--device /dev/ttymxc3:/dev/ttymxc3 \
18-
-v $(pwd)/run:/ \
19-
-v $(pwd)/gcode:/opt/gcode \
20-
-v $(pwd)/printer.cfg:/opt/cfg/printer.cfg \
18+
-v $(pwd)/run:/printer_data/run \
19+
-v $(pwd)/gcode:/opt/printer_data/gcodes \
20+
-v $(pwd)/printer.cfg:/opt/printer_data/config/printer.cfg \
2121
mkuf/klipper:latest
2222

2323
docker run \
24-
-v $(pwd)/run:/ \
25-
-v $(pwd)/gcode:/opt/gcode \
26-
-v $(pwd)/moonraker.cfg:/opt/cfg/moonraker.cfg \
24+
-v $(pwd)/run:/printer_data/run \
25+
-v $(pwd)/gcode:/opt/printer_data/gcodes \
26+
-v $(pwd)/moonraker.conf:/opt/printer_data/config/moonraker.conf \
2727
-p 7125:7125 \
2828
mkuf/moonraker:latest
2929
```
@@ -36,18 +36,18 @@ services:
3636
devices:
3737
- /dev/ttymxc3:/dev/ttymxc3
3838
volumes:
39-
- ./printer.cfg:/opt/cfg/printer.cfg
40-
- ./run:/opt/run
41-
- ./gcode:/opt/gcode
39+
- ./printer.cfg:/opt/printer_data/conf/printer.cfg
40+
- ./run:/opt/printer_data/run
41+
- ./gcode:/opt/printer_data/gcodes
4242

4343
moonraker:
4444
image: mkuf/moonraker:latest
4545
ports:
4646
- "7125:7125"
4747
volumes:
48-
- ./moonraker.cfg:/opt/cfg/moonraker.cfg
49-
- ./run:/opt/run
50-
- ./gcode:/opt/gcode
48+
- ./moonraker.conf:/opt/printer_data/conf/moonraker.conf
49+
- ./run:/opt/printer_data/run
50+
- ./gcode:/opt/printer_data/gcodes
5151
```
5252
5353
## Defaults
@@ -56,7 +56,7 @@ services:
5656
|User| `moonraker (1000:1000)` |
5757
|Workdir|`/opt`|
5858
|Entrypoint|`/opt/venv/bin/python moonraker/moonraker/moonraker.py`|
59-
|Cmd|`-c cfg/moonraker.cfg`|
59+
|Cmd|`-d /opt/printer_data/`|
6060

6161
## Ports
6262
|Port|Description|
@@ -66,9 +66,7 @@ services:
6666
## Volumes
6767
|Volume|Description|
6868
|---|---|
69-
|`/opt/run`| Default Location for runtime Files generated by Klipper. Used to access `klipper.sock`, the unix socket that is used for communation with klipper |
70-
|`/opt/cfg`|Config directory to host `moonraker.cfg`|
71-
|`/opt/gcode`|Stores uploaded GCODE Files|
69+
|`/opt/printer_data`| Default Location for printer data by Moonraker |
7270

7371
## Tags
7472
|Tag|Description|Static|

0 commit comments

Comments
 (0)