Skip to content

Commit

Permalink
Merge pull request #133 from fdm-monster/docs132-upgrade-path-from-mo…
Browse files Browse the repository at this point in the history
…nsterpi-0.3-to-0.4

Docs132 upgrade path from monsterpi 0.3 to 0.4
  • Loading branch information
davidzwa authored Apr 22, 2024
2 parents 931ed46 + a4b5ded commit 21e1422
Show file tree
Hide file tree
Showing 2 changed files with 61 additions and 14 deletions.
48 changes: 48 additions & 0 deletions docs/0_installing/monsterpi.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,54 @@ Upgrading MonsterPi requires you to have SSH knowledge. If you do not feel comfo
not continue and ask an expert to assist you!
:::

### MonsterPi Version 0.4+

Run the following commands as the `pi` user and execute an update with root elevation.
Replace `VERSION_HERE` with the version of FDM Monster you like.

```bash
cd ~/scripts

# Deploy the FDM Monster server update
sudo bash ./update-fdm-monster.sh --tag "VERSION_HERE" --non-interactive
```

For example, if your FDM Monster is 1.6.2 and let's imagine 1.7.0 was available.
You would do the upgrade like this:

```bash
cd ~/scripts
sudo bash ./update-fdm-monster.sh --tag "1.7.0" --non-interactive
```

If you would like to upgrade to the latest, you can run it like this, but beware that this mode is still
experimental. It might not install the true latest or highest version sometimes, this happens mostly when a release candidate was released before (like 1.6.0-rc3).

```bash
cd ~/scripts
sudo bash ./update-fdm-monster.sh
```

Please make sure to find the latest version tag on GitHub here https://github.com/fdm-monster/fdm-monster/tags.
That way you can use the `--tag` based command, which is known to work well.

### MonsterPi Version 0.2/0.3 to 0.4+

:::warning
There is no upgrade path to MonsterPi 0.4. Only by downloading the new image, users will be able to use FDM Monster 1.6 and up.
:::

It is advised to export a `.yaml` file to back up your printers, printer floor positions and floors.
Here are the steps to take:
1) Go to the import/export dialog to get the `.yaml` file as a download.
1) Check the file for missing or incorrect properties. Correct the mistakes with a text editor and save.
1) Refer to [YAML Import and Export](../2_configuration/yaml_import_export.md) for more details.
1) Ensure your .yaml is ready to be imported.
1) Flash a new SD card with the installation steps [above](#installing-monsterpi)
1) Ensure your MonsterPi is working. Proceed through the setup and create an account.
1) Import the YAML file according to [YAML Import and Export](../2_configuration/yaml_import_export.md#user-interface) for the import.
1) Your printers and floors will reappear.

### MonsterPi Version 0.2.0 -> 0.3.0+

Run the following commands as the `pi` user and execute an update with root elevation.
Expand Down
27 changes: 13 additions & 14 deletions docs/2_configuration/yaml_import_export.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ The YAML import/export function allows users to export and import their printer
Here is an example of a YAML file generated by the export function:

```yaml
version: 1.3.1
exportedAt: 2023-05-04T06:35:30.721Z
version: 1.5.1
exportedAt: 2023-11-11T09:02:41.703Z
config:
exportPrinters: true
exportFloorGrid: true
Expand All @@ -22,22 +22,21 @@ config:
floorComparisonStrategiesByPriority: floor
notes: 'Some notes, made this layout for the summer 23'' setup '
printers:
- id: 645351fe98d304b62a03e50d
stepSize: 10
- id: 648f3e6d372112628bb8e404
disabledReason: null
enabled: true
dateAdded: 1683182078022
settingsAppearance:
name: Relieved Forehead
webSocketURL: ws://localhost/
printerURL: http://localhost/
apiKey: YOUR_API_KEY_HERE
dateAdded: 1687109229334
name: Dragon Eggggg
printerURL: http://demo.fdm-monster.net:5001
apiKey: asdasdasdasdasdasdasdasdasdasdas
floors:
- id: 64427f2d070a27047acd5e6e
floor: 1
name: Default Floor
floor: 2
name: Default Floor1_5_1
printers:
- printerId: 645351fe98d304b62a03e50d
x: 1
- floorId: 64427f2d070a27047acd5e6e
printerId: 648f3e6d372112628bb8e404
x: 0
'y': 0
```
Expand Down

0 comments on commit 21e1422

Please sign in to comment.