Skip to content

Commit

Permalink
add allow_empty_commits parameter in configuration.md
Browse files Browse the repository at this point in the history
allow_empty_commits=${allow_empty_commits:-true}
  • Loading branch information
Staubgeborener authored May 5, 2024
1 parent 9fbf31d commit 077bb18
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Now you need your [GitHub token](installation.md#create-github-token).
#### Optional Paramaters
1. `commit_username=""` You can change the commit username for the commit history here, for example `commit_username="backup user"`, if it is left empty, the script will use `whoami` for the current user.
2. `commit_email=""` You can change the commit email for the commit history here, if it is left empty the script will use `whoami@hostname --long-unique_id`. The unique_id is generated by hashing the unique mac address of the system.
3. `empty_commit=""` You can choose whether you want to push empty commits or not (this serves to permanently check whether the service is running correctly in the background), for example `empty_commit="no"`. The value can be `yes` or `no` (default value if nothing is defined: `yes`).
3. `allow_empty_commits=""` You can choose whether you want to push empty commits or not (this serves to permanently check whether the service is running correctly in the background), for example `allow_empty_commits="false"`. The value can be `true` or `false` (default value if nothing is defined: `true`).
4. `git_protocol=""` You can use the values `http` or `https` here (default value: `https`). This enables, for example, the local use of git if `https` is not supported.
5. `git_host=""`. If you are using a different host ex.) gitea, bitbucket, devops, etc... you can add `git_host=""` to `.env`, for example `git_host="bitbucket.org"`. Be sure to read the requirements for how to push changes to your host ex.) bitbucket requires a specific commit email and token format to push commits.

Expand Down Expand Up @@ -82,4 +82,4 @@ A small `nano` YouTube tutorial can be found [here](https://youtu.be/mE2YghYpBBE

If you have installed klipper-backup with the `install.sh` script, you should be finished with everything at this point. **Reminder**: You can install features at anytime automatically by running `install.sh` again, so there is no need to do it manually!

In case you want to do it manually for some reason: Next: [The update section](updating.md)
In case you want to do it manually for some reason: Next: [The update section](updating.md)

0 comments on commit 077bb18

Please sign in to comment.