caiolombello/doclearn-app repository overview

⁠Quick reference

• Maintained by: Caio Barbieri⁠
• Where to get help: GitHub Issues⁠

⁠Supported tags and respective Dockerfile links

• 1.4.1, latest (Dockerfile)⁠
• 1.4.0 (Dockerfile)⁠
• 1.3.0 (Dockerfile)⁠
• 1.2.0 (Dockerfile)⁠
• 1.1.0 (Dockerfile)⁠
• 1.0.0 (Dockerfile)⁠

⁠Quick reference (cont.)

• Where to file issues: https://github.com/caiolombello/doclearn/issues⁠
• Supported architectures: amd64

⁠What is GitDoc AI?

GitDoc AI is a Python application that provides an interface to interact with the GitHub API. It allows users to perform various operations related to GitHub repositories, such as retrieving Markdown files, listing branches and tags, and searching for specific content within files.

⁠How to use this image

⁠Start a GitDoc AI instance

$ docker run --name some-gitdoc-ai -d caiolombello/doclearn-app:latest

This will start a GitDoc AI instance listening on port 80 inside the container. To access it from your host machine, you'll need to map the port:

$ docker run --name some-gitdoc-ai -p 8000:80 -d caiolombello/doclearn-app:latest

You can then access the API at http://localhost:8000.

⁠Environment Variables

The GitDoc AI image uses several environment variables for configuration:

• GITHUB_TOKENS: Your GitHub personal access token (required)
• GOOGLE_API_KEY: Your Google API key (optional, for Google search functionality)
• GOOGLE_SEARCH_ENGINE_ID: Your Google Custom Search Engine ID (optional, for Google search functionality)

Example usage:

$ docker run --name some-gitdoc-ai -p 8000:80 \
    -e GITHUB_TOKENS=your_github_token,another_github_token,another2_github_token \
    -e GOOGLE_API_KEY=your_google_api_key \
    -e GOOGLE_SEARCH_ENGINE_ID=your_search_engine_id \
    -d caiolombello/doclearn-app:latest

⁠API Endpoints

GitDoc AI provides several API endpoints:

startLine: 98
endLine: 105

For detailed information on how to use these endpoints, please refer to the project documentation⁠.

⁠License

GitDoc AI is licensed under the MIT License⁠.

As with all Docker images, these likely also contain other software which may be under other licenses (such as Bash, etc from the base distribution, along with any direct or indirect dependencies of the primary software being contained).

It is the image user's responsibility to ensure that any use of this image complies with any relevant licenses for all software contained within.