gitforgefs/config.example.yaml at master · badjware/gitforgefs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
fs:
  # The mountpoint. Can be overwritten via the command line.
  #mountpoint: /mnt

  # Mount options to pass to `fusermount` as its `-o` argument. Can be overwritten via the command line.
  # Some applications need the `allow_other` option to function properly (eg: docker). If you need to use `allow_other`,
  # you must also add `user_allow_other` in /etc/fuse.conf.
  # See mount.fuse(8) for the full list of options.
  #mountoptions: nodev,nosuid
  #mountoptions: allow_other,nodev,nosuid

  # Use a symlink to point to the real location of the repository instead of doing a loopback
  # Using symlinks is more performant and allow cloning to be asynchronous, but may cause compatibility issues with some applications
  # use_symlinks: true

  # The git forge to use as the backend.
  # Must be one of "gitlab", "github", or "gitea"
  forge: gitlab

gitlab:
  # The gitlab url.
  url: https://gitlab.com

  # The gitlab api token.
  # Default to anonymous (only public projects will be visible).
  #token:

  # Must be set to either "http" or "ssh".
  # The protocol to configure the git remote on.
  # "http" may not work on private projects unless a credential manager is configured
  # If possible, prefer "ssh" over "http"
  pull_method: http

  # A list of the group ids to expose their projects in the filesystem.
  group_ids:
    - 9970 # gitlab-org

  # A list of the name of the user to expose their repositories un the filesystem
  user_names: []

  # Set how archived projects are handled.
  # If set to "show", it will add them to the filesystem and treat them like any other project
  # If set to "hide", it will add them to the filesystem, but prefix the symlink with a "."
  # If set to "ignore", it will make them absent from the filesystem
  # Default to "hide"
  archived_project_handling: hide

  # If set to true, the user the api token belongs to will automatically be added to the list of users exposed by the filesystem.
  include_current_user: true

github:
  # The github api token
  # Default to anonymous (only public repositories will be visible)
  #token:

  # Must be set to either "http" or "ssh".
  # The protocol to configure the git remote on.
  # "http" may not work on private repositories unless a credential manager is configured
  # If possible, prefer "ssh" over "http"
  pull_method: http

  # A list of the name of the organizations to expose in the filesystem
  org_names: []

  # A list of the name of the user to expose their repositories un the filesystem
  user_names: []

  # Set how archived repositories are handled.
  # If set to "show", it will add them to the filesystem and treat them like any other repository
  # If set to "hide", it will add them to the filesystem, but prefix the symlink with a "."
  # If set to "ignore", it will make them absent from the filesystem
  # Default to "hide"
  archived_repo_handling: hide

  # If set to true, the personal repositories and the repositories of the organizations the user the api token belongs to
  # will be automatically be added to the list of users exposed by the filesystem.
  include_current_user: true

gitea:
  # The gitea url.
  url: https://gitea.com

  # The gitlab api token
  # Default to anonymous (only public repositories will be visible)
  #token:

  # Must be set to either "http" or "ssh".
  # The protocol to configure the git remote on.
  # "http" may not work on private repositories unless a credential manager is configured
  # If possible, prefer "ssh" over "http"
  pull_method: http

  # A list of the name of the organizations to expose in the filesystem
  org_names: []

  # A list of the name of the user to expose their repositories un the filesystem
  user_names: []

  # Set how archived repositories are handled.
  # If set to "show", it will add them to the filesystem and treat them like any other repository
  # If set to "hide", it will add them to the filesystem, but prefix the symlink with a "."
  # If set to "ignore", it will make them absent from the filesystem
  # Default to "hide"
  archived_repo_handling: hide

  # If set to true, the personal repositories and the repositories of the organizations the user the api token belongs to
  # will be automatically be added to the list of users exposed by the filesystem.
  include_current_user: true

git:
  # Path to the local repository cache. Repositories in the filesystem will symlink to a folder in this path.
  # Default to $XDG_DATA_HOME/gitforgefs, or $HOME/.local/share/gitforgefs if the environment variable $XDG_DATA_HOME is unset.
  #clone_location:

  # The name of the remote in the local clone.
  remote: origin

  # Must be set to either "init", or "clone".
  # If set to "init", the local copy will be initialized with `git init` and the remote is configured manually. The git server is nerver queried. (fast)
  # If set to "clone", the local copy will be initialized with `git clone`. (slow)
  # NOTE: If set to "init", the local clone will appear empty. Running `git pull master` will download the files from the git server.
  on_clone: init

  # If set to true, the local clone will automatically run `git pull` in the local clone if it's on the default branch and the worktree is clean.
  # Pulls are asynchronous so it can take a few minutes for all repositories to sync up.
  # It's highly recommended to leave this setting turned off.
  auto_pull: false

  # The depth of the git history to pull. Set to 0 to pull the full history.
  depth: 1

  # The number of git operations that can be queued up
  queue_size: 200

  # The number of parallel git operations that is allowed to run at once
  worker_count: 5