README.md

gitlab-search project

Simple API server providing capability to search through given Gitlab instance for any arbitrary text

Table of Contents

• About the Project
• Getting Started
  • Run docker image
  • Querying API
• Usage
• Contributing
• License
• Contact

About The Project

The scope of the project is to simplify searching through (mostly self hosted) instances of Gitlab. Main use cases are searching through all the projects, or the projects satisfying some pattern.

Getting Started

Run docker image

docker run \
    -e GITLAB_API=https://YOUR_SERVER_HERE/api/v4 \
    -e GITLAB_TOKEN=XXXXXXXYYYYYYYY \
    --rm -p 8080:8080 \
    dodalovic/gitlab-search

Querying API

$ curl --url 'http://localhost:8080/search?searchTerm=SOME_ARBITRARY_TEXT' \
    --header 'accept: application/json'

Usage

API will be available via http://localhost:8080/search

Query params:

• searchTerm - mandatory, text you want to search for
• pattern - optional - search through projects matching given pattern

An example call:

curl --url 'http://localhost:8080/search?searchTerm=theTextToSearchFor&pattern=service' \
  --header 'accept: application/json'

will search through all the projects containing service in their name

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Dusan Odalovic - @odalinjo - [email protected]

Project Link: https://github.com/dodalovic/gitlab-search