gickup/conf.example.yml

source:
  github:
    - token: some-token
    # alternatively, specify token in a file, relative to current working directory when executed.
      # token_file: token.txt
      user: some-user # the user you want to clone the repositories from.
      # if you want to get everything from your user, leave out the user parameter and just use the token.
      # for the clone process, either use:
      # - username + password
      # - sshkey
      # - token
      username: your-user # user is used to clone the repo with
      password: your-password
      ssh: true # can be true or false
      sshkey: /path/to/key # if empty, it uses your home directories' .ssh/id_rsa
      exclude: # this excludes the repos "foo" and "bar"
        - foo
        - bar
      include: # this includes the repo "foobar"
        - foobar
      excludeorgs: # this excludes repos from the organizations "foo" and "bar"
        - foo
        - bar
      includeorgs: # this includes repos from the organizations "foo1" and "bar1"
        - foo1
        - bar1
      wiki: true # includes wiki too
  gitea:
    - token: some-token
      # token_file: token.txt # alternatively, specify token in a file
      user: some-user # the user you want to clone the repositories from.
      url: http(s)://url-to-gitea # if empty, it uses https://gitea.com
      # if you want to get everything from your user, leave out the user parameter and just use the token.
      # for the clone process, either use:
      # - username + password
      # - sshkey
      # - token
      username: your-user # user is used to clone the repo with
      password: your-password
      ssh: true # can be true or false
      sshkey: /path/to/key # if empty, it uses your home directories' .ssh/id_rsa
      exclude: # this excludes the repos "foo" and "bar"
        - foo
        - bar
      include: # this includes the repo "foobar"
        - foobar
      excludeorgs: # this excludes repos from the organizations "foo" and "bar"
        - foo
        - bar
      includeorgs: # this includes repos from the organizations "foo1" and "bar1"
        - foo1
        - bar1
      wiki: true # includes wiki too
  gogs:
    - token: some-token
      # token_file: token.txt # alternatively, specify token in a file
      user: some-user # the user you want to clone the repositories from.
      url: http(s)://url-to-gogs # no default value
      # if you want to get everything from your user, leave out the user parameter and just use the token.
      # for the clone process, either use:
      # - username + password
      # - sshkey
      # - token
      username: your-user # user is used to clone the repo with
      password: your-password
      ssh: true # can be true or false
      sshkey: /path/to/key # if empty, it uses your home directories' .ssh/id_rsa
      exclude: # this excludes the repos "foo" and "bar"
        - foo
        - bar
      include: # this includes the repo "foobar"
        - foobar
      excludeorgs: # this excludes repos from the organizations "foo" and "bar"
        - foo
        - bar
      includeorgs: # this includes repos from the organizations "foo1" and "bar1"
        - foo1
        - bar1
      wiki: true # includes wiki too
  gitlab:
    - token: some-token
      # token_file: token.txt # alternatively, specify token in a file
      user: some-user # the user you want to clone the repositories from.
      url: http(s)://url-to-gitlab # if empty, it uses https://gitlab.com
      # if you want to get everything from your user, leave out the user parameter and just use the token.
      # for the clone process, either use:
      # - username + password
      # - sshkey
      # - token
      username: your-user # user is used to clone the repo with
      password: your-password
      ssh: true # can be true or false
      sshkey: /path/to/key # if empty, it uses your home directories' .ssh/id_rsa
      exclude: # this excludes the repos "foo" and "bar"
        - foo
        - bar
      include: # this includes the repo "foobar"
        - foobar
      excludeorgs: # this excludes repos from the organizations "foo" and "bar"
        - foo
        - bar
      includeorgs: # this includes repos from the organizations "foo1" and "bar1"
        - foo1
        - bar1
      wiki: true # includes wiki too
  bitbucket:
    - user: some-user # the user you want to clone the repositories from.
      url: http(s)://url-to-bitbucket # if empty, it uses https://bitbucket.org
      username: your-user # user is used to clone the repo with
      password: your-password
      ssh: true # can be true or false
      sshkey: /path/to/key # if empty, it uses your home directories' .ssh/id_rsa
      exclude: # this excludes the repos foo and bar
        - foo
        - bar
      include:
        - foobar
destination:
  gitea:
    - token: some-token
      # token_file: token.txt # alternatively, specify token in a file
      url: http(s)://url-to-gitea
  gogs:
    - token: some-token
      # token_file: token.txt # alternatively, specify token in a file
      url: http(s)://url-to-gogs
  gitlab:
    - token: some-token
      # token_file: token.txt # alternatively, specify token in a file
      url: http(s)://url-to-gitlab
  local:
    # Export this path from Docker with a volume to make it accessible and more permanent.
    - path: /some/path/gickup
      structured: true # checks repos out like hostersite/user|organization/repo

cron: 0 22 * * * # optional - when cron is not provided, the program runs once and exits.
# Otherwise, it runs according to the cron schedule.
# See timezone commentary in docker-compose.yml for making sure this container runs
# in the timezone you want.
# For more information on crontab or testing: https://crontab.guru/

log: # optional
  timeformat: 2006-01-02 15:04:05 # you can use a custom time format, use https://yourbasic.org/golang/format-parse-string-time-date-example/ to check how date formats work in go
  file-logging: # optional
    dir: log # directory to log into
    file: gickup.log # file to log into
    maxage: 7 # keep logs for 7 days

metrics:
  prometheus:
    endpoint: /metrics
    listen_addr: ":6178" # default listens on port 6178 on all IPs.