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) new and updated docs #192

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
3 changes: 2 additions & 1 deletion .markdownlint.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@
"MD033": {
"allowed_elements": [
"br",
"kbd"
"kbd",
"IIcon"
]
}
}
2 changes: 2 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,11 @@
"sidenav",
"tideline",
"Tobikiss",
"TYPEORM",
"udev",
"udevadm",
"Unraid",
"Untruncated",
"Vetur",
"webapps",
"websockets",
Expand Down
28 changes: 28 additions & 0 deletions docs/community/sponsor-us.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
title: Sponsor us!
description: Sponsor the FDM Monster team
slug: /community/sponsor-us
---

## FDM Monster

Sponsoring the project helps keeping the project alive. These funds will be used for the domain and hosting.

- Donating a one-time or monthly using GitHub: [![GitHub Sponsors](https://img.shields.io/github/sponsors/fdm-monster?logo=github)](https://github.com/sponsors/fdm-monster)

## Individual members

### David Zwart

Founder / lead developer

- Donating a one-time or monthly using GitHub: [![GitHub Sponsors](https://img.shields.io/github/sponsors/davidzwa?logo=github)](https://github.com/sponsors/davidzwa)
- Donating a coffee David via Ko-Fi: [![Ko-Fi](https://shields.io/badge/ko--fi-Buy_me_a_coffee-ff5f5f?logo=ko-fi)](https://ko-fi.com/davidzwa)
mkevenaar marked this conversation as resolved.
Show resolved Hide resolved

### Maurice Kevenaar

Independent advisor and friend of the project / Community manager / Documentation maintainer

- Donating a one-time or monthly using GitHub: [![GitHub Sponsors](https://img.shields.io/github/sponsors/mkevenaar?logo=github)](https://github.com/sponsors/mkevenaar)
- Donating a coffee Maurice via Buy me a Coffee: [![Buy me a Coffee](https://img.shields.io/badge/Buy_Me_A_Coffee-mkevenaar-FFDD00?logo=buy-me-a-coffee)](https://www.buymeacoffee.com/mkevenaar)
mkevenaar marked this conversation as resolved.
Show resolved Hide resolved
- Donating monthly using Patreon: [![Patreon](https://img.shields.io/badge/Patreon-mkevenaar-red?logo=Patreon)](https://www.patreon.com/mkevenaar)
16 changes: 0 additions & 16 deletions docs/configuration/index.mdx

This file was deleted.

2 changes: 1 addition & 1 deletion docs/developer_setup/setup_octoprint.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -32,4 +32,4 @@ _OctoPrint dashboard with VIRTUAL printer available._

## Next Steps

Continue with the [Creating Printers](../software_usage/creating_printers.mdx) setup.
Continue with the [Creating Printers](../old_software_usage/creating_printers.mdx) setup.
15 changes: 15 additions & 0 deletions docs/installing/deprecated/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: Deprecated
description: Deprecated documentation
slug: /installing/deprecated
---

:::danger
Deprecated documentation. This documentation is there for your convenience. This documentation is provided as-is and will not be supported.
:::

```mdx-code-block
import DocCardList from '@theme/DocCardList';

<DocCardList />
```
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
---
title: Linux Service
description: How to use a Linux service for your FDM-Monster environment (deprecated)
slug: /installing/linux_service
pagination_next: configuration/index
slug: /installing/deprecated/linux_service
pagination_prev: installing/deprecated/index
pagination_next: installing/deprecated/preconfiguration
---

:::danger
Expand All @@ -15,7 +16,7 @@ The scripts on this page are available on GitHub in [installations/fdm-monster-n

![A running instance of FDM Monster 3D Printing Server with the Printing Grid opened.
Only one disabled printer is shown on the grid and it's disabled.
The rest of the grid is showing empty tiles.](../images/server-running.png)
The rest of the grid is showing empty tiles.](../../images/server-running.png)
*This is the FDM Monster web app after installation (visit [http://127.0.0.1:4000](http://127.0.0.1:4000))*

## Preparation of the Linux Service installation
Expand Down Expand Up @@ -57,7 +58,7 @@ Each configuration change requires you to run the update script:
npm i
```

Please read the [Environment configuration](../configuration/preconfiguration.mdx) section for adjusting the `.env` file.
Please read the [Environment configuration](./preconfiguration.mdx) section for adjusting the `.env` file.

## Updating the server

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,17 @@
---
title: Pre-configuring the FDM Monster Server
description: Pre-configuration
slug: /configuration/preconfiguration
slug: /installing/deprecated/preconfiguration
pagination_prev: installing/deprecated/index
pagination_next: software_usage/index
---

:::note Difficulty
Difficulty: **advanced**

Not required when using the Docker or MonsterPi installations.
:::

---

:::warning
Expand Down Expand Up @@ -36,23 +46,29 @@ Also note that no data is migrated from MongoDB to SQLite. You can use YAML expo

This new mode is experimental, although it has been tested quite a bit. We hope you are in the position to provide
feedback
in case of errors or unexpected behaviour!
in case of errors or unexpected behavior!
:::

The following variables are read and used by FDM Monster at startup. Always restart your server after a change.

- `MONGO` (Optional, required before 1.6.x) **the connection to mongodb**. For example:

> `MONGO=mongodb://127.0.0.1:27017/fdm-monster`
```dotenv
MONGO=mongodb://127.0.0.1:27017/fdm-monster
```

- `ENABLE_EXPERIMENTAL_TYPEORM` (Optional) **a flag indicating SQLite should be used instead of MongoDB. Setting it to
exactly `true` will enable this new mode.**

- `ENABLE_EXPERIMENTAL_TYPEORM=true`
```dotenv
ENABLE_EXPERIMENTAL_TYPEORM=true
```

- `SERVER_PORT` (Optional, default=4000) **the port of the local FDM Monster website**. For example:

> `SERVER_PORT=4000`
```dotenv
SERVER_PORT=4000
```

## The `.env` file

Expand Down Expand Up @@ -103,5 +119,5 @@ services:
- SERVER_PORT: 4000
```

Please continue by reading the [Docker Compose section](../installing/docker_compose.mdx) for more information on how
Please continue by reading the [Docker Compose section](../docker_compose.mdx) for more information on how
to setup FDM Monster and MongoDB with docker-compose.
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
---
title: Windows Service
description: How to use a Windows service for your FDM-Monster environment (deprecated)
slug: /installing/windows_service
pagination_next: configuration/index
slug: /installing/deprecated/windows_service
pagination_prev: installing/deprecated/index
pagination_next: installing/deprecated/preconfiguration
---
:::danger

Expand All @@ -20,7 +21,7 @@ in [installations/fdm-monster-node-windows](https://github.com/fdm-monster/fdm-m

![A running instance of FDM Monster 3D Printing Server with the Printing Grid opened.
Only one disabled printer is shown on the grid and it's disabled.
The rest of the grid is showing empty tiles.](../images/server-running.png)
The rest of the grid is showing empty tiles.](../../images/server-running.png)
*This is the FDM Monster web app after installation (visit [http://localhost:4000](http://localhost:4000))*

## Preparation for the Windows service installation
Expand Down Expand Up @@ -127,7 +128,7 @@ containing the description `FDM Monster` in Task Manager.
The service should have `Status: Running``. If this is not the case, something went wrong. Reach out to us
via [Discord](https://discord.gg/mwA8uP8CMc) for more help!

![Windows Task Manager showing the Services tab on which a service named fdmmonster.exe is showing status Running](../images/task-manager.png)
![Windows Task Manager showing the Services tab on which a service named fdmmonster.exe is showing status Running](../../images/task-manager.png)

If things are working, you can open FDM Monster with this URL: [http://localhost:4000](http://localhost:4000)
or [http://127.0.0.1:4000](http://127.0.0.1:4000).
Expand Down Expand Up @@ -170,5 +171,5 @@ Run the script as follows:
./uninstall-fdm-monster.ps1
```

Please continue to [Environment configuration](../configuration/preconfiguration.mdx) to change the environment
Please continue to [Environment configuration](./preconfiguration.mdx) to change the environment
configuration of the FDM Monster server.
3 changes: 2 additions & 1 deletion docs/installing/docker_compose.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
title: Docker and Docker Compose
description: How to use Docker for your FDM-Monster environment
slug: /installing/docker_compose
pagination_next: configuration/index
pagination_prev: installing/index
pagination_next: software_usage/index
---

:::info
Expand Down
13 changes: 9 additions & 4 deletions docs/installing/monsterpi.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
title: MonsterPi for Raspberry Pi
description: How to setup MonsterPi for your FDM-Monster environment
slug: /installing/monsterpi
pagination_next: configuration/index
pagination_prev: installing/index
pagination_next: software_usage/index
---

[MonsterPi](https://github.com/fdm-monster/MonsterPi) is a [Raspberry Pi](https://www.raspberrypi.org/) image built
Expand All @@ -15,7 +16,7 @@ page.

## Latest Version

[![Latest Version](https://img.shields.io/github/v/release/fdm-monster/monsterpi.svg?color=d52828&label=stable)](https://github.com/fdm-monster/monsterpi/releases/latest)
[![Latest Version](https://img.shields.io/github/v/release/fdm-monster/monsterpi.svg?color=1eb6c3&label=stable)](https://github.com/fdm-monster/monsterpi/releases/latest)

The downloaded file needs to be unzipped before flashing it to your SD Card. Use your favorite unzipping application to
extract the files.
Expand All @@ -37,6 +38,10 @@ Steps:
1) Alternatively, you can visit [http://monsterpi.local](http://monsterpi.local)
or [https://monsterpi.local (Self-Signed SSL Certificate)](https://monsterpi.local) to access FDM Monster

:::info
You cannot change the default username and password using the Raspberry Pi Imager. The default username and password will still be `pi` and `raspberry`. This is due to a limitation of using `Ubuntu` instead of `RaspberryPiOS`.
:::

## Upgrading FDM Monster in MonsterPi

:::warning
Expand Down Expand Up @@ -86,11 +91,11 @@ 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](../configuration/yaml_import_export.mdx) for more details.
1) Refer to [YAML Import and Export](../software_usage/yaml_import_export.mdx) 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](../configuration/yaml_import_export.mdx#user-interface) for the import.
1) Import the YAML file according to [YAML Import and Export](../software_usage/yaml_import_export.mdx#user-interface) for the import.
1) Your printers and floors will reappear.

### MonsterPi Version 0.2.0 -> 0.3.0+
Expand Down
30 changes: 30 additions & 0 deletions docs/old_software_usage/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
title: Software Usage
description: FDM Monster software usage
slug: /software_usage
---

The FDM Monster webapp is a web application that can be used to manage your 3D printers. It is designed to be used on a
desktop computer, and in the future it is going to be suitable for use on a tablet or mobile phone.

## Creating Printers

Please read the [Creating Printers](./creating_printers.mdx) section for more information.
After creating a printer, you can place it on a floor.

## Organizing Floors

Please read the [Organizing Floors](./organizing_floors.mdx) section for more information.

## Printing one GCode file

To print a file on an OctoPrint, you can upload it to the printer by dragging and dropping it on the printer.

**Batch print**
You can also upload it to the printer by clicking on the printer to select it,
and then drag and drop the file in the file upload area on the top. This allows you to upload a file to multiple
printers at once.

**Batch reprint**
You can also reprint a file on multiple printers at once by clicking on all printers involved to select them.
Then click the reprint button in the top bar. This will reprint the last file that was printed on all selected printers.
55 changes: 55 additions & 0 deletions docs/software_usage/first-time-setup.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
---
title: First Time Setup
description: First time startup wizard
slug: /software_usage/first-time-setup
---

After you have installed FDM Monster, you'll need to head to the FDM Monster URL. This URL depends on your installation method.

The first time setup steps consists of 3 steps in total.

## Introduction

When going to the web application for the first time, you will be greeted with the image below. Click on the **[START SETUP]** button to get started!

![First Time Setup Introduction step](./images/fts-step1.png)

## Login and registration

This step is used to create the admin account and initial login settings. The settings are described below.

![First Time Setup Login and registration step](./images/fts-step2.png)

### Login

- **Enable Login** - this setting is enabled by default, you could disable this to have no logins required for FDM Monster.
:::danger
FDM Monster Team advises you to keep this enabled for security reasons.
:::
- **Enable Registration** - this setting allows other users to register an account on your FDM Monster installation. If your environment requires so, you could enable this setting.

### Admin account

- **Username** - this is set, by default, to admin. Depending on the public exposure of FDM Monster, this value should be changed to something unique
- **Password** - this is the password for the admin account.
:::info
FDM Monster Team advises you to create a strong password and keep it in a safe place
:::
- **Repeat Password** - repeat the password for the admin account. This should be the same as the previous one.

### Buttons

- **[BACK]** - Return to the [previous](#introduction) screen.
- **[VERIFY & SUBMIT]** - Submit the changes and continue. This button will be enabled once all mandatory fields are filled in

## Summary

The summary step is shown. Only one button is available. Click on the **[LET'S CONTINUE]** button to continue to the login screen

![First Time Setup Summary page](./images/fts-step3.png)

## Login to your account

After you completed the First Time Setup steps, you'll be sent over to the **Login to your account** window, unless you have opted out to login.

![FDM Monster login window](./images/fts-login.png)
Loading
Loading