CreatBot/CreatBotMainsail
11
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: Update First Boot docs (#506)

Browse Source 
* Update first boot page for readability and feedback

Signed-off-by Paul Cutler paul@paulcutler.org

* adjusted some codeblocks

Co-authored-by: lixxbox <lixxbox@users.noreply.github.com>
This commit is contained in:
Paul Cutler 2022-01-04 09:15:56 -06:00 committed by GitHub
parent 52ad699f92
commit 7b3781ebaf
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 18 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
docs/setup-guide/mainsailos/first-boot.md
View File

@ -11,54 +11,56 @@ permalink: /setup/mainsailos/first-boot
# First boot
Insert the flashed SD card into your Pi and connect other desired/necessary hardware (ethernet, USB to 3D printer, webcam).
Insert the flashed SD card into your Pi and connect any other hardware such a network cable, USB cable to the 3D printer, or a webcam.
Power on the Pi and leave it to boot.
Power on the Pi and let it boot up.
**The initial boot of MainsailOS may take some time to expand your "root" filesystem. The larger the SD card, the longer the first boot will take.**
{: .warning}
Initially the green LED on the Pi will be extremely active. After some time it will only intermittently flicker, indicating it has likely completed the boot sequence.
The web ui should now be ready to access on your local network:
The web interface should now be ready to access on your local network:
```
http://mainsailos.local
http://<IP address of your pi>
```
or
```
http://<IP address of your Pi>
```
## Mainsail.cfg
**Important:** Include the mainsail.cfg into your printer.cfg
**Important:** Include `mainsail.cfg` in your printer.cfg file
{: .warning}
Mainsail will not work unless Klipper is told to include its configuration. This can be achieved either by placing the contents of mainsail.cfg into your printer.cfg.
Mainsail will not work correctly until `mainsail.cfg` is included in Klipper's configuration file. Open Klipper's default `printer.cfg` file in Mainsail's file manager located in `Settings > Machine`. If you do not have a `printer.cfg` file, you can create one. Add the following line to `printer.cfg`
To do this, open the default printer.cfg in the Mainsail web GUI:
```
[include mainsail.cfg]
```
![screenshot-web-editor](../../../assets/img/setup/screenshot-web-editor-printer.png)
![screenshot-web-editor-printercfg](../../../assets/img/setup/screenshot-printercfg-include-mainsail.png)
Add the following line:
and click on the`Save & Restart` button.
```yml
[include mainsail.cfg]
```
and click on the "Save & Restart" button.
{: .info}
## Updates
Once you've successfully navigated to the Mainsail web ui we _thoroughly_ recommend that you run updates.
Once you've successfully navigated to the Mainsail's web interface it is _strongly_ recommend that you run any available updates.
Klipper, Moonraker and Mainsail have fast development cycles and whilst we do our best to ensure MainsailOS ships as close to the bleeding edge as we can, there will always be a short delay before releases make it into the image.
Klipper, Moonraker and Mainsail have fast development cycles and while we do our best to ensure MainsailOS ships as close to upstream as we can, there will always be a short delay before releases make it into MainsailOS' image.
We recommend that you enable and use the [built in update-manager](../../update/update-manager) to perform a system update, then update the stack components (Klipper, Moonraker, Mainsail)
It is recommended that you enable and use the [built in update-manager](../../update/update-manager) to perform any system updates, then update Klipper, Moonraker, Mainsail as needed.
![screenshot-update-manager](../../../assets/img/update/screenshot-update-manager-example-not-up-to-date.png)
MainsailOS is now configured, and we can get Klipper's [printer.cfg](klipper-setup) setup.
MainsailOS is now configured, and Klipper's configuration file, [printer.cfg], can be setup.
---
[< tool selection](../mainsail-os.md){: .btn } [next step >](klipper-setup){: .btn }