diff --git a/README.md b/README.md index b5ba9dd..cf26bed 100644 --- a/README.md +++ b/README.md @@ -79,6 +79,12 @@ Configuration for each clone can be set in two ways. The first is in `$HOME/.con 1. Update `GHORG_SCM_TYPE` to `gitlab` in your `ghorg/conf.yaml` or via cli flags 1. See [examples/gitlab.md](https://github.com/gabrie30/ghorg/blob/master/examples/gitlab.md) on how to run +### gitea setup + +1. Create [Access Token](https://docs.gitea.io/en-us/api-usage/) (Settings -> Applications -> Generate Token) +1. Update `GHORG_GITEA_TOKEN` in your `ghorg/conf.yaml` or use the (--token, -t) flag. +1. Update `GHORG_SCM_TYPE` to `gitea` in your `ghorg/conf.yaml` or via cli flags + ### bitbucket setup 1. To configure with bitbucket you will need to create a new [app password](https://confluence.atlassian.com/bitbucket/app-passwords-828781300.html) and update your `$HOME/.config/ghorg/conf.yaml` [here](https://github.com/gabrie30/ghorg/blob/master/sample-conf.yaml#L37-L47) or use the (--token, -t) and (--bitbucket-username) flags. @@ -96,7 +102,7 @@ $ security find-internet-password -s gitlab.com | grep "acct" | awk -F\" '{ pri > It's recommended to store github/gitlab tokens in the osxkeychain, if this command returns anything other than your token see Troubleshooting section below. However, you can always add your token to the $HOME/.config/ghorg/conf.yaml or use the (--token, -t) flags. ## Ignoring Repos -- To ignore any archived repos while cloning use the `--skip-archived` flag (github/gitlab only) +- To ignore any archived repos while cloning use the `--skip-archived` flag (not bitbucket) - To ignore specific repos create a `ghorgignore` file inside `$HOME/.config/ghorg`. Each line in this file is considered a substring and will be compared against each repos clone url. If the clone url contains a substring in the `ghorgignore` it will be excluded from cloning. To prevent accidentally excluding a repo, you should make each line as specific as possible, eg. `https://github.com/gabrie30/ghorg.git` or `git@github.com:gabrie30/ghorg.git` depending on how you clone. ```bash diff --git a/sample-conf.yaml b/sample-conf.yaml index 7cc8297..f58f57d 100644 --- a/sample-conf.yaml +++ b/sample-conf.yaml @@ -25,6 +25,16 @@ GHORG_GITLAB_TOKEN: GHORG_PRESERVE_DIRECTORY_STRUCTURE: +# +-+-+-+-+-+ +-+-+-+-+-+-+-+-+ +# |G|I|T|E|A| |S|P|E|C|I|F|I|C| +# +-+-+-+-+-+ +-+-+-+-+-+-+-+-+ + +# Add your Gitea token +# Settings -> Applications -> Generate Token +# flag (--token, -t) eg: --token=bGVhdmUgYSBjb21tZW50IG9uIGlzc3VlIDY2 +GHORG_GITEA_TOKEN: + + # +-+-+-+-+-+-+-+-+-+ +-+-+-+-+-+-+-+-+ # |B|I|T|B|U|C|K|E|T| |S|P|E|C|I|F|I|C| # +-+-+-+-+-+-+-+-+-+ +-+-+-+-+-+-+-+-+ @@ -42,12 +52,12 @@ GHORG_BITBUCKET_USERNAME: # |G|E|N|E|R|A|L| |C|O|N|F|I|G|U|R|A|T|I|O|N| # +-+-+-+-+-+-+-+ +-+-+-+-+-+-+-+-+-+-+-+-+-+ -# Change SCM base url, for on self hosted instances (currently gitlab only, use format of https://git.mydomain.com/api/v3) +# Change SCM base url, for on self hosted instances (for gitlab, use format of https://git.mydomain.com/api/v3), gitea require this # default: uses github/gitlab public api # flag (--base-url) GHORG_SCM_BASE_URL: -# Which provider to clone from (github, gitlab, or bitbucket) +# Which provider to clone from (github, gitlab, gitea or bitbucket) # default: github # flag (--scm, -s) GHORG_SCM_TYPE: