obico-server - Simplified Setup for an Open-Source AI 3D Printing Server

Introduction to Obico Server

The Obico Server is an open-source project that allows users to host their own smart 3D printing platform. Created by a vibrant community of enthusiasts, Obico provides an innovative and intelligent solution for 3D printing management through its AI-powered failure detection system. This detection system leverages Deep Learning models to ensure that makers, enthusiasts, and tinkerers worldwide can efficiently manage their 3D printing processes. To see how this model functions with actual data, users can explore the Obico app's public timelapse feature.

Installing and Running the Obico Server

Setting up an Obico Server doesn't require advanced hardware. In fact, any computer made in the last decade will suffice, although using an Nvidia GPU can enhance performance and allow the server to manage more printers at once.

Software Requirements

Before diving into installation, a few essential software components must be configured:

Docker and Docker-compose: These are necessary to run the server in a containerized environment. It is recommended to use Docker-compose version 2.0 or higher.
git: This version control system is used to clone the Obico Server's code repository.

Additionally, a legitimate email account with SMTP access is required for the server’s communication features.

Step-by-Step Installation

Clone the Repository:

git clone -b release https://github.com/TheSpaghettiDetective/obico-server.git

Start the Server: Depending on the operating system:
- On Linux:
```
cd obico-server && sudo docker compose up -d
```
- On Mac:
```
cd obico-server && docker-compose up -d
```
- On Windows:
```
cd obico-server; docker-compose up -d
```
Grab a cup of coffee while the setup completes, taking approximately 15-30 minutes.

Access the server via "http://localhost:3334" to ensure everything is running smoothly.

Configuring the Obico Server

Upon installation, configuration is necessary to make the Obico Server fully functional beyond the local setup:

Obtain the Server's IP Address

Users need to determine the LAN IP address of the computer on which Obico is hosted. This step ensures compatibility with other components like OctoPrint. Using a static IP address is advisable to prevent connectivity issues when IPs change.

Login as Django Admin

To access the admin panel:

Navigate to http://your_server_ip:3334/admin/.
Log in with the credentials: username [email protected] and password supersecret. Users should change the admin password for security purposes.

Configure the Django Site

Head to the Django site settings page (http://your_server_ip:3334/admin/sites/site/1/change/) to change the "Domain name" field to match the server’s IP address and port.

Connecting Clients to the Obico Server

For an integrated 3D printing experience, use the Obico for OctoPrint plugin and the Obico mobile app. Detailed configuration instructions for these clients are available to ensure seamless connectivity with the self-hosted server.

Contributing to the Community

The project thrives on community engagement, and contributions are welcomed. Interested individuals can consult the contribution guidelines to get involved.

Should users face any challenges in setting up or running their Obico Server, they can refer to the Obico Server guide or seek assistance via the community Discord or GitHub issue tracker.

Acknowledgments

Obico extends its gratitude to BrowserStack for providing testing resources and to Moonraker for their contributions to g-code metadata handling.