diff --git a/docs/configuration.md b/docs/configuration.md index 186497c..3986aa9 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -13,22 +13,42 @@ Now you need your [GitHub token](installation.md#create-github-token). This shou #### 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` output for the current user. -| Parameter | Possible values | Example -| ----------------- | --------------- |--------------------------------- | -| `commit_username` | *anything* | `commit_username="backup user""` | +| Parameter | Possible values | Default value | Example | +| ----------------- | --------------- |-----------------|-------------------------------- | +| `commit_username` | *anything* | `whoami` output | `commit_username="backup 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. +| Parameter | Possible values | Default value | Example | +| -------------- | --------------- |------------------------------------------ | -------------------------------- | +| `commit_email` | *anything* | `whoami@hostname --long-unique_id` output | `commit_email="backup@hostname"` | + #### 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`). +| Parameter | Possible values | Default value | Example | +| ------------------------ | --------------- |--------------------------------------------- | +| `allow_empty_commits=""` | `true` | `false` | `allow_empty_commits="false` | +| | `false` | | | + #### 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. +You can use the values `http`, `https` or `ssh` here (default value: `https`). This enables, for example, the local use of git if `https` is not supported. + +| Parameter | Possible values | Default value | Example | +| -------------- | ----------------|---------------|--------------------- | +| `git_protocol` | `http` | `https` | `git_protocol="http` | +| | `https` | | | +| | `ssh ` | | | #### 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. - + +| Parameter | Possible values | Default value | Example | +| -----------| ----------------------------------|---------------|------------------------------ | +| `git_host` | `gitea`, `bitbucket`, `devops`, * | github.com | `git_protocol="bitbucket.org` | +* *List is not complete, there are numerous other (unknown) supported hosters* + !!! 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){:target="_blank"} or [feature request](https://github.com/Staubgeborener/klipper-backup/issues/new?assignees=&labels=feature+request&projects=&template=feature_request.yml){:target="_blank"}