Skip to content

Commit

Permalink
update manual linking process for klipper
Browse files Browse the repository at this point in the history
  • Loading branch information
kennethjiang committed Oct 14, 2023
1 parent 63950bb commit e7699d3
Show file tree
Hide file tree
Showing 6 changed files with 18 additions and 54 deletions.
2 changes: 1 addition & 1 deletion backend/app/templates/account/login.html
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ <h5 class="modal-title" id="exampleModalLongTitle">{% trans "Having trouble?" %}
<div class="modal-body text-left">
<ul>
<li>Your sign-in credential is the same for the mobile app and the web app. If you previously signed up using the mobile app, you can use the same to sign in here.</li>
<li>"Sign in with Apple" is not available in the web app. If you want to use the web app, please sign up for a different account and <a class="link" target="_blank" href="https://www.obico.io/docs/user-guides/relink-octoprint/">re-link OctoPrint</a>.</li>
<li>"Sign in with Apple" is not available in the web app. If you want to use the web app, please sign up for a different account and <a class="link" target="_blank" href="https://www.obico.io/docs/user-guides/relink-printer/">re-link your printer</a>.</li>
<li>Even if you previously signed up an account using Google or Facebook, you can still <a class="link" href="{% url 'account_reset_password' %}">{% trans "reset password" %}</a> using the same email address.</li>
<li class="text-warning">If you can't sign in the mobile app, re-install the mobile app and try it again.</li>
<li><a class="link" href="mailto:[email protected]">Contact us</a> if you have tried everything else.</li>
Expand Down
35 changes: 10 additions & 25 deletions website/docs/user-guides/klipper-setup-manual-link.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,16 @@ description: For Klipper/Moonraker/Mainsail/Fluidd users
sidebar_label: Manually Link Klipper
---

Follow this guide in one of these 2 rare cases:

* You are trying to re-link your Klipper printer. There are only [a few reasons](/docs/user-guides/relink-printer/) why you need to re-link printer.
* Your printer can't be identified at the last step in [Obico for Klipper setup guide](/docs/user-guides/klipper-setup/). You don't need a 6-digit code if your printer can be identified and linked automatically.

:::caution
If you are setting up Obico for the first time, you should follow [Obico for Klipper setup guide](/docs/user-guides/klipper-setup) first. **Please DO NOT PROCEED** if you haven't done so.
:::


import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

Expand All @@ -15,14 +25,6 @@ import TabItem from '@theme/TabItem';
This guide assumes you are connecting to the [Obico Cloud](https://app.obico.io). If you are connecting to a [self-hosted Obico Server](/docs/server-guides/), you will need to use the address of your self-hosted server.
:::

## Hardware requirements {#hardware-requirements}

Before you start, make sure:

- You have the Klipper and Moonraker set up correctly and connected to your printer. Also a user interface such as Mainsail/Fluidd is highly recommended.
- A webcam is set up for your printer and connected to Mainsail/Fluidd/Moonraker.
- There is sufficient lighting to illuminate the printing area of your printer. If your printer is in a lighted room, you are probably fine. If you'll print with light off, you will need to make sure the printing area is illuminated when your printer is printing. A LED strip or small LED lamp will do the trick.


## Step 1: Download Obico for Klipper and run `install.sh` {#step-1-download-obico-for-klipper-and-run-installsh}

Expand Down Expand Up @@ -170,20 +172,3 @@ Hooray! You are done! You can now close the terminal. Obico for Klipper is now r
## Step 6 (optional): Give your printer a shiny name! {#step-6-optional-give-your-printer-a-shiny-name}

Optionally, you can now give your printer a name. If you skip this step, your printer will have the default name "*My Awesome Cloud Printer*".

## What's next? {#whats-next}

### Check out your printer feed! {#check-out-your-printer-feed}

Press "Go Check Out Printer Feed!" to see everything you care about your printer: the webcam feed, heater temperature, time remaining on the print job, and more! Remember, you can see your printer feed anywhere you go, as long as you have an internet connection on your phone!

### Test the magical failure detection! {#test-the-magical-failure-detection}

The Detective sounds too magical to be true? [See The Detective in action for yourself](/docs/user-guides/how-to-test-failure-detection).

### Change printer settings. {#change-printer-settings}

The default settings for your printer in The Spaghetti Detective are the ones that most users find the most reasonable. But feel free to tweak them to your liking:

- [Change notification settings](/docs/user-guides/notification-settings) (mobile app only). By default you receive push notifications when The Detective finds something fishy, and for the status of whatever your printer is printing. But you can choose to receive a lot more.
- [Change printer settings](/docs/user-guides/detection-print-job-settings), such as if The Detective should pause your printer when a failure is detected.
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_label: Manually Link OctoPrint

Follow this guide in one of these 2 rare cases:

* You are trying to re-link OctoPrint. There are only [a few reasons](/docs/user-guides/relink-octoprint/) why you need to re-link OctoPrint.
* You are trying to re-link OctoPrint. There are only [a few reasons](/docs/user-guides/relink-printer/) why you need to re-link OctoPrint.
* Your OctoPrint can't be identified at the last step in [Obico for OctoPrint setup guide](/docs/user-guides/octoprint-plugin-setup/). You don't need a 6-digit code if your OctoPrint can be identified and linked automatically.

:::caution
Expand Down
21 changes: 0 additions & 21 deletions website/docs/user-guides/relink-octoprint.md

This file was deleted.

10 changes: 5 additions & 5 deletions website/docs/user-guides/relink-printer.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,14 @@ Consider re-linking in one of the following cases:

## How to re-link? {#how-to-re-link}

### Obico for OctoPrint

Follow [this guide](/docs/user-guides/octoprint-plugin-setup-manual-link/) to re-link OctoPrint-based printer.

:::note
Your printer can't be automatically identified during the re-linking process. 6-digit code is required to re-link your printer.
:::

### Obico for OctoPrint

Follow [this guide](/docs/user-guides/octoprint-plugin-setup-manual-link/) to re-link OctoPrint-based printer.

### Obico for Klipper

Follow [this guide](/docs/user-guides/relink-klipper/) to re-link Klipper-based printer.
Follow [this guide](/docs/user-guides/klipper-setup-manual-link/) to re-link Klipper-based printer.
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@ You will see this error in one of the following situations:
* The token for your printer to authenticate with the Obico server is somehow leaked and being used by other people. This is a serious security hazard as anyone who has your authentication token will also have a full control of your printer.
* You duplicated the content of your original SD card to another one. This hence causes the same authentication token to be shared across both printers. There is no security risk in this situation, assuming both SD cards are still in your possession. However, both printers will talk over each other and confuses the Obico server on everything from the status of the printer to the failure detection, hence rendering the app useless.

When you see this error, please immediately [re-link **all of your printers**](/docs/user-guides/relink-octoprint/) to the Obico server. This will refresh authentication tokens for all of them, and hence eliminate any potential security risks.
When you see this error, please immediately [re-link **all of your printers**](/docs/user-guides/relink-printer/) to the Obico server. This will refresh authentication tokens for all of them, and hence eliminate any potential security risks.

0 comments on commit e7699d3

Please sign in to comment.