Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Update First Boot docs #506

Merged
merged 20 commits into from
Jan 4, 2022
Merged
Changes from all commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
4088a9a
Update necessary-cfg for grammar and readability fixes
prcutler Dec 19, 2021
c6eb46a
Update homepage for typos, grammar and readability
prcutler Dec 19, 2021
844bd35
Update index.md in manual setup for readability
prcutler Dec 19, 2021
1c32f4a
Update for readability and make editing moonraker.conf a sub-chapter
prcutler Dec 19, 2021
481c126
Update for readabiliy and grammar
prcutler Dec 19, 2021
b4bc05e
Update for readability and grammar
prcutler Dec 19, 2021
794e22c
Merge branch 'mainsail-crew:develop' into develop
prcutler Dec 19, 2021
d649572
Fix PR #478 with review feedback - fix Klipper pause / resume
prcutler Dec 19, 2021
f636443
Merge branch 'develop' of https://github.com/prcutler/mainsail into d…
prcutler Dec 19, 2021
5b49113
Fix typo (missing s in preset)
prcutler Dec 19, 2021
1d5022a
Make call to action stronger, remove "it is" for "time to print!"
prcutler Dec 19, 2021
bdd669e
Improve readability on front page
prcutler Dec 26, 2021
38dcfee
Update Kiauh page for readability and gramma
prcutler Dec 26, 2021
eb12d6d
Review and update Update guides for spelling, grammar, readabilty and…
prcutler Dec 26, 2021
2f592a8
Merge branch 'mainsail-crew:develop' into develop
prcutler Dec 27, 2021
74794bf
Review updates from yesterday and fix some errors from updating the docs
prcutler Dec 27, 2021
f95da10
Apply feedback to fix typos for PR#478
prcutler Jan 1, 2022
10ac998
Merge branch 'mainsail-crew:develop' into develop
prcutler Jan 3, 2022
94eb9f1
Update first boot page for readability and feedback
prcutler Jan 3, 2022
473d1a4
adjusted some codeblocks
lixxbox Jan 4, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 18 additions & 16 deletions docs/setup-guide/mainsailos/first-boot.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 }
Expand Down