Skip to content

Latest commit

 

History

History
151 lines (85 loc) · 7.63 KB

README.md

File metadata and controls

151 lines (85 loc) · 7.63 KB
Raw

TheSpaghettiDetective

This repo is everything you need to run a server for The Spaghetti Detective, the coolest, AI-based solution for 3D printer remote management and monitoring.

The core of this project is based on a Deep Learning model. See how the model works on real data.

Install and run the server

If you are on Windows 10 and prefer a video tutorial, head to LukesLaboratory's awesome video (Big shout-out to @LukesLaboratory).

If you are on Windows Server, follow this Windows Server-specific guide instead.

If you otherwise prefer textual instructions, follow the steps below.

Prerequisites

Hardware minimum spec

The Spaghetti Detective server needs to run on a real computer (Not a Pi, unfortunately. Raspberry Pi, or Latte Panda, is just not powerful enough to run the Machine Learning model). If you have an old PC with at least 2GB of memory, you will be probably be fine.

Software requirements

The following software is required before you start installing the server:

  • Docker and Docker-compose. But you don't have to understand how Docker or Docker-compose works.

    • Install Docker (Windows, Ubuntu, Mac). Important: If your server has an old Docker version, please follow the instructions in these links to upgrade to the latest version, otherwise you may run into all kinds of weird problems.
    • Install Docker-compose. You need Docker-compose 1.21.0 or higher version.
    • (Windows only) Make sure "Shared Drives" is checked in Docker settings

  • git (how to install).

Email delivery

You will also need an email account that has SMTP access enabled. For a gmail account, this is how you enable SMTP access. Other web mail such as Yahoo should also work but we haven't tried them.

Get the code and start the server.

  1. Get the code:
git clone https://github.com/TheSpaghettiDetective/TheSpaghettiDetective.git

  1. Run it! Do either one of these based on what OS you are using:

    • If you are on Linux: cd TheSpaghettiDetective && sudo docker-compose up -d
    • If you are on Mac: cd TheSpaghettiDetective && docker-compose up -d
    • If you are on Windows: cd TheSpaghettiDetective; docker-compose up -d

  2. Go grab a coffee. Step 2 will take 15-30 minutes.

  3. There is no step 4. This is how easy it is to get The Spaghetti Detective up and running (thanks to Docker and Docker-compose).

Basic server configuration

This is the bare minimum configuration required for the server to be functional.

Obtain server's IP address

The Spaghetti Detective server needs to have an IP address that is accessible by OctoPrint. It can be an private IP address (192.168.x.y, etc) but there needs to be a route between OctoPrint and The Spaghetti Detective server.

Port/Firewall

The Spaghetti Detective server listens on port 3334 (will be configurable in later version). Please make sure this port is not blocked from OctoPrint.

You can set up a reverse-proxy, such as nginx, in front of The Spaghetti Detective server, so that it's exposed on a different port. In this case, please use whichever port you choose to expose in the steps below. For simplicity sake, this document assumes the server port is 3334.

Login as Django admin

  1. Open Django admin page at http://your_server_ip:3334/admin/.

  2. Login with username [email protected], password supersecret. Once logged in, you can optionally (but highly encouraged to) change the admin password using this link: http://your_server_ip:3334/admin/app/user/1/password/.

Configure Django site

  1. On Django admin page, click "Sites", and click the only entry "example.com" to bring up the site you need to configure. Change "Domain name" to your_server_ip:3334. No "http://", "https://" prefix or trailing "/", otherwise it will NOT work.

  2. Click "Save". Yes it's correct that Django is not as smart as most people think. ;)

Site configuration

Note: If you are using reverse proxy, "Domain name" needs to be set to reverse_proxy_ip:reverse_proxy_port. See using a reverse proxy for details.

Configure Email server (SMTP)

The following is using gmail as an example. Other web mail services may vary slightly, such as EMAIL_PORT

  1. In TheSpaghettiDetective directory, find and open docker-compose.yml using your favorite editor.

  2. Find the following lines, and set them to the correct values of your email account:

      EMAIL_HOST:     # -> such as smtp.gmail.com
      EMAIL_HOST_USER:   # -> such as your email address for a Gmail account
      EMAIL_HOST_PASSWORD:    # -> your email account password
      EMAIL_PORT: 587
      EMAIL_USE_TLS: 'True'

If you run into issues with Email server settings, please follow this Email server trouble-shooting guide.

Done!

That's it! You now have a fully-functional The Spaghetti Detective server that your OctoPrint can talk to. We hope setting up the server has not been overwhelming.

Configure The Spaghetti Detective OctoPrint Plugin to use your own server

Before you can configure The Spaghetti Detective OctoPrint Plugin to use your own server, you need add a printer to The Spaghetti Detective server you just built and obtain the secret token for that. To do so:

  1. Pointing your browser to http://your_server_ip:3334.

  2. Log in as a user (you can just login with [email protected] but it's more secure to use a non-admin user). Add a new printer as described in this guide and obtain the secret token.

Then, on The Spaghetti Detective plugin settings page:

  1. Check the box "I have my own TSD server. Don't check this unless you know what you are doing."

  2. Enter http://your_server_ip:3334.

  3. Enter the secret token you copied from the previous step.

  4. Click "Save". OctoPrint isn't necessarily smarter than Django after all.

Site configuration

Advanced server configuration

Feeling adventurous? Go advanced.

Operating and maintaining The Spaghetti Detective server

Upgrade server

git pull
sudo docker-compose up --build -d

Backup database

Just make a copy of TheSpaghettiDetective/web/db.sqlite

How to train your own Machine Learning model (TBD)

Difficulties at getting The Spaghetti Detective server up and running?

Check out the FAQ document. If you can't find the answer there, open an issue.

Thanks

BrowserStack BrowserStack generously sponsors a free license so that I can test TSD webcam streaming on different browsers/versions.