Codice Docs
  • Overview
  • Configuration Guide
    • Application Configuration
    • .codiceignore
  • Analytics
  • Security and Privacy
Powered by GitBook
On this page
  • Repository User Management
  • Repository Management
  • Maven Settings
  1. Configuration Guide

Application Configuration

PreviousConfiguration GuideNext.codiceignore

Last updated 5 months ago

Repository User Management

Repository Users configured in Codice are those who have permissions to access and manage Git repositories. These users maintain the necessary credentials (SSH and tokens) to securely interact with different repository providers (GitLab, GitHub, Bitbucket).

Available Operations:

  • Create new users through "Add User" button

  • Edit existing users via action menu

  • Delete users via action menu

  • View user details

User Properties:

  • Username (required)

  • SSH Key (required): Private SSH key for repository authentication, you must set the public key in the repository provider to grant access to the user

  • Access Token (required): Access token for GitLab/GitHub/Bitbucket with read/write repository permissions

  • Description (optional): Additional user information

Repository Management

Repository management allows you to configure the Git repositories in which you want to use Codice.

Available Operations:

  • Add new repositories through "Add Repository" button

  • Edit repository details via action menu

  • Delete repositories via action menu

  • View repository information

Repository Properties:

  • Name (required): Repository name

  • Repository Type (required): GitLab/GitHub/Bitbucket

  • Repository ID (required): Unique identifier

    • Bitbucket: owner/projectId (e.g., "myorg/myproject")

    • GitLab: Numeric project ID (e.g., "123456")

    • GitHub: Project ID from API response

      curl -H "Authorization: token YOUR_TOKEN" \
     -H "Accept: application/vnd.github.v3+json" \
     https://api.github.com/repos/owner/repo

  • Owner: Repository owner

  • SSH URL (required): SSH clone URL

  • HTTP URL (required): API URL from repository provider

    • Bitbucket Cloud: https://api.bitbucket.org

    • GitLab Cloud: https://gitlab.com

    • GitHub: https://api.github.com

    • On-premise: Use your local installation base URL (e.g., https://gitlab.mycompany.com or whatever you have configured in the repository provider)

  • Associated User (required): User from users list (with permissions to access and write to the repository)

Maven Settings

Maven settings configuration allows you to manage internal dependencies through a custom settings.xml file. This configuration is essential for:

  • Accessing private artifact repositories

  • Managing internal dependencies

  • Authenticating with your organization's Maven repositories

Key Points:

  • Configure custom Maven settings through XML editor

  • The configured user inside the settings.xml file must have proper permissions to access artifact repositories

  • Save/Update Maven configuration

  • Empty configuration will use system defaults

Obtained directly from repository URL

Visible in project's main page: Settings > General > Project ID

Can be obtained through API: