move

jailman/wiki/content/migration/v1.1.x to v1.2.x.md

@@ -0,0 +1,61 @@
+## v1.1.x to v1.2.x
+
+With v1.2 we made it possible to run multiple jails of the same type.
+This is done by seperating jails (your individual installs) from plugins (our designs).
+
+Due to this change, the config file has been changed and thus you need to adapt your config file.
+
+
+### Jails
+
+All your jails need to be indented by 2 spaces under a main group "jails" like this:
+
+`
+jail:
+  plex: 
+    plugin: plex
+    ip4_addr: 192.168.1.99/24
+    gateway: 192.168.1.1
+    beta: false
+`
+
+Also note:
+Where previously we used `plex: plex`, we can now just use `plex:`
+
+### plugins
+
+Every jail now requires a plugin to be defined. for example:
+v1.1.x
+`
+
+plex: plex
+  ip4_addr: 192.168.1.99/24
+  gateway: 192.168.1.1
+  plexpass: false
+`
+
+In v1.2.x becomes:
+`
+jail:
+  plex: 
+    plugin: plex
+    ip4_addr: 192.168.1.99/24
+    gateway: 192.168.1.1
+    beta: false
+`
+
+### Plex
+
+Due to community feedback in v1.2.x "plexpass" has been renamed to "beta".
+
+### pkgs
+
+pkgs are removed from jail config in v1.2.x and are now part of the plugin. This way we can keep them up-to-date for you.
+
+### Documentation
+
+All jails now have wiki documentation pages and all basic jail values have been documented
+
+### Other changes
+
+Some other minor changes in config file values have been done, please refer to the example document and compare your config to the example

jailman/wiki/content/migration/v1.2.x to v1.3.x.md

@@ -0,0 +1,53 @@
+# v1.2.x to v1.3.x
+
+With v1.3.0 all our code has been completely redesigned and rewriten.
+While we tried to minimize the effects on the user, there are some consequences.
+
+Please read this document completely before migrating.
+We are **NOT** responsible if you ignore anything from this document.
+
+### Plugin backend
+With v1.3.0 we started to use plugins as a backend for jailman.
+Besides the plugins now being visable in the TrueNAS UI and the renaming of "blueprints" to "plugins" this should not have any significant changes to the user experience.
+
+However: This means all our previous jails are now not compatible with jailman anymore. A reinstall is required.
+As all our jails save their data in persistent storage, it would not have any side effects to just reinstall all your jails.
+You can still use jailman.sh -d $jail or jailman.sh -r $jail to remove or reinstall the old jails.
+
+However, please always make sure you create a snapshot before doing any possible destructive operations!
+
+#### Persistence warning on Organizr
+Due to bad design choices from the organizr team, we can't be 100% sure our current setup is persistent.
+While we do our best, we currently can't give guarantees about it
+
+### Different reinstall detection.
+With v1.3.0 we simplyfied reinstall detection.
+If a install finishes alright, it now adds a file called "INSTALLED" to the persistent config directory (by default: /apps/$jailname). As long as this file is present it will allways try to reinstall.
+As your current persistent config directories do not contain this file, all reinstalls will fail. 
+You can easily fix this by manually add a filled named `INSTALLED` to all the persistent config directories.
+
+### SSL
+With v1.3.0 we centralised all SSL to a traefik proxy. Traefik is a great utility to keep track of all SSL certificates and guarantees a more solid experience.
+This also means we do **NOT** offer any SSL-setup ourselves anymore, but in return we fully integrated traefik into the config.yml file... so you can generate your certificates even faster than before.
+
+We have a limited amount of developers and by using traefik, we can focus on things that mater: Stability and functionality, instead of working custom SSL config for every jail.
+
+### Config file format
+Because we simplified the internal config file structure, the config.yml structure has been simplified.
+Some options have been removed and the "jail" main category has been removed.
+
+An example what this means:
+```
+jail:
+  sonarrjail:
+     blueprint: sonarr
+```
+
+Will become:
+```
+sonarrjail:
+   plugin: sonarr
+```
+Where there will be NO spaces in front of the jailname anymore.
+
+