vikarti.anatra/maven-mirror-tool
1
0
Fork 0
mirror of https://github.com/hexboy/maven-mirror-tool.git synced 2025-09-02 10:39:31 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

update readme file

Browse source
This commit is contained in:
Hassan Yousefi 2023-08-30 15:23:56 +03:30
parent 323c2de24f
commit e2dfa8de60
1 changed files with 7 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -1,6 +1,6 @@
# Maven Repository Mirroring and Caching Tool # Maven Repository Mirroring and Caching Tool
This repository provides a solution for mirroring and caching multiple Maven repositories, offering a unified endpoint.This endpoint can then be utilized in `gradle.build` files to streamline your Gradle-based projects. This repository provides a solution for mirroring and caching multiple Maven repositories, providing a unified endpoint.This endpoint can then be utilized in `gradle.build` files to streamline your Gradle-based projects.
## Table of Contents ## Table of Contents
@ -53,7 +53,7 @@ Follow these steps to set up the Maven repository mirroring and caching project:
### Configuration ### Configuration
1. Duplicate the `config.yml` file and rename it to `config.local.yml` in the project root directory. 1. Duplicate the `config.yml` file and rename the copy to `config.local.yml` in the project root directory.
2. Open the `config.local.yml` file. 2. Open the `config.local.yml` file.
3. Customize the `REPOSITORIES` array to include the Maven repositories you want to mirror and cache. 3. Customize the `REPOSITORIES` array to include the Maven repositories you want to mirror and cache.
4. Modify any other settings as needed, such as port number or caching options or proxy servers. 4. Modify any other settings as needed, such as port number or caching options or proxy servers.
@ -62,10 +62,10 @@ Here's an example configuration snippet:
```yaml ```yaml
PROXIES: PROXIES:
fodev: # this key is used in `proxy` section in repository config. fodev: # The key is utilized in the proxy section of the repository configuration.
host: fodev.org host: fodev.org
port: 8118 port: 8118
protocol: http # protocol can be "http" or "https" or "socks5". protocol: http # Protocol can be "http" or "https" or "socks5".
local: local:
host: 127.0.0.1 host: 127.0.0.1
@ -75,14 +75,14 @@ PROXIES:
REPOSITORIES: REPOSITORIES:
- name: central - name: central
url: https://repo1.maven.org/maven2 url: https://repo1.maven.org/maven2
fileTypes: # optional: you can specified fileTypes to cache. fileTypes: # optional: FileTypes can be specified to be cached.
- '.jar' # - '.jar' #
- '.aar' # - '.aar' #
proxy: fodev # optional: select a proxy server proxy: fodev # optional: Select a proxy server
- name: private-repo - name: private-repo
url: https://repo.mycompany.com/maven url: https://repo.mycompany.com/maven
auth: # optional: authentication info auth: # optional: Authentication info
username: myusername # username: myusername #
password: mypassword # password: mypassword #
``` ```