Skip to content

Commit 6910490

Browse files
committed
update CHANGELOG with v3 migration notes
1 parent 388c175 commit 6910490

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

CHANGELOG.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,15 @@
77

88
### Breaking changes
99

10-
PR #135 introduced a change that will not affect most users, but may be a breaking change for existing users that are using a volume mounting strategy other than the recommended strategy. Details follow:
10+
PR #135 introduced a change that will not affect most users, but may be a breaking change for existing users that are using a volume mounting strategy other than the recommended strategy.
1111

12-
- `/octoprint/octoprint` and `/octoprint/plugins` folders are now explicitly created during docker build
12+
We have introduced an optional environment variable you can set to attempt to automigrate the file structures, but this feature was impossible to test for all condidtions, and as such is
13+
defaulted to `false`. We highly recommend you use the OctoPrint backup feature, or use this [docker based method of backing up your container volume][container-backup] before attempting auto-migration.
14+
To attempt auto-migration, set a container environment variable of `AUTOMIGRATE=true`.
15+
16+
Details of breaking changes follow:
17+
18+
- `/octoprint/octoprint` and `/octoprint/plugins` folders are now explicitly created during docker build
1319
- octoprint service basedir is now `/octoprint/octoprint` (was previously `/octoprint`)
1420
- the recommended mount path for the `config-editor` container to has been changed to `octoprint:/octoprint`. See updated examples and usage info in `docker-compose.yml` and `README`.
1521

@@ -93,6 +99,8 @@ This new method will allow savvy users to create distinct volumes for plugin bin
9399
octoprint configuration data, giving them more ability to selectively control how state and
94100
memory consumption are utilized in their octoprint image usage/distribution strategies.
95101

102+
[container-backup]: https://docs.docker.com/storage/volumes/#backup-a-container
103+
96104
## 2.0.0
97105

98106
### BREAKING CHANGES

0 commit comments

Comments
 (0)