thetinkerdad/octofarm repository overview

⁠What is OctoFarm?

OctoFarm is an excellent project by James Mackay. The project is described by him as:

"OctoFarm is a easy to setup and install web interface that unifies your Octoprint instances for easy monitoring of all your printers. OctoFarm allows you to connect to multiple octoprint instances on your network allowing creating a farm management system. You can control, manage, upload files to any of your instances without ever leaving the tab it's open in. "

Any project source code other than the Dockerfile used for this repository is the property of James Mackay, not mine!

⁠Any source code, documentation?

Take a look at the Git repository⁠ and James' YouTube channel⁠ and also check out his website at https://blog.notexpectedyet.com⁠. Finally, there's a WiKi⁠ too.

⁠Dockerfile

It is available right here⁠.

⁠How to use this image?

The simplest solution is to use docker-compose:

version: '2'

services:
 octofarm:
   image: thetinkerdad/octofarm:latest
   container_name: octofarm
   environment:
     MONGOHOST: mongodb
     MONGOUSER: <db username>
     MONGOPASS: <db password>
   ports:
     - 4000:4000
   volumes:
     - ${PWD}/logs/additional/:/root/.npm/_logs/
   restart: always

You can also use this to change the port the tool is listening on.

⁠MongoDB backend

Starting with v1.1.1, OctoFarm uses a MongoDB backend, hence the needed settings. For now, the software (at least the Docker-based version) assumes the database "admin" to be in place. The fixed database name is a limitation of the Docker image and will be fixed later on. In case you install OctoFarm manually, outside a container, this limitation doesn't apply.

⁠Backward compatibility

OctoFarm v1.1.1 brings a plethora of changes, so the Docker image is not backwards compatible with previous versions. The MongoDB settings are mandatory and instead of relying on Nginx, it's now running on NodeJS.

⁠Any questions, help, etc?

• Regarding the Docker image, contact me at [email protected]⁠
• Regarding OctoFarm itself, contact James Mackay via Discord⁠