Commit c62ae1e6 authored by Adrian DC's avatar Adrian DC
Browse files

docs(readme): document '~/.python-gitlab.cfg' configuration file 

Signed-off-by: default avatarAdrian DC <radian.dc@gmail.com>
parent 271c7c8f

README.md

+37 −0
Changes for README.md: 37 added lines, 0 removed lines.
Original line number Diff line number Diff line
@@ -131,6 +131,43 @@ environment variables 


---



## Python GitLab configuration file



`gitlab-projects-settings` uses the same configuration files as the `python-gitlab` API,  

holding domains, URL and private tokens credentials for the GitLab instances.



The default user configuration file can be created at `~/.python-gitlab.cfg`.



The `-c` or `--config` parameters can provide specific configuration files,  

otherwise the `PYTHON_GITLAB_CFG` environment variable can be used.



**Example `~/.python-gitlab.cfg` configuration file:**



```ini

[global]

default = gitlab.com

ssl_verify = true

timeout = 5



[gitlab.com]

url = https://gitlab.com

private_token = glpat-...



[gitlab.local.dev]

url = https://gitlab.local.dev

private_token = glpat-...



[gitlab.private.dev:4243]

url = https://gitlab.private.dev:4243

private_token = glpat-...

ssl_verify = /usr/local/share/ca-certificates/gitlab.private.dev.crt

```





**`python-gitlab` configuration files documentation:** [Getting started with the CLI / Configuration files](https://python-gitlab.readthedocs.io/en/stable/cli-usage.html#configuration-files)



---



## Userspace available settings



`gitlab-projects-settings` creates a `settings.ini` configuration file in a userspace folder.