DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:gitlabproject

gitlabproject Plugin

Compatible with DokuWiki

  • 2018-04-22 "Greebo" unknown
  • 2017-02-19 "Frusterick Manners" yes
  • 2016-06-26 "Elenor Of Tsort" yes
  • 2015-08-10 "Detritus" yes

plugin Gitlab-Project display a Gitlab project inside Dokuwiki.

Last updated on
2017-10-17
Provides
Syntax
Repository
Source

Tagged with code, git, gitlab, projects

Installation

Search and install the plugin using the Extension Manager. Refer to Plugins on how to install plugins manually.

Syntax

Default Syntax:

<gitlab project="<NAMESPACE>/<PROJECT_NAME>" />

NAMESPACE is the namespace of your project, typically the name of the user or group in which the project is located.

PROJECT_NAME is the name of project.

For e.g., if you have a project available at http://my-gitlab/foo/bar, the syntax will be:

<gitlab project="foo/bar" />

Override Server and Token

Inside 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.

Just call it after by its name.

E.g.:

With the following json file:

{
    "second": {
        "url": "http://my-second-gitlab.com",
        "api_token": "a1a1a1a1a1a11a1a"
    }
    "third": {
        "url": "http://my-third-gitlab.com",
        "api_token": "b2b2b2b2b2b222b2"
    }
}

Then, simply add the server parameter with the name you've defined:

<gitlab server="second" project="foo/bar" />

Wrong project or server

If project or server is not available or does not exist, gitlabproject will display a message to warn the user.

Configuration and Settings

You can configure Gitlab-Project in the Configuration Manager of Dokuwiki:

  • server.default: Set your default Gitlab url, without slash ending. You can override this setting in server.json file.
  • token.default: Fill your admin token. You can override this setting in server.json file.
  • unwanted.users: If you want plugin ignore some members of your projects, add them here, separated by commas.

Gitlab-Project will use these data as default.

Change Log

Known Bugs and Issues

Please report your issue or your idea at Gitlab-Project.

plugin/gitlabproject.txt · Last modified: 2019-02-15 16:49 by Algorythm