diff --git a/.vscode/settings.json b/.vscode/settings.json index 91ec2c2..12e83b1 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -37,9 +37,11 @@ "sidenav", "tideline", "Tobikiss", + "TYPEORM", "udev", "udevadm", "Unraid", + "Untruncated", "Vetur", "webapps", "websockets", diff --git a/docs/configuration/first-time-setup.mdx b/docs/configuration/first-time-setup.mdx new file mode 100644 index 0000000..50c5b4b --- /dev/null +++ b/docs/configuration/first-time-setup.mdx @@ -0,0 +1,55 @@ +--- +title: First Time Setup +description: First time startup wizard +slug: /configuration/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) diff --git a/docs/configuration/images/fts-login.png b/docs/configuration/images/fts-login.png new file mode 100644 index 0000000..235375e Binary files /dev/null and b/docs/configuration/images/fts-login.png differ diff --git a/docs/configuration/images/fts-step1.png b/docs/configuration/images/fts-step1.png new file mode 100644 index 0000000..86956bd Binary files /dev/null and b/docs/configuration/images/fts-step1.png differ diff --git a/docs/configuration/images/fts-step2.png b/docs/configuration/images/fts-step2.png new file mode 100644 index 0000000..716b22f Binary files /dev/null and b/docs/configuration/images/fts-step2.png differ diff --git a/docs/configuration/images/fts-step3.png b/docs/configuration/images/fts-step3.png new file mode 100644 index 0000000..fad6da7 Binary files /dev/null and b/docs/configuration/images/fts-step3.png differ diff --git a/docs/configuration/index.mdx b/docs/configuration/index.mdx index 71b1cda..e438b5e 100644 --- a/docs/configuration/index.mdx +++ b/docs/configuration/index.mdx @@ -2,6 +2,7 @@ title: Configuration description: Configure FDM Monster slug: /configuration +pagination_prev: installing/index --- Before starting the FDM Monster server it is possible to adjust configuration. diff --git a/docs/configuration/menu/cameras/index.mdx b/docs/configuration/menu/cameras/index.mdx new file mode 100644 index 0000000..a383378 --- /dev/null +++ b/docs/configuration/menu/cameras/index.mdx @@ -0,0 +1,6 @@ +--- +title: Cameras +description: FDM Monster Cameras +slug: /configuration/menu/cameras +--- + diff --git a/docs/configuration/menu/home/images/1.7.1-home.png b/docs/configuration/menu/home/images/1.7.1-home.png new file mode 100644 index 0000000..ba13712 Binary files /dev/null and b/docs/configuration/menu/home/images/1.7.1-home.png differ diff --git a/docs/configuration/menu/home/index.mdx b/docs/configuration/menu/home/index.mdx new file mode 100644 index 0000000..2428581 --- /dev/null +++ b/docs/configuration/menu/home/index.mdx @@ -0,0 +1,13 @@ +--- +title: Home +description: FDM Monster Home +slug: /configuration/menu/home +--- + +![FDM Monster Home screen](./images/1.7.1-home.png) + +The FDM Monster home screen is the single pane of view to monitor your farm. + +:::tip +The `DEFAULT FLOOR` drop-down will show all your floors when multiple are defined. The name `DEFAULT FLOOR` can be changed in the [Floors](../settings/floors.mdx) settings page. +::: diff --git a/docs/configuration/menu/index.mdx b/docs/configuration/menu/index.mdx new file mode 100644 index 0000000..4b5406b --- /dev/null +++ b/docs/configuration/menu/index.mdx @@ -0,0 +1,18 @@ +--- +title: Menu Items +description: All menu items described +slug: /configuration/menu +--- + +FDM Monster has multiple left-side menu items. + +- [**Home**](./home/index.mdx) - Single pane of view of your farm +- [**Printers**](./printers/index.mdx) - Printer overview +- [**Cameras**](./cameras/index.mdx) - Printer cameras +- [**Settings**](./settings/index.mdx) - FDM Monster settings + + diff --git a/docs/configuration/menu/printers/index.mdx b/docs/configuration/menu/printers/index.mdx new file mode 100644 index 0000000..e30f97b --- /dev/null +++ b/docs/configuration/menu/printers/index.mdx @@ -0,0 +1,6 @@ +--- +title: Printers +description: FDM Monster Printers +slug: /configuration/menu/printers +--- + diff --git a/docs/configuration/menu/settings/floors.mdx b/docs/configuration/menu/settings/floors.mdx new file mode 100644 index 0000000..e69de29 diff --git a/docs/configuration/settings/grid_settings.mdx b/docs/configuration/menu/settings/grid_settings.mdx similarity index 79% rename from docs/configuration/settings/grid_settings.mdx rename to docs/configuration/menu/settings/grid_settings.mdx index 5b1c38a..5bc8b17 100644 --- a/docs/configuration/settings/grid_settings.mdx +++ b/docs/configuration/menu/settings/grid_settings.mdx @@ -1,14 +1,14 @@ --- title: Grid Settings description: How to change Grid Settings -slug: /configuration/settings/grid_settings +slug: /configuration/menu/settings/grid_settings --- The grid settings influence how many printers are shown in the grid. You can adjust the amount of rows and columns, as well as enable large tile mode. Both types of settings can be changed on the fly, without restarting the server. -![Screenshot of FDM Monster with grid settings, allowing you to set grid rows and columns.](../../images/grid_settings.png) +![Screenshot of FDM Monster with grid settings, allowing you to set grid rows and columns.](../../../images/grid_settings.png) ## Grid Rows and Columns @@ -21,4 +21,4 @@ The large tile mode can be enabled by clicking the toggle button. When enabled, the grid will show large tiles instead of small tiles. In large tile mode, the grid will show fewer printers, but more information about each printer. -![Screenshot of grid view with large tiles](../../images/grid_settings_largetilemode.png) +![Screenshot of grid view with large tiles](../../../images/grid_settings_largetilemode.png) diff --git a/docs/configuration/settings/index.mdx b/docs/configuration/menu/settings/index.mdx similarity index 91% rename from docs/configuration/settings/index.mdx rename to docs/configuration/menu/settings/index.mdx index bf440e7..0de0f28 100644 --- a/docs/configuration/settings/index.mdx +++ b/docs/configuration/menu/settings/index.mdx @@ -1,19 +1,19 @@ --- title: Settings description: FDM Monster settings -slug: /configuration/settings +slug: /configuration/menu/settings --- This section specifies the settings that can be changed once the FDM Monster server has been started. Please visit this page on FDM Monster: -![Screenshot of FDM Monster with all settings sections](../../images/settings.png) +![Screenshot of FDM Monster with all settings sections](../../../images/settings.png) ## Grid Settings The Grid Settings section allows you to change the number of rows and columns in the grid, as well as enabling large tile mode. This can be useful if you want to reduce the amount of available printers in your farm. -Read more about it on the [grid settings page](grid_settings.mdx). +Read more about it on the [grid settings page](./grid_settings.mdx). ## Floors diff --git a/docs/installing/deprecated/index.mdx b/docs/installing/deprecated/index.mdx new file mode 100644 index 0000000..7057774 --- /dev/null +++ b/docs/installing/deprecated/index.mdx @@ -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'; + + +``` diff --git a/docs/installing/linux_service.mdx b/docs/installing/deprecated/linux_service.mdx similarity index 85% rename from docs/installing/linux_service.mdx rename to docs/installing/deprecated/linux_service.mdx index c6d6938..8ca0e97 100644 --- a/docs/installing/linux_service.mdx +++ b/docs/installing/deprecated/linux_service.mdx @@ -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 @@ -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 @@ -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 diff --git a/docs/configuration/preconfiguration.mdx b/docs/installing/deprecated/preconfiguration.mdx similarity index 87% rename from docs/configuration/preconfiguration.mdx rename to docs/installing/deprecated/preconfiguration.mdx index e269d15..6cd00e1 100644 --- a/docs/configuration/preconfiguration.mdx +++ b/docs/installing/deprecated/preconfiguration.mdx @@ -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: configuration/index +--- + +:::note Difficulty +Difficulty: **advanced** + +Not required when using the Docker or MonsterPi installations. +::: + --- :::warning @@ -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 @@ -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. diff --git a/docs/installing/windows_service.mdx b/docs/installing/deprecated/windows_service.mdx similarity index 93% rename from docs/installing/windows_service.mdx rename to docs/installing/deprecated/windows_service.mdx index c2cb77f..e8313c3 100644 --- a/docs/installing/windows_service.mdx +++ b/docs/installing/deprecated/windows_service.mdx @@ -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 @@ -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 @@ -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). @@ -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. diff --git a/docs/installing/docker_compose.mdx b/docs/installing/docker_compose.mdx index 9f04ef2..6612930 100644 --- a/docs/installing/docker_compose.mdx +++ b/docs/installing/docker_compose.mdx @@ -2,6 +2,7 @@ title: Docker and Docker Compose description: How to use Docker for your FDM-Monster environment slug: /installing/docker_compose +pagination_prev: installing/index pagination_next: configuration/index --- diff --git a/docs/installing/monsterpi.mdx b/docs/installing/monsterpi.mdx index 838a716..a3598f0 100644 --- a/docs/installing/monsterpi.mdx +++ b/docs/installing/monsterpi.mdx @@ -2,6 +2,7 @@ title: MonsterPi for Raspberry Pi description: How to setup MonsterPi for your FDM-Monster environment slug: /installing/monsterpi +pagination_prev: installing/index pagination_next: configuration/index --- diff --git a/docusaurus.config.ts b/docusaurus.config.ts index e5b9844..88346fc 100644 --- a/docusaurus.config.ts +++ b/docusaurus.config.ts @@ -99,6 +99,18 @@ const config: Config = { from: ['/docs/ourteam'], to: '/docs/community/ourteam', }, + { + from: ['/docs/configuration/preconfiguration'], + to: '/docs/installing/deprecated/preconfiguration', + }, + { + from: ['/docs/installing/windows_service'], + to: '/docs/installing/deprecated/windows_service', + }, + { + from: ['/docs/installing/linux_service'], + to: '/docs/installing/deprecated/linux_service', + }, ], } satisfies ClientRedirectsOptions, ], diff --git a/sidebars.ts b/sidebars.ts index cdbe5d7..6987c4b 100644 --- a/sidebars.ts +++ b/sidebars.ts @@ -14,8 +14,19 @@ import type {SidebarsConfig} from '@docusaurus/plugin-content-docs'; items: [ 'installing/monsterpi', 'installing/docker_compose', - 'installing/windows_service', - 'installing/linux_service', + { + type: 'category', + label: 'Deprecated', + link: { + type: 'doc', + id: 'installing/deprecated/index', + }, + items: [ + 'installing/deprecated/windows_service', + 'installing/deprecated/linux_service', + 'installing/deprecated/preconfiguration', + ], + }, ], }, { @@ -27,16 +38,57 @@ import type {SidebarsConfig} from '@docusaurus/plugin-content-docs'; }, collapsed: true, items: [ - 'configuration/preconfiguration', + 'configuration/first-time-setup', { type: 'category', - label: 'Settings', + label: 'Menu', link: { type: 'doc', - id: 'configuration/settings/index', + id: 'configuration/menu/index', }, items: [ - 'configuration/settings/grid_settings', + { + type: 'category', + label: 'Home', + link: { + type: 'doc', + id: 'configuration/menu/home/index', + }, + items: [ + ], + }, + { + type: 'category', + label: 'Printers', + link: { + type: 'doc', + id: 'configuration/menu/printers/index', + }, + items: [ + ], + }, + { + type: 'category', + label: 'Cameras', + link: { + type: 'doc', + id: 'configuration/menu/cameras/index', + }, + items: [ + ], + }, + { + type: 'category', + label: 'Settings', + link: { + type: 'doc', + id: 'configuration/menu/settings/index', + }, + items: [ + 'configuration/menu/settings/grid_settings', + ], + }, + ], }, 'configuration/moonraker', @@ -51,7 +103,7 @@ import type {SidebarsConfig} from '@docusaurus/plugin-content-docs'; type: 'doc', id: 'software_usage/index', }, - collapsed: false, + collapsed: true, items: [ 'software_usage/creating_printers', 'software_usage/organizing_floors', @@ -64,7 +116,7 @@ import type {SidebarsConfig} from '@docusaurus/plugin-content-docs'; type: 'doc', id: 'troubleshooting/index', }, - collapsed: false, + collapsed: true, items: [ 'troubleshooting/log_dump', 'troubleshooting/sentry', diff --git a/src/components/HomepageFeatures/index.tsx b/src/components/HomepageFeatures/index.tsx index 86ffbed..ad9f041 100644 --- a/src/components/HomepageFeatures/index.tsx +++ b/src/components/HomepageFeatures/index.tsx @@ -21,12 +21,11 @@ const FeatureList: FeatureItem[] = [ Svg: require("@site/static/img/docker-svgrepo-com.svg").default, description: ( <> - With docker you can be sure FDM Monster will run in isolation. For the - least hassle setup, you should give this a try! + With docker you can be sure FDM Monster will run in isolation. (easy) ), featureLink: { - description: "Read More!", + description: "Easy setup!", href: "/docs/installing/docker_compose", }, }, @@ -41,20 +40,39 @@ const FeatureList: FeatureItem[] = [ href: "/docs/installing/monsterpi", }, }, + { + title: "Enable moonraker/klipper support", + Svg: require("@site/static/img/klipper.svg").default, + description: ( + <>Connect FDM Monster with your klipper enabled printers. + ), + featureLink: { + description: "Read More!", + href: "/docs/configuration/moonraker", + }, + }, { title: "Powered by OctoPrint", Svg: require("@site/static/img/octoprint-tentacle.svg").default, description: ( - <> - Using OctoPrint, FDM Monster prevents single points of failures in your - farm! - + <>Using OctoPrint, FDM Monster prevents single points of failures in your farm! ), featureLink: { description: "Read More!", href: "https://octoprint.org/", }, }, + { + title: "Powered by Moonraker", + Svg: require("@site/static/img/fdm-monster-logo.svg").default, + description: ( + <>Moonraker enables FDM Monster to communicate with your Klipper device! + ), + featureLink: { + description: "Read More!", + href: "https://moonraker.readthedocs.io/", + }, + }, ]; function Feature({ Svg, title, description, featureLink }) { @@ -66,7 +84,9 @@ function Feature({ Svg, title, description, featureLink }) {

{title}

{description}

- +
+
+ {featureLink.description}
@@ -75,15 +95,20 @@ function Feature({ Svg, title, description, featureLink }) { } export default function HomepageFeatures() { + const firstRow = FeatureList.slice(0, 3); + const secondRow = FeatureList.slice(3); return ( -
-
-
- {FeatureList.map((props, idx) => ( +
+
+ {firstRow.map((props, idx) => ( - ))} -
+ ))}
-
+
+ {secondRow.map((props, idx) => ( + + ))} +
+ ); } diff --git a/static/img/klipper.svg b/static/img/klipper.svg new file mode 100644 index 0000000..c8125b8 --- /dev/null +++ b/static/img/klipper.svg @@ -0,0 +1,113 @@ + +image/svg+xml + + + + + + + \ No newline at end of file