Skip to content

Commit

Permalink
Update configuration.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Staubgeborener authored Nov 20, 2024
1 parent 928fc4e commit 3b854ad
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,9 +45,10 @@ You can use the values `http`, `https` or `ssh` here (default value: `https`). T
### 5. git_host
If you are using a different host ex.) gitea, bitbucket, devops, etc... you can add `git_host` with the corresponding entity 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. If you have deployed the git instance locally and assigned a port, you can also pass it directly here, for example `gitea:222`. 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"}.

| Parameter | Possible values | Default value | Example |
| -----------| ----------------------------------|-----------------|----------------------- |
| `git_host` | `gitea`, `bitbucket`, `devops`, * | `github.com` | `git_host="gitea:222"` |
| Parameter | Possible values | Default value | Example |
| -----------| ----------------------------------|-----------------|--------------------------- |
| `git_host` | `gitea`, `bitbucket`, `devops`, * | `github.com` | `git_host="bitbucket.com` |
| | | | `git_host="localhost:222"` |

### 6. ssh_user
If you want to push the backup via ssh and have assigned an individual ssh user, you can adjust it here. This is particularly relevant if you have deployed a git instance locally.
Expand Down

0 comments on commit 3b854ad

Please sign in to comment.