Installation on Creality

It is possible to use OctoApp with Creality printers running "Creality OS", this generally includes:

• K1/K2 family
• Ender V3 and Ender V3 KE (not SE)
• Creality CR10 SE
• Any Creality printer with the Nebula Pad

Tip

If you experience stability issues with your prints on your K1 or K2 printer, you might run too many additional things on the machine. Consider running OctoApp and/or OctoEverywhere on an external Raspberry Pi.

1. Enable Root Access

K1/K2 machines

• Make sure you have the latest firmware installed
• On your screen select the "gear" icon on the bottom tab bar
• Select "Root account information"
• Carefully read the disclaimer and continue
• Note down the credentials, usually it's username root and password creality_2023

Alternatively, follow this guide to enable root access for your Creality K1:
https://guilouz.github.io/Creality-K1-Series/firmwares/install-and-update-rooted-firmware/#enable-root-access

Ender V3 / Ender V3 KE

• Make sure you have the latest firmware installed
• On your screen select the "gear" icon on the bottom tab bar
• Select "Root account information"
• Carefully read the disclaimer and continue
• Note down the credentials, usually it's username root and password creality_2023

CR 10-SE

Please install the pre-rooted firmware following this video guide:
https://www.youtube.com/watch?v=YCxHfN7lI00

Creality might release a firmware with root access in the future, please make sure to research the latest approach.

Nebula Pad

Please install the pre-rooted firmware following this video guide:
https://www.youtube.com/watch?v=cQAKxl-rnOE

The firmware for the Nebula Pad can be found here.

Creality might release a firmware with root access in the future, please make sure to research the latest approach.

2. Connect via SSH

You need to connect to your printer via SSH to install the OctoApp plugin. Follow this guide:
https://guilouz.github.io/Creality-K1-Series/firmwares/ssh-connection/

3. Install K1 Helper Script

Basically you only need to run this command via SSH, but see here for full instructions and trouble shooting.

git clone https://github.com/Guilouz/Creality-Helper-Script.git /usr/data/helper-script

4. Install OctoApp

Now that the K1 Helper Script is up and running, perform following steps:

• Run sh /usr/data/helper-script/helper.sh via SSH
  

• Type 1 and then press enter to open the install menu
  

• Type the number corresponding to "OctoApp" and press enter

• The installation will now start

• You might be ask to install additional components first, please do so

5. Connect the app

Well, not much to do! Next time you use OctoApp the app will register with the plugin automatically and will receive notifications moving forward. If the app doesn't connect to the plugin for 14 days, the plugin will automatically remove the app...until the app registers itself again automatically.

---

Appendix: Manual installation

If you do not want to use the Helper Script, complete step 1 and 2, then run the following:

• cd /usr/data
• git clone https://github.com/crysxd/OctoApp-Plugin octoapp
• cd octoapp
• ./install.sh <-- sh ./install.sh results in file not found, ./install.sh works