https://github.com/jenkins-zh/mirror-proxy

Jenkins Update Center mirror proxy
https://github.com/jenkins-zh/mirror-proxy

jenkins mirror proxy update-center

Last synced: 6 days ago
JSON representation

Jenkins Update Center mirror proxy

• Host: GitHub
• URL: https://github.com/jenkins-zh/mirror-proxy
• Owner: jenkins-zh
• License: mit
• Created: 2019-11-15T04:34:21.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2021-04-29T22:24:13.000Z (over 3 years ago)
• Last Synced: 2024-10-31T10:43:29.590Z (13 days ago)
• Topics: jenkins, mirror, proxy, update-center
• Language: Go
• Homepage: https://updates.jenkins-zh.cn
• Size: 111 KB
• Stars: 16
• Watchers: 5
• Forks: 6
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Docker Pulls](https://img.shields.io/docker/pulls/jenkinszh/mirror-proxy.svg)](https://hub.docker.com/r/jenkinszh/mirror-proxy/tags)

## Jenkins Update Center Mirror Proxy

The proxy is a HTTP server which serve for several different Jenkins Update Center sites.

## Service

The Mirror Proxy server has deployed to here.

[https://updates.jenkins-zh.cn/update-center.json](https://updates.jenkins-zh.cn/update-center.json)

## Get started

Run it as demo on MacOS, please follow this:

`make run`

On Linux, please follow this:

`make run-linux`

On windows, please follow this:

`make run-win`

Copy the binary file from docker image:

`mirror_proxy_id=$(docker create docker.pkg.github.com/jenkins-zh/mirror-proxy/mirror-proxy:v0.0.3) && sudo docker cp $mirror_proxy_id:/mirror-proxy . && docker rm -v $mirror_proxy_id`

## Run in Docker

Run the Jenkins Update Center mirror proxy in docker:

`make run-image`

Given the certificate file:

`docker run -v rootCA:/rootCA docker.pkg.github.com/jenkins-zh/mirror-proxy/mirror-proxy:0.0.1 --cert /rootCA/demo.crt --key /rootCA/demo.key`

## API

The only API path is:

|API|Description|

|---|---|

| `GET /update-center.json?version=2.190.2`|Get the update-center.json which allows you give different query conditions|

| `GET /json-servers`|Get all JSON servers|

| `GET /providers`|Get all mirror storage providers|

| `GET /providers/default`|Get the default mirror storage provider|

| `GET /plugins/list?year=2020` | Get the plugin list |

| `GET /plugins?year=2020&name=TwilioNotifier` | Get the download data of a specific plugin |

| `GET /status` | Get the server status |

### Update Center

Below are the query ways for the update center of the mirror:

|Key|Description|

|---|---|

|`version`|The version of current Jenkins|

|`mirror-experimental`|Indicate if you want to use the experimental of plugins|

|`mirror-jsonServer`|Specific the JSON server|

|`mirror-provider`|Specific the mirror storage provider|

**All keys come from query and header. Header value will override the query ones.**