1# Plugin Gitlab-Project 2 3Plugin Gitlab-Project display a Gitlab project inside Dokuwiki. 4 5## Requirements 6 7This plugin does not need any requirements. 8 9## Install 10 11Download Gitlab Project into your `${dokuwiki_root}/lib/plugins` folder and restart dokuwiki or use the Extension Manager. 12 13## Configuration 14 15You can configure Gitlab-Project in the Configuration Manager of Dokuwiki: 16 17* **server.default**: Set your default Gitlab url, without slash ending. You can override this setting in `server.json` file. 18* **token.default**: Fill your admin token. You can override this setting in `server.json` file. 19* **unwanted.users**: If you want to not display some users of your project, add them here, separated by commas. 20 21Gitlab-Project will use this data by default. 22 23## Syntax 24 25### Default Syntax: 26 27```php 28<gitlab project="<NAMESPACE>/<PROJECT_NAME>" /> 29``` 30 31**NAMESPACE** is the namespace of your project, typically the name of the user or group in which the project is located. 32 33**PROJECT_NAME** is the name of project. 34 35For e.g., if you have a project available at `http://my-gitlab/foo/bar`, the syntax will be: 36 37```php 38<gitlab project="foo/bar" /> 39``` 40 41### Override Server and Token 42 43Inside the root of the plugin, you will have a JSON file called: `server.json`. Inside you can add other servers and their tokens, than the one defined in the plugin settings. 44 45Just call it after by its name. 46 47E.g.: 48 49Say that you've the following json file: 50 51```json 52{ 53 "second": { 54 "url": "http://my-second-gitlab.com", 55 "api_token": "a1a1a1a1a1a11a1a" 56 }, 57 "third": { 58 "url": "http://my-third-gitlab.com", 59 "api_token": "b2b2b2b2b2b222b2" 60 } 61} 62``` 63 64Then simply add `server` parameter: 65 66```php 67<gitlab server="second" project="foo/bar" /> 68``` 69 70For further information, see also this plugins on [dokuwiki.org](https://www.dokuwiki.org/plugin:gitlabproject). 71