As an Amazon Associate this site earns from qualifying purchases.

Root Access Quick Start Guide

Published

This opens the door to new upgrades, tuning, backup and monitoring possibilities. Common use cases: Controlling your printer via the full-featured fluidd interface, reading klipper logs for troubleshooting, bed leveling.

Search

Root is not a program, firmware or action. It is a user account which has the highest level of access to the underlying Linux-based operating system on your printers on-board computer. Logging into your printer as the root user gives you the power to view and change the printer's files and settings, install new software and more - just like a Windows or Mac computer.

The most common reasons to gain root access are backing up your klipper config (yes, the factory firmware is a fork of klipper), reading the klipper error logs which give more information than the on-screen messages, installing upgrades which require config changes, installing a better web interface like fluidd or mainsail for better control and tuning and swapping to a third party firmware like SimpleAF which simplifies the installation of aftermarket probes.

Enabling root access does NOT change anything unless YOU make changes. If you are worried about "breaking something", simply back up your files before changing them. This way, you can always restore the last known good settings.
Important: Do NOT update the firmware or factory reset - neither before nor after gaining root access! This can overwrite any changes you make with settings that don't match your hardware and introduce bugs.
Gaining root access gives you the ability to back up your configuration files. Once you have created a backup, feel free to experiment with updates at your own risk (NOT recommended)
Skip this section if you have a CFS-C or 2025+ printer
1.

On the printer screen, tap Settings → Root account information

2.

Read the disclaimer, wait 30 seconds and check the agreement box.

3.

Press OK twice

1.

On the printer screen, tap Settings → Network

2.

Tap Wi-Fi or Ethernet (whichever connection you're using)

3.

Take a photo of your printers IP address or write it down

An IP address typically looks like 192.168.1.101
1.

Windows: Download and install MobaXterm
Mac: Press Command+Space and type terminal

2.

Windows: Launch MobaXterm and click Session -> SSH on the top left

3.

Windows: Enter your printer's IP address in the Remote Host field (for example 192.168.1.103)
Mac: type ssh root@[printer ip address] for example ssh root@192.168.1.123

4.

Windows: Tick the Specify username box and type root as the username.

5.

Windows: Click OK and enter creality_2023 for the password.

Mac: Type creality_2023 for the password.

For security reasons, the password won't display while typing.
6.

Windows: Authorize any popup windows and ignore password change prompts

You have successfully gained root accesss!

No changes have been made to the printer, but you now have the ability to see under the hood and make changes.

Most likely, you have gained root access as a prerequisite for installing an upgrade.

The upgrade will have instructions for you to change the printer.cfg file or copy and paste a command using MobaXterm:

Windows: Mobaxterm Interface:

Left panel: This is where you browse through the printers files and edit them (usr/data/printer_data/config/printer.cfg)
Right panel: This is where you paste linux commands (eg. installing and running the helper script)

Running the helper script is a quick and easy way to install the most commonly used software such as the Fluidd interface for controlling and monitoring the printer remotely, useful macros, and screws_tilt_calculate for bed level knobs.

1.

Windows: Copy and paste the following command into the right panel of MobaXterm to install the helper script:

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

2.

Windows: Copy and paste the following command into the right panel of MobaXterm to install the helper script:
Mac: Copy and paste the following command into the terminal to install the helper script:

git clone --depth 1 https://github.com/Guilouz/Creality-Helper-Script.git /usr/data/helper-script 2>/dev/null || true && sh /usr/data/helper-script/helper.sh

If you have a CFS, you need to patch the files that Creality broke. Click here to do it manually. Alternatively, you can use the easy, automatic 1-click script here by donating to support the site.
Click here to learn more about the helper script

Discussion