Docs (#57)

docs/automation.md

@@ -39,9 +39,10 @@ You can also use cron jobs for scheduling backups.
 1. Edit the crontab file using:
 ```
 crontab -e
-```
-!!! info
-    if it's your first time running the command you will be asked which editor you would like to use, nano is the easiest  
+```  
+
+    !!! info
+        if it's your first time running the command you will be asked which editor you would like to use, nano is the easiest  
 
 2. Once the editor is open, at the very bottom of the file add the line:
 ```

docs/configuration.md

@@ -5,7 +5,13 @@ Now you need your [GitHub token](installation.md#create-github-token).
 2. Copy the new token into the `.env` file at `github_token`
 3. Add your username in `github_username`
 4. Change the `github_repository` to your backup repository name in GitHub (which was called `repository-name`)
-5. The parameter `commit_username=""` and `commit_email=""` are optional. 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
+#### 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. `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)  
 
 Adjust the remaining paths in the `.env` file where your files are located, or add even more file. All files defined here (**note the pattern!** It must start with `path_` followed by the path) are considered in the backup. I am using the default paths. You can also comment out content inside the `.env` file with `#`, for example this here will use `path_klipperdata` but ignores `path_macroscfg`:
 ```ini