Configuration Overrides
The /usr/data/pellcorp-overrides stores custom cfg and conf files as well as customisations you have made to some of the core config files such as printer.cfg.
The following core config files can have overrides saved for them, please note that except for printer.cfg, fan_control.cfg and moonraker.conf no config files support adding and deleting sections, no support is provided to edit gcode_macro gcode values. Except for printer.cfg, fan_control.cfg and moonraker.conf you also cannot add or delete values from existing sections, only change existing values.
- printer.cfg
- sensorless.cfg
- bltouch-k1.cfg
- bltouch-k1m.cfg
- microprobe-k1.cfg
- microprobe-k1m.cfg
- cartographer.cfg
- cartographer.conf
- cartographer-k1.cfg
- cartographer-k1m.cfg
- btteddy.cfg
- btteddy-k1.cfg
- btteddy-k1m.cfg
- beacon.conf
- beacon.cfg
- beacon-k1.cfg
- beacon-k1m.cfg
- KAMP_Settings.cfg
- moonraker.conf
- start_end.cfg
- useful_macros.cfg
- fan_control.cfg
IMPORTANT: You should run the CONFIG_OVERRIDES macro every time you make any changes to either your own custom cfg or conf files, or make changes to any core config files. There is no process monitoring your config directory for changes, this is Simple AF after all, and automatically doing stuff is not simple af!
Note: The first step in both a /usr/data/pellcorp/k1/installer.sh --update or /usr/data/pellcorp/k1/installer.sh --reinstall is to backup your config-overrides, so that they can be reapplied, but they will be lost if you do a factory reset.
If the /usr/data/pellcorp-overrides is a git repo, calling the CONFIG_OVERRIDES or /usr/data/pellcorp/k1/config-overrides.sh will generate a new git commit and push it to origin if any files are changed.
Create a new pellcorp-overrides repository on your github account:
Note: You don't actually have to call it pellcorp-overrides, you can call it whatever you want, but it should be a repository dedicated to just doing backups for this project. Currently config-overrides.sh --repo only supports a single configuration, hopefully soon I will add the ability to specify a branch so you can store multiple configurations in the same repository.
Important: Set your new repository to be private unless you want to share settings with everyone else, or potentially sensitive information in the moonraker.conf, notifier.conf, etc. Be really careful with using github keys in moonraker.conf update manager too, as these will be version controlled. If possible put all your secrets in moonraker.secrets which is not saved to version control.
Click here to create a fine grained personal access token. Create a fine grained token and limit its access to just your pellcorp-overrides repository. Make sure that Contents read and write access.
Make sure you limit it to just the new repository you created:
Source: https://guilouz.github.io/Creality-Helper-Script-Wiki/helper-script/git-backup/
You will need 3 pieces of information for this process to succeed:
- Your github username
- Your email address
- The github token you just created
Ssh into your k1 and run the following:
export GITHUB_USERNAME=myusername
export [email protected]
export GITHUB_TOKEN="The token I just created"
export GITHUB_REPO=pellcorp-overrides
/usr/data/pellcorp/k1/config-overrides.sh --repo
If you want to setup the repository locally ignoring any local files in /usr/data/pellcorp-overrides, you can use the --clean-repo argument, instead of the --repo argument, which will rebase the local changes on top of the repo.
Note: The moonraker.secrets file is not versioned controlled.
This most likely means your personal access token is misconfigured, deleted, or expired