Skip to content

Commit

Permalink
(docs) new and updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mkevenaar committed Dec 7, 2024
1 parent ce61af6 commit 77d34b6
Show file tree
Hide file tree
Showing 25 changed files with 382 additions and 44 deletions.
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
55 changes: 55 additions & 0 deletions docs/configuration/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: /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)
Binary file added docs/configuration/images/fts-login.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/configuration/images/fts-step1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/configuration/images/fts-step2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/configuration/images/fts-step3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/configuration/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
6 changes: 6 additions & 0 deletions docs/configuration/menu/cameras/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Cameras
description: FDM Monster Cameras
slug: /configuration/menu/cameras
---

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
13 changes: 13 additions & 0 deletions docs/configuration/menu/home/index.mdx
Original file line number Diff line number Diff line change
@@ -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.
:::
18 changes: 18 additions & 0 deletions docs/configuration/menu/index.mdx
Original file line number Diff line number Diff line change
@@ -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

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

<DocCardList />
``` -->
6 changes: 6 additions & 0 deletions docs/configuration/menu/printers/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Printers
description: FDM Monster Printers
slug: /configuration/menu/printers
---

Empty file.
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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)
Original file line number Diff line number Diff line change
@@ -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

Expand Down
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: configuration/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.
1 change: 1 addition & 0 deletions docs/installing/docker_compose.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
---

Expand Down
1 change: 1 addition & 0 deletions docs/installing/monsterpi.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
---

Expand Down
12 changes: 12 additions & 0 deletions docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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,
],
Expand Down
Loading

0 comments on commit 77d34b6

Please sign in to comment.