diff --git a/docs/configuration.md b/docs/configuration.md index 57b133b..2f8d32d 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -9,8 +9,8 @@ Now you need your [GitHub token](installation.md#create-github-token). 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`). -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. +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. !!! warning "Important Note" When using a host other than github.com you may run into errors or issues that we cannot currently support. If you do find a resolution feel free to create a [pull request](https://github.com/Staubgeborener/klipper-backup/pulls) or [feature request](https://github.com/Staubgeborener/klipper-backup/issues/new?assignees=&labels=feature+request&projects=&template=feature_request.yml)