### Install and Start Consul Agent (Bash)

Source: https://github.com/tencentblueking/bk-repo/blob/master/docs/install/binary/README.md

Demonstrates commands for installing and starting Consul agents. It shows examples for both local execution and a server machine, emphasizing the use of data directories, datacenter names, domain configurations, and bind addresses. The UI port is also specified.

```bash
consul agent -data-dir=/usr/local/var/consul -datacenter=bk-repo -domain=bk-repo -bind=<本地IP> -retry-join=<consul服务端IP> -http-port=8081 -ui （本地执行）
consul agent -server -data-dir=/data/consul -ui -client=0.0.0.0 -bind=<consul服务端IP> -http-port=8500 -datacenter=bk-repo -domain=bk-repo -bootstrap （工作机执行）
```

--------------------------------

### RPM Package .spec File Example

Source: https://github.com/tencentblueking/bk-repo/blob/master/docs/repository/rpm.md

This is an example of an RPM .spec file, defining package metadata such as name, version, release, summary, and license. It also includes sections for preparation (%prep), building (%build), installation (%install), and file listing (%files).

```txt
Name:       bkrepo-test
Version:    1.1
Release:    1
Summary:    Test same artifactUri but different content!
License:    FIXME

%description
This is my first RPM package, which does nothing.

%prep
# we have no source, so nothing here

%build
cat > bkrepo-test.sh <<EOF
#!/usr/bin/bash
echo bkrepo test
EOF

%install
mkdir -p %{buildroot}/usr/bin/
install -m 755 bkrepo-test.sh %{buildroot}/usr/bin/bkrepo-test.sh

%files
/usr/bin/bkrepo-test.sh

%changelog
# let's skip this for now
```

--------------------------------

### Configure and Start Proxy Service on Linux

Source: https://github.com/tencentblueking/bk-repo/blob/master/docs/install/proxy.md

This section provides the systemd service file configuration and commands to start the proxy on a Linux system. It requires JDK 17 and specifies the file storage path and proxy JAR location. Ensure the Java path, storage directory, and JAR path are adjusted to your environment.

```bash
[Unit]
Description=service-proxy
Requires=network-online.target

[Service]
EnvironmentFile=-/usr/bin/java
Environment=GOMAXPROCS=2
Restart=on-failure
ExecStart=/usr/bin/java -server -Dsun.jnu.encoding=UTF-8 -Dfile.encoding=UTF-8 -D'storage.filesystem.path=/data/store' -jar /data/work/proxy.jar
ExecReload=/bin/kill -HUP $MAINPID
KillSignal=SIGTERM

[Install]
WantedBy=multi-user.target
```

```bash
systemctl daemon-reload
systemctl start service-proxy
```

--------------------------------

### RPM Package Building

Source: https://github.com/tencentblueking/bk-repo/blob/master/docs/repository/rpm.md

Instructions and examples for building RPM packages.

```APIDOC
## Build RPM Package

### Description
This section provides guidance on building RPM packages, including installing necessary tools and creating a `.spec` file.

### Install Build Tools
```shell
yum install gcc rpm-build rpm-devel rpmlint make python bash coreutils diffutils patch rpmdevtools
```

### Create Spec File
1. Create a new `.spec` file in a working directory: `touch xxx.spec`
2. Use `rpmdev-setuptree` to set up the build environment.

### Build Command
```shell
rpmbuild -ba hello-world.spec
```

### Example `.spec` File Content
```txt
Name:       bkrepo-test
Version:    1.1
Release:    1
Summary:    Test same artifactUri but different content!
License:    FIXME

%description
This is my first RPM package, which does nothing.

%prep
# we have no source, so nothing here

%build
cat > bkrepo-test.sh <<EOF
#!/usr/bin/bash
echo bkrepo test
EOF

%install
mkdir -p %{buildroot}/usr/bin/
install -m 755 bkrepo-test.sh %{buildroot}/usr/bin/bkrepo-test.sh

%files
/usr/bin/bkrepo-test.sh

%changelog
# let's skip this for now
```

### Official Documentation
Refer to the [RPM Packaging Guide](https://rpm-packaging-guide.github.io/) for comprehensive details.
```

--------------------------------

### Start and Manage OpenResty Nginx Server (Shell)

Source: https://github.com/tencentblueking/bk-repo/blob/master/docs/install/binary/README.md

Provides commands for managing the OpenResty Nginx server, including creating the PID directory, verifying the Nginx configuration, starting the Nginx server, and reloading its configuration. These commands are essential for activating the gateway deployment.

```shell
mkdir -p /usr/local/openresty/nginx/run/ # 创建PID目录 
cd /usr/local/openresty/nginx # 进入nginx安装目录 
./sbin/nginx -t  # 验证nginx的配置是否正确 
./sbin/nginx     # 启动nginx 
./sbin/nginx -s reload # 重启nginx
```

--------------------------------

### Auth Microservice Startup Script

Source: https://github.com/tencentblueking/bk-repo/blob/master/docs/install/binary/backend.md

This script demonstrates how to start the 'auth' microservice. It configures JVM memory, logging, garbage collection, and connects to Consul for service discovery and configuration. Ensure the BK_REPO_LOGS_DIR, BK_REPO_JVM_XMS, BK_REPO_JVM_XMX, BK_REPO_ENV, BK_REPO_CONSUL_SERVER_HOST, and BK_REPO_CONSUL_SERVER_PORT environment variables are set correctly.

```shell
mkdir -p $BK_REPO_LOGS_DIR
java -server \
     -Dsun.jnu.encoding=UTF-8 \
     -Dfile.encoding=UTF-8 \
     -Xloggc:$BK_REPO_LOGS_DIR/gc.log \
     -XX:+PrintTenuringDistribution \
     -XX:+PrintGCDetails \
     -XX:+PrintGCDateStamps \
     -XX:+HeapDumpOnOutOfMemoryError \
     -XX:HeapDumpPath=oom.hprof \
     -XX:ErrorFile=error_sys.log \
     -Xms$BK_REPO_JVM_XMS \
     -Xmx$BK_REPO_JVM_XMX \
     -jar $MODULE.jar \
     --spring.profiles.active=$BK_REPO_ENV \
     --spring.cloud.consul.host=$BK_REPO_CONSUL_SERVER_HOST \
     --spring.cloud.consul.port=$BK_REPO_CONSUL_SERVER_PORT
```

--------------------------------

### Package and Deploy Frontend Assets (Shell)

Source: https://github.com/tencentblueking/bk-repo/blob/master/docs/install/binary/README.md

Handles the packaging and deployment of frontend assets. This includes creating a raw zip archive of the UI, rendering configuration files for the web deployment, and then creating a final zipped package of the UI. It also details how to extract and verify the deployment.

```shell
cd ${WORK_DIR}/src/frontend/frontend/
zip -r ui_raw.zip ui
mv ui_raw.zip ${WORK_DIR}

rm -rf ${WORK_DIR}/web
chmod +x ${WORK_DIR}/scripts/render_tpl
cd $WORK_DIR
mkdir -p ${WORK_DIR}/web/frontend/ui/
cp -r ${WORK_DIR}/src/frontend/frontend/ui/* ${WORK_DIR}/web/frontend/ui/
${WORK_DIR}/scripts/render_tpl -u -p . -m web -e ${WORK_DIR}/scripts/repo.env -E BK_REPO_DEPLOY_MODE=standalone ${WORK_DIR}/src/frontend/frontend/ui/frontend*

cd ${WORK_DIR}/web/frontend/
zip -r ui.zip ui
mv ui.zip ${WORK_DIR}/frontend

cd ${WORK_DIR}/frontend
rm -rf ui
unzip ui.zip
```

--------------------------------

### Install Dependencies and Build Frontend with Yarn

Source: https://github.com/tencentblueking/bk-repo/blob/master/docs/install/binary/frontend.md

This snippet details the process of installing Yarn, its dependencies, and finally building the frontend project. It assumes you are in the src/frontend directory. Ensure Node.js version 8.0.0 or higher is installed.

```shell
# Install Yarn globally
npm install -g yarn
# Install project dependencies
yarn install
# Install dependencies for each sub-service
yarn start
# Execute the build command
yarn public
```

--------------------------------

### Initialize MongoDB with Data (Shell)

Source: https://github.com/tencentblueking/bk-repo/blob/master/docs/install/binary/README.md

Initializes the MongoDB database for BK-Repo by executing SQL scripts located in the `support-files/sql` directory. This step requires the MongoDB user, password, address, and database name to be correctly configured in the environment variables.

```shell
mongo -u $BK_REPO_MONGODB_USER -p $BK_REPO_MONGODB_PASSWORD $BK_REPO_MONGODB_ADDR/$BK_REPO_MONGODB_DB_NAME init-data.js
```

--------------------------------

### Composer Install and Dependency Management

Source: https://github.com/tencentblueking/bk-repo/blob/master/docs/repository/composer.md

Instructions on how to install dependencies using Composer and add a custom repository to your project's composer.json.

```APIDOC
## Composer Install and Dependency Management

### Description
Details on how to install project dependencies using Composer and how to specify a custom Composer repository within a project's `composer.json` file, including enabling HTTP support and requiring specific packages.

### Method
Command Line Interface (CLI) and `composer.json` configuration

### Install Dependencies
Execute the following command in your PHP project directory:
```bash
composer.phar install
```

### Adding Dependencies and Custom Repository
Modify your project's `composer.json` file:

```json
{
    "name": "canway/test",
    "repositories": [
        {
            "type": "composer",
            "url": "http://{bk_repo_addr}/{projectId}/{repoName}" // Add dependency source
        }
    ],
    "config": {
        "secure-http" : false  // Enable HTTP support
    },
    "require": {
        "php-http/httplug" : "2.0.0" // Add the PHP package dependency
    },
    "version": "1.0.0"
}
```

### Response
(Installation and configuration commands do not typically return a JSON response. Success is indicated by the successful completion of the `composer install` command and the presence of the package in the `vendor` directory.)
```

--------------------------------

### Create RPM Package with rpmbuild

Source: https://github.com/tencentblueking/bk-repo/blob/master/docs/repository/rpm.md

This snippet demonstrates the process of creating an RPM package. It includes installing necessary tools, creating a .spec file, and using `rpmbuild` to build the package from the .spec file.

```shell
#安装打包工具
yum install gcc rpm-build rpm-devel rpmlint make python bash coreutils diffutils patch rpmdevtools

#在一个空白目录新建一个`.spec`文件
touch xxx.spec    
#打包
rpmdev-setuptree
rpmbuild -ba hello-world.spec
```

--------------------------------

### Install BK-Repo with Helm

Source: https://github.com/tencentblueking/bk-repo/blob/master/docs/install/helm.md

Demonstrates how to install the BK-Repo Helm chart using the `helm install` command with `--set` for specific configurations like image registry and gateway host.

```shell
helm install bkrepo bkee/bkrepo \
  --set global.imageRegistry=your.registry.com \
  --set gateway.host=bkrepo.example.com
```

--------------------------------

### Install BK-Repo with YAML values file

Source: https://github.com/tencentblueking/bk-repo/blob/master/docs/install/helm.md

Shows how to install the BK-Repo Helm chart by providing configuration values through a YAML file.

```shell
helm install bkrepo bkee/bkrepo -f values
```

--------------------------------

### Start bk-repo Client Container with Docker

Source: https://github.com/tencentblueking/bk-repo/blob/master/docs/repository/client.md

This command starts the bk-repo client container in interactive mode. It mounts the host's Docker socket and Docker binary into the container, allowing Docker commands to be executed from within the container.

```shell
docker run -ti -v /var/run/docker.sock:/var/run/docker.sock -v /usr/bin/docker:/usr/bin/docker bkrepo/client:latest /bin/bash
```

--------------------------------

### Search and Manage Packages with pip

Source: https://github.com/tencentblueking/bk-repo/blob/master/docs/repository/pypi.md

This snippet shows how to use pip commands to list installed packages, uninstall packages, and search for packages within a specified BK-Repo PyPI repository. The search command requires the repository URL and the package name or summary.

```bash
#list installed packages
pip3 list
#uninstall package
pip3 uninstall package
#search
pip3 search -i http://{bk_repo_addr}/{projectId}/{repoName} {package}|{summary}
```

--------------------------------

### Render Configuration Templates and Upload to Consul KV (Shell)

Source: https://github.com/tencentblueking/bk-repo/blob/master/docs/install/binary/README.md

This script renders configuration templates using `render_tpl` and then uploads the generated YAML configuration files to Consul's Key-Value store. It iterates through various service configurations, including auth, repository, dockerapi, generic, docker, helm, maven, and npm, as well as the main application configuration.

```shell
cd $WORK_DIR/bkrepo/scripts
chmod +x render_tpl
./render_tpl -u -p $WORK_DIR -m bkrepo -e repo.env $WORK_DIR/bkrepo/support-files/templates/*.yaml

services=(auth repository dockerapi generic docker helm maven npm)
for var in ${services[@]};
 do
    service=$BK_REPO_SERVICE_PREFIX$var
    echo $service
    curl -T $WORK_DIR/etc/bkrepo/$var.yaml http://$BK_REPO_CONSUL_SERVER_HOST:$BK_REPO_CONSUL_SERVER_PORT/v1/kv/bkrepo-config/$service/data
done

curl -T $WORK_DIR/etc/bkrepo/application.yaml http://$BK_REPO_CONSUL_SERVER_HOST:$BK_REPO_CONSUL_SERVER_PORT/v1/kv/bkrepo-config/application/data
echo "put config to consul kv success."
```

--------------------------------

### Download and Build bk-repo from Zip Archive (Shell)

Source: https://github.com/tencentblueking/bk-repo/blob/master/docs/install/compile.md

Downloads the specified version of bk-repo source code using wget, unzips it, installs frontend dependencies, and builds the backend. Assumes `wget` and `unzip` are installed.

```shell
wget https://github.com/TencentBlueKing/bk-repo/archive/refs/tags/v1.3.8-rc1.zip
unzip v1.3.8-rc1.zip
cd bk-repo-1.3.8-rc1/src/frontend/
yarn install && yarn public
cd ../backend/
./gradlew build
```

--------------------------------

### Download and Build bk-repo from Git Repository (Shell)

Source: https://github.com/tencentblueking/bk-repo/blob/master/docs/install/compile.md

Clones the bk-repo project from its git repository, installs frontend dependencies, and builds the backend. Requires `git` to be installed.

```shell
git clone https://github.com/TencentBlueKing/bk-repo.git
cd bk-repo/src/frontend/
yarn install && yarn public
cd ../backend/
./gradlew build
```

--------------------------------

### Install BK-REPO using Helm

Source: https://github.com/tencentblueking/bk-repo/blob/master/docs/install/helm.md

Installs the BK-REPO application on a Kubernetes cluster using the provided Helm chart. This command adds the Helm repository and then installs the 'bkrepo' release with default configurations. Ensure you replace '<bkrepo helm repo url>' with the actual repository URL.

```shell
helm repo add bkee <bkrepo helm repo url>
helm install bkrepo bkee/bkrepo
```

--------------------------------

### Startup and Packaging

Source: https://github.com/tencentblueking/bk-repo/blob/master/src/backend/README.md

Instructions on how to start and package the BK-Repo application using both IDEs and Gradle.

```APIDOC
## Startup and Packaging

### 启动说明 (Startup Instructions)

#### Idea
To run the application in an IDE, directly execute the `main` function in the `XXXApplication.kt` file located within the `xxx-boot` module.

#### Gradle
Leveraging the Spring Boot Gradle plugin, the `bootRun` task can be used to start the application.

```bash
# Run a specific microservice
./gradlew xxx:boot-xxx:bootRun
```

### 打包说明 (Packaging Instructions)

Using the Spring Boot Gradle plugin, the `bootJar` task is used for packaging.

```bash
# Package a single microservice
./gradlew xxx:boot-xxx:bootJar

# Package all microservices
./gradlew bootJar
```

**Note on Gradle Configuration:**
The Spring Boot plugin by default disables the standard `jar` task for modules starting with `boot-`. The `build.gradle` file contains the following configuration:

```gradle
def isBootProject = project.name.startsWith("boot-")

jar.enabled = !isBootProject
bootJar.enabled = isBootProject
bootRun.enabled = isBootProject
```

This ensures that modules prefixed with `boot-` are packaged as executable JARs (`bootJar`, `bootRun`), while other modules are packaged as dependency JARs (`jar`).
```

--------------------------------

### Deploy and Start bkrepo Gateway

Source: https://github.com/tencentblueking/bk-repo/blob/master/docs/install/binary/gateway.md

This section covers the deployment and startup of the bkrepo gateway. It involves configuring environment parameters, rendering gateway template files using a script, and creating a symbolic link for the Nginx configuration. Finally, it provides commands to start, reload, and manage the Nginx service.

```shell
# Configure parameters in $WORK_DIR/bkrepo/scripts/repo.env
# Execute render command to generate gateway template files
cd $WORK_DIR/bkrepo/scripts
chmod +x render_tpl
./render_tpl -u -p /data/bkee -m bkrepo -e repo.env $WORK_DIR/bkrepo/support-files/templates/gateway*

# Symlink the gateway nginx configuration directory to nginx conf directory
rm -rf /usr/local/openresty/nginx/conf
ln -s  $WORK_DIR/bkrepo/gateway /usr/local/openresty/nginx/conf

# Start commands
mkdir -p /usr/local/openresty/nginx/run/ # Create PID directory
cd /usr/local/openresty/nginx # Enter nginx installation directory
./sbin/nginx -t  # Verify nginx configuration
./sbin/nginx     # Start nginx
./sbin/nginx -s reload # Restart nginx
```

--------------------------------

### Troubleshoot Slow Initial Startup and Not Ready Pods

Source: https://github.com/tencentblueking/bk-repo/blob/master/support-files/kubernetes/charts/bkrepo/README.md

Explains that slow initial startup and pods remaining in a 'Not Ready' state are often due to the MongoDB deployment taking time to complete, including database table and index creation.

```text
2. 首次启动时间过长，且READY状态为`0/1`？

答: 如果选择了部署`mongodb Chart`，需要等待`mongodb`部署完成后，`bkrepo`相关容器才会启动；启动过程涉及到数据表以及索引创建，这个期间容器状态为`Not Ready`。
```

--------------------------------

### Update Helm Repository and Install Chart from BK-Repo

Source: https://github.com/tencentblueking/bk-repo/blob/master/docs/repository/helm.md

Before installing a chart, it's often necessary to update the local Helm repository cache to fetch the latest information about available charts. This command then installs a specified chart from the configured repository.

```powershell
# 下载会提示先执行repo update操作
$ helm repo update
# 下载指定包
$ helm install localhost/mychart
```

--------------------------------

### Install Composer Dependencies

Source: https://github.com/tencentblueking/bk-repo/blob/master/docs/repository/composer.md

Installs Composer dependencies for a PHP project. This command is executed within the project directory. The `composer.json` file should be configured with the repository URL and any required packages.

```bash
composer.phar install
```

--------------------------------

### Package All Microservices with Gradle

Source: https://github.com/tencentblueking/bk-repo/blob/master/src/backend/README.md

This command uses the Gradle wrapper to execute the 'bootJar' task for all modules. It packages all microservices into executable JAR files.

```bash
./gradlew bootJar
```

--------------------------------

### Start Consul Client Agent

Source: https://github.com/tencentblueking/bk-repo/blob/master/docs/install/binary/consul.md

Command to start a Consul client agent. It requires the data directory, datacenter, and domain. Crucially, it needs the IP address of a server to join the cluster and the local IP for binding.

```shell
consul agent -data-dir={consul_directory} -datacenter=bk-repo -domain=bk-repo -join={server_IP} -bind={local_IP}

# Example: consul client IP=10.10.10.2
consul agent -data-dir=/data/consul -datacenter=bk-repo -domain=bk-repo -join=10.10.10.1 -bind=10.10.10.2
```

--------------------------------

### Run Microservice with Gradle

Source: https://github.com/tencentblueking/bk-repo/blob/master/src/backend/README.md

This command uses the Gradle wrapper to execute the 'bootRun' task for a specific microservice (e.g., 'xxx'). This is used for running individual microservices during development.

```bash
./gradlew xxx:boot-xxx:bootRun
```

--------------------------------

### Install Package from BK-Repo PyPI with pip

Source: https://github.com/tencentblueking/bk-repo/blob/master/docs/repository/pypi.md

These snippets illustrate how to install Python packages from the BK-Repo PyPI repository using pip. The first method involves configuring pip globally to use the BK-Repo as the default index, while the second method specifies the repository URL directly in the install command.

```bash
pip3 install {packageName}=={version}
```

```bash
pip3 install -i http://{bk_repo_addr}/{projectId}/{repoName} {package}=={version}
```

--------------------------------

### Start Consul Server Agent

Source: https://github.com/tencentblueking/bk-repo/blob/master/docs/install/binary/consul.md

Command to start a Consul server agent. It specifies the data directory, enables the UI, sets the HTTP port, and defines datacenter and domain configurations. The '-bootstrap' flag indicates it's the first server in a new cluster.

```shell
consul agent -server -data-dir={consul_directory} -ui -http-port={consul_http_port} -datacenter=bk-repo -domain=bk-repo -bootstrap -client=0.0.0.0
# Example: consul server IP=10.10.10.1
consul agent -server -data-dir=/data/consul -ui -http-port=8080 -datacenter=bk-repo -domain=bk-repo -bootstrap -client=0.0.0.0
```

--------------------------------

### Set Deployment Environment Variables (Bash)

Source: https://github.com/tencentblueking/bk-repo/blob/master/docs/install/binary/README.md

Configures essential environment variables for BK-Repo deployment by editing the system's profile file. These variables include paths, database credentials, and Consul server details. Ensure these are set correctly before proceeding with the installation.

```bash
sudo vim /etc/profile

export WORK_DIR=/data/bkee
export BK_REPO_MONGODB_USER=<mongodb用户名>
export BK_REPO_MONGODB_PASSWORD=<mongodb密码>
export BK_REPO_MONGODB_ADDR=<mongodb地址>
export BK_REPO_MONGODB_DB_NAME=<mongodb数据库名>
export BK_REPO_SERVICE_PREFIX=bkrepo-
export BK_REPO_CONSUL_SERVER_HOST=<consul服务IP>
export BK_REPO_CONSUL_SERVER_PORT=<consul服务端口>
```

--------------------------------

### Run Proxy on Windows

Source: https://github.com/tencentblueking/bk-repo/blob/master/docs/install/proxy.md

This bash command demonstrates how to run the proxy JAR file on a Windows system. It specifies the file storage path using a system property and requires JDK 17. Upon successful startup, log and runtime directories will be created.

```bash
javaw -D'storage.filesystem.path=Z:\data\store' -jar proxy.jar
```

--------------------------------

### Modify Consul Program Permissions and Install

Source: https://github.com/tencentblueking/bk-repo/blob/master/docs/install/binary/consul.md

This snippet shows how to change the file permissions of the Consul executable to make it executable and then move it to the global binary directory. This ensures Consul can be run from anywhere on the system.

```shell
# Modify consul program mod
chmod 755 ./consul
# Move consul program to /usr/local/sbin/
cp ./consul /usr/local/sbin/
```

--------------------------------

### Package Single Microservice with Gradle

Source: https://github.com/tencentblueking/bk-repo/blob/master/src/backend/README.md

This command utilizes the Gradle wrapper to execute the 'bootJar' task for a specific microservice (e.g., 'xxx'). This creates an executable JAR file for that microservice.

```bash
./gradlew xxx:boot-xxx:bootJar
```

--------------------------------

### Deploy JAR to Maven Repository

Source: https://github.com/tencentblueking/bk-repo/blob/master/docs/repository/maven.md

This section details how to deploy a JAR file to a configured Maven repository using the `mvn deploy:deploy-file` command. It includes necessary parameters and an example of the Maven settings configuration.

```APIDOC
## Deploy JAR to Maven Repository

### Description
Deploys a JAR file to a specified Maven repository using the `mvn deploy:deploy-file` command. Requires specifying file path, artifact details, and repository URL. Authentication can be handled via `settings.xml`.

### Method
N/A (Maven command)

### Endpoint
N/A (Uses repository URL provided in command)

### Parameters
#### Command Line Parameters for `mvn deploy:deploy-file`
- **-Dfile** (string) - Required - The path to the JAR file to deploy.
- **-DgroupId** (string) - Required - The group ID of the artifact.
- **-DartifactId** (string) - Required - The artifact ID of the artifact.
- **-Dversion** (string) - Required - The version of the artifact.
- **-Dpackaging** (string) - Required - The packaging type (e.g., 'jar').
- **-DrepositoryId** (string) - Optional - The ID of the repository, used for authentication if defined in `settings.xml`.
- **-Durl** (string) - Required - The URL of the repository to deploy to.

### Request Example (Command Line)
```bash
mvn deploy:deploy-file \
-Dfile=/abc/bcd/example-1.0.0.jar \
-DgroupId=com.xxx.yyy.zzz \
-DartifactId=example \
-Dversion=1.0.0 \
-Dpackaging=jar \
-DrepositoryId=file-http \
-Durl=http://{bk_repo_addr}/{projectId}/{repoName}
```

### Maven Settings Configuration (`settings.xml`)
Configure server credentials for repository authentication.

```xml
<servers>
    <server>
      <id>file-http</id>  <!-- Must match the -DrepositoryId in the deploy command -->
      <username>admin</username>
      <password>password</password>
    </server>
</servers>
```
```

--------------------------------

### Get One-Time Task Status

Source: https://github.com/tencentblueking/bk-repo/blob/master/docs/apidoc/replication/remote-replication.md

Retrieves the execution status of a one-time task. Requires the project ID, repository name, and the task name. Returns task details including status, start and end times, and any error reasons.

```http
GET /replication/api/remote/distribution/get/runOnceTaskStatus/{projectId}/{repoName}?name={name}
```

--------------------------------

### POST /auth/api/user/create/project

Source: https://github.com/tencentblueking/bk-repo/blob/master/docs/apidoc/auth/user.md

Creates a new user and assigns them as a project administrator.

```APIDOC
## POST /auth/api/user/create/project

### Description
Creates a new user and assigns them as a project administrator.

### Method
POST

### Endpoint
/auth/api/user/create/project

### Parameters
#### Request Body
- **name** (string) - Required - The username.
- **pwd** (string) - Required - The password for the user.
- **userId** (string) - Required - The unique identifier for the user.
- **asstUsers** (string array) - Optional - A list of associated user IDs. Defaults to [].
- **group** (boolean) - Optional - Indicates if this is a group account. Defaults to false.
- **projectId** (string) - Required - The ID of the project to associate the user with.

### Request Example
```json
{
    "name":"string",
    "pwd":"string",
    "userId":"string",
    "asstUsers":["owen"],
    "group":true,
    "projectId":"test"
}
```

### Response
#### Success Response (200)
- **code** (integer) - Indicates success (0) or failure (>0).
- **message** (string) - Contains an error message if the operation failed.
- **data** (boolean) - The result of the operation.
- **traceId** (string) - A unique identifier for tracing the request.

#### Response Example
```json
{
    "code": 0,
    "message": null,
    "data": true,
    "traceId": ""
}
```
```

--------------------------------

### Upload Package to BK-Repo PyPI with twine

Source: https://github.com/tencentblueking/bk-repo/blob/master/docs/repository/pypi.md

This example demonstrates how to upload Python packages to a BK-Repo PyPI repository using the 'twine' tool. It requires configuring the repository details and authentication in the `.pypirc` file and then executing the upload command.

```txt
[distutils]
index-servers = bkrepo
[bkrepo]
repository = http://{bk_repo_addr}/{projectId}/{repoName}/simple
username = {user}
password = {password}
```

```bash
python3 -m twine upload -r {bkrepo} dist/*
```

--------------------------------

### POST /generic/separate/{project}/{repo}/{path} - Initialize Block Upload

Source: https://github.com/tencentblueking/bk-repo/blob/master/docs/apidoc/generic/SeparateBlock.md

Initializes a block upload process for a generic artifact. This endpoint is used to obtain an upload ID before starting to upload individual file chunks.

```APIDOC
## POST /generic/separate/{project}/{repo}/{path}

### Description
Initializes a block upload process for a generic artifact. This endpoint is used to obtain an upload ID before starting to upload individual file chunks.

### Method
POST

### Endpoint
`/generic/separate/{project}/{repo}/{path}`

### Parameters
#### Path Parameters
- **project** (string) - Required - Project name
- **repo** (string) - Required - Repo name
- **path** (string) - Required - Full path

#### Request Headers
- **X-BKREPO-OVERWRITE** (boolean) - Optional - Default: false - Overwrite existing file

### Response
#### Success Response (200)
- **code** (int) - Error code, 0 indicates success.
- **message** (string) - The failure message.
- **data** (object) - Response data.
  - **uploadId** (string) - Block upload ID.
  - **expireSeconds** (long) - Upload ID expiration in seconds.
- **traceId** (string) - Trace ID.

#### Response Example
```json
{
  "code": 0,
  "message": null,
  "data": {
    "uploadId": "8be31384f82a45b0aafb6c6add29e94f/xxxxxxxx",
    "expireSeconds": 43200
  },
  "traceId": null
}
```
```

--------------------------------

### Manage RPM Packages with Yum and Curl

Source: https://github.com/tencentblueking/bk-repo/blob/master/docs/repository/rpm.md

This set of commands covers common operations for managing RPM packages using yum and curl. It includes uploading packages, installing, checking for updates, downloading from specific repositories, removing packages, and cleaning cache or metadata.

```shell
#发布
curl -u{admin}:{password} -XPUT http://{bk_repo_addr}/{projectId}/{repoName} -T {文件路径}

#下载
yum install -y {package}
# 添加源后快速使源生效
yum check-update
#从指定源下载
yum install nginx --enablerepo={源名称}
#删除包
yum erase -y {package}
#清除缓存的包
yum clean packages --enablerepo={源名称}
#清除对应仓库的元数据
yum clean metadata --enablerepo={源名称}

#上传组文件,必须上传至仓库repodata 目录
curl -u{admin}:{password} -XPUT http://{bk_repo_addr}/{projectId}/{repoName}/{repodata}/ -T {文件路径}

#group 列表
yum grouplist
#下载组包含的包
yum groupinstall {group}
#在系统中移除组，不会移除安装的包
yum groups mark remove {group}
#移除通过组安装的包，在系统中组依然是被安装
yum groupremove {group}
#升级group下所有包
yum groupupdate {groupName}
```

--------------------------------

### Gradle Build Configuration for Boot Projects

Source: https://github.com/tencentblueking/bk-repo/blob/master/src/backend/README.md

This Gradle configuration snippet defines how JAR and bootJar tasks are enabled based on the project name. Projects starting with 'boot-' are configured to use 'bootJar' for executable JARs, while others use the standard 'jar' task for dependency JARs.

```gradle
def isBootProject = project.name.startsWith("boot-")

jar.enabled = !isBootProject
bootJar.enabled = isBootProject
bootRun.enabled = isBootProject
```

--------------------------------

### Download Package Version (API Example)

Source: https://github.com/tencentblueking/bk-repo/blob/master/docs/apidoc/package/package.md

API endpoint to download a specific version of a package. It requires project ID, repository name, package key, and version as path or query parameters. The response is a file stream.

```http
GET /repository/api/version/download/{projectId}/{repoName}?packageKey=npm://test&version=0.0.1
```

--------------------------------

### GET /generic/separate/{project}/{repo}/{path} - List Uploaded Blocks

Source: https://github.com/tencentblueking/bk-repo/blob/master/docs/apidoc/generic/SeparateBlock.md

This endpoint retrieves a list of already uploaded blocks for a given chunked upload. It requires project, repository, and path details, along with a Block Upload ID in the header.

```APIDOC
## GET /generic/separate/{project}/{repo}/{path}

### Description
Lists the uploaded blocks for a chunked upload.

### Method
GET

### Endpoint
`/generic/separate/{project}/{repo}/{path}`

### Parameters
#### Path Parameters
- **project** (string) - Required - Project name
- **repo** (string) - Required - Repository name
- **path** (string) - Required - Full path

#### Request Headers
- **X-BKREPO-UPLOAD-ID** (string) - Required - Block upload ID

#### Request Body
This endpoint does not have a request body.

### Response
#### Success Response (200)
- **code** (int) - Error code, 0 indicates success.
- **message** (string) - The failure message.
- **data** (array) - List of block information.
- **traceId** (string) - Trace ID.

#### Block Information Fields
- **size** (long) - Block size (in bytes).
- **sha256** (string) - SHA256 checksum of the block.
- **startPos** (long) - Block start position.
- **uploadId** (string) - Block upload ID.

#### Response Example
```json
{
  "code": 0,
  "message": null,
  "data": [
    {
      "size": 10240,
      "sha256": "abc123def456...",
      "startPos": 0,
      "uploadId": "1.0"
    },
    {
      "size": 10240,
      "sha256": "def456ghi789...",
      "startPos": 10240,
      "uploadId": "1.0"
    }
  ],
  "traceId": null
}
```
```

--------------------------------

### Create, Package, and Push Helm Chart to BK-Repo

Source: https://github.com/tencentblueking/bk-repo/blob/master/docs/repository/helm.md

This sequence of commands first creates a new Helm chart, then packages it into a versioned archive, and finally pushes it to the specified Helm repository. Ensure you are in the chart's directory before packaging and pushing.

```powershell
# 创建helm包
$ helm create mychart
# 打包
$ helm package ./ 
# 上传
$ helm push mychart-0.1.0.tgz localhost
```

--------------------------------

### Configure Gateway with OpenResty (Shell)

Source: https://github.com/tencentblueking/bk-repo/blob/master/docs/install/binary/README.md

Deploys the gateway component using OpenResty. This involves rendering gateway configuration templates, moving the generated gateway module to the correct directory, and creating a symbolic link to the Nginx configuration. It also includes instructions for updating the local hosts file.

```shell
cd $WORK_DIR/bkrepo/scripts
chmod +x render_tpl
./render_tpl -u -p /data/bkee -m bkrepo -e repo.env $WORK_DIR/bkrepo/support-files/templates/gateway*

rm -rf /usr/local/openresty/nginx/conf
ln -s $WORK_DIR/bkrepo/gateway /usr/local/openresty/nginx/conf

sudo vim /etc/hosts
# Example: <工作机IP> bkrepo.example.com
```

--------------------------------

### Configure Host File for NodePort Service

Source: https://github.com/tencentblueking/bk-repo/blob/master/support-files/kubernetes/charts/bkrepo/templates/NOTES.txt

This snippet shows how to configure the /etc/hosts file when using a NodePort service type. It retrieves the NodePort and NodeIP, then maps them to the gateway host, dockerHost, and helmHost.

```bash
export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ include "common.names.fullname" . }}-gateway)
        export NODE_IP=$(kubectl get nodes --namespace {{ .Release.Namespace }} -o jsonpath="{.items[0].status.addresses[0].address}")
        
        echo "$NODE_IP  {{ .Values.gateway.host }}" >> /etc/hosts
        {{- if .Values.docker.enabled }}
        echo "$NODE_IP  {{ .Values.gateway.dockerHost }}" >> /etc/hosts
        {{- end }}
        {{- if .Values.helm.enabled }}
        echo "$NODE_IP  {{ .Values.gateway.helmHost }}" >> /etc/hosts
        {{- end }}
```

--------------------------------

### List Uploaded Blocks API Request

Source: https://github.com/tencentblueking/bk-repo/blob/master/docs/apidoc/generic/SeparateBlock.md

This snippet shows how to make a GET request to the BK Repo API to list uploaded blocks for a specific file. It requires project, repo, and path as URL parameters, and an 'X-BKREPO-UPLOAD-ID' in the request header. The request body is empty.

```http
GET /generic/separate/{project}/{repo}/{path} HTTP/1.1
Host: your-bk-repo-host.com
X-BKREPO-UPLOAD-ID: your-upload-id
```