A custom distribution based on Armbian for running OctoPrint for other Pi-like single board computers.
Credits of this project are for the awesome Armbian team and the outstanding work of @guysoft creating the custom distribution OctoPi . This port reuse most of OctoPi's code adapting it to the armbian build process and board specs and provide some helper sripts to simplify installation and maintance of the distribution.
If you like this project please consider contributing.
Core (installed and enabled):
- Optimized armbian Debian buster.
- Latest stable octoprint version.
- Selection of top octoprint plugins.
- HAProxy with self signed keys for ssl access.
- Avahi service: Bonjur addvertisement (this enable to acces with host-name.local via ssh or http/s)
- SSH console access.
- USB OTG console access (if available in the board)
- Enabled i2c-dev, spidev, uart (if available on the board)
3D printer related software:
- Quick install of Klipper.
- PlatformIo core for building 3D printer firmware.
- Marlin 1.1.x & Marlin 2.x.x firmware (bugfix versions)
Extras (installed but disabled):
- MPGStreamer USB camera support (experimental)
- SMB shares to remote edit configuration files from a remote PC.
Prebuilt images:
- Download & extract disk image (*.img.7z) from releases.
- Burn the image in a SD card (>8GB recommended) using usbimager,Etcher, Win32DiskImager, dd or the image burner of your choice.
- Plug the SD card on the board and apply power.
First boot tipically require a few minutes. Once booted octoprint will be available to use. If your computer is able to resolve mDns (macos or linux avahi) the name of the board is preconfigured as citrico-<board>.local
.
After boot you can access to octroprint server:
- Access to octoprint via https
- ssh session
- Console on Usb OTG (if the board supports it)
- Console on board's serial interface with a USB-TTL
- Conecting a keyboard and screen (if the board supports it)
Armbian do not activate WiFi by default. Any initial network access requires ethernet connection if available on the board or configuring wifi access using a keyboard and monitor.
octoCitrico create a two users:
root
with default passwordoctoroot
pi
with default passwordpi
. This user hassudo
rights.
It's recommended but not mandatory to change user passwords and disable root access via SSH.
As derivative distribution of OctoPi Octocitrico support camera operation out of the box using the same configuration files of OctPi. Any USB camera/webcams supported by debian in your single board computers and by MJPG-Streamer would work. Other cameras might require addtional software installation or configuration steps.
Refer to OctoPi documentation and online tutorials on how to tune your camera. You can edit camera options using scripts/citrico-config
helper tool.
Caveat: By default webcam streaming service is disabled, you need to enable it before is available for octoprint. it can be enabled by running
scripts/citrico-config
with thepi
user.
For configuring WiFi or customize your instance you need to log into you octocitrico server and configure as you want as in any linux computer. Armbian and octocitrico provides helper scripts to make easy the configuration of the box.
Login with the pi
user:
armbian-config
: Fullfleged configuraion tool.nmtui
: Network configuration.scripts/citrico-config
: Enable or disable octocitrico default services and edit octopi camera configuration.scripts/install-klipper
: Install Klipper 3D printer software.
For accessing files via SMB(windows shares) you need to enable Samba service (preconfigured) using scripts/citrico-config
. A default share pi-files
will be avaible using pi
user.
Adding boards to the project requires few steps:
- Create a folder with the name of the board inside
boards
directory. - Inside the new board directory create the a new file
config.conf
using as template the existing board. - Optionaly create
extra.sh
script to adjust specific board configuration.
PRs are wellcome with new boards support.
Building the distribution requires:
- Linux or MacOs
- Vagrant + Virtualbox
- +50Gb of free disk space.
- +4Gb RAM
$ git clone <this repository>
$ cd optocitrico
$ ./optocitrico.sh box
$ ./optocitrico.sh assets
$ ./optocitrico.sh build <board_name>
Build process is slow and verbose it could take up to 3h depending on your hardware. Be patient.
Building process could use a lot of space of your disk. To free this space after building you can execute ./optocitrico.sh clean
. This will clean all files used for the build including virtual machines and vagrant boxes.
- Orange Pi Zero 256 Mb (not recommended due to low memory)
- Orange Pi Zero 512 Mb
- Orange Pi PC
WIP:
- Orange Pi One
- Rock64
- Orange Pi PC+
- Banana PI M2 Zero
If you like this project and you want support it please consider:
- Send PRs are to fix bugs and add new boards.
- Test bords and provide feeback.
- Make a donation to Armbian, Octoprint & OctoPi projects.
- Make a donation to this project here: This will enable to buy boards for testing and to pay cloud infrastructure to improve the compilation process.