doc: update docs

Author: icyleaf

CHANGELOGS.md

@@ -20,7 +20,7 @@
 
 ### Added
 
-- [CLI] 新增独立命令 `hpr-migration` 迁移命令 (目前为止仅支持 gitlab-mirror`)
+- [CLI] 新增独立命令 `hpr-migration` 迁移命令 (目前为止仅支持 gitlab-mirrors`)
 - [CLI] 新增全局参数 `--file` 可以指定自定义的 hpr.json 配置文件.
 
 ### Fixed
@@ -34,7 +34,7 @@
 
 - [API] `/repositories/search` 搜索仓库 API 参数从 query 改为 uri path 方式，名称从 `q` 改为 `keyword`
 
-## [0.6.2] (2018-06-20)
+## [0.7.0] (2018-06-20)
 
 ### Fixed
 
@@ -96,8 +96,8 @@
 
 - 第一个测试版本
 
-[Unreleased]: https://github.com/icyleaf/hpr/compare/v0.6.2...HEAD
-[0.6.2]: https://github.com/icyleaf/hpr/compare/v0.6.0...v0.6.2
+[Unreleased]: https://github.com/icyleaf/hpr/compare/v0.7.0...HEAD
+[0.7.0]: https://github.com/icyleaf/hpr/compare/v0.6.0...v0.7.0
 [0.6.0]: https://github.com/icyleaf/hpr/compare/v0.5.0...v0.6.0
 [0.5.0]: https://github.com/icyleaf/hpr/compare/v0.3.0...v0.5.0
 [0.3.0]: https://github.com/icyleaf/hpr/compare/v0.2.0...v0.3.0

Makefile

@@ -1,5 +1,5 @@
 hpr_image_name ?= icyleafcn/hpr
-hpr_version ?= 0.6.2
+hpr_version ?= 0.7.0
 
 all: build
 

docker-compose.yml

@@ -6,8 +6,7 @@ services:
     ports:
       - 8848:8848
     volumes:
-      - ./config:/app/config
-      - ./repositories:/app/repositories
+      - /my/own/hprdir:/app
     environment:
       REDIS_URL: tcp://redis:6379
       REDIS_PROVIDER: REDIS_URL

docs/_coverpage.md

@@ -1,6 +1,6 @@
 ![logo](_media/icon.png)
 
-# ḫpr <small>0.6.2</small>
+# ḫpr <small>0.7.0</small>
 
 > 镜像任意 git 仓库到 gitlab 的同步工具，具有定时更新的功能。
 

docs/api.md

@@ -154,6 +154,8 @@ POST /repositores
 |---|---|---|---|
 | url | String | true | 仓库地址 |
 | name | String | false | 镜像名字，不填写默认从 url 自动获取 |
+| create | String | false | 是否创建 gitlab 项目，默认是 "true" |
+| clone | String | false | 是否克隆原仓库并推送到 gitlab，默认是 "true" |
 
 #### 返回样例
 
@@ -224,7 +226,7 @@ GET /info
 ```json
 {
     "hpr": {
-        "version": "0.6.2",
+        "version": "0.7.0",
         "repositroies": {
             "total": 2,
             "entry": [

docs/en/_coverpage.md

@@ -1,6 +1,6 @@
 ![logo](../_media/icon.png)
 
-# ḫpr <small>0.6.2</small>
+# ḫpr <small>0.7.0</small>
 
 > Mirror git repositories to self-host gitlab services.
 

docs/en/api.md

@@ -22,8 +22,8 @@ GET /repositores
 
 | Name | Type | Required | Description |
 |---|---|---|---|
-| page | Integer | false | |
-| per_page | Integer | false |  |
+| page | Integer | false | The number of current page |
+| per_page | Integer | false | The number of per page |
 
 #### Example Response
 
@@ -67,7 +67,7 @@ GET /repositores/search/:name
 
 | Name | Type | Required | Description |
 |---|---|---|---|
-| name | String | true | the name of repository |
+| name | String | true | The name of mirrored repository |
 
 #### Example Response
 
@@ -109,7 +109,7 @@ GET /repositores/:name
 
 | Name | Type | Required | Description |
 |---|---|---|---|
-| name | String | false | Name of mirrored repository |
+| name | String | false | The name of mirrored repository |
 
 #### Example Response
 
@@ -149,8 +149,10 @@ POST /repositores
 
 | Name | Type | Required | Description |
 |---|---|---|---|
-| url | String | true | |
-| name | String | false |  |
+| url | String | true | The clone url of origin |
+| name | String | false | The name of mirrored repository |
+| create | String | false | Should to create gitlab project, by default is "true" |
+| clone | String | false | Should to clone origin repository, by default is "true" |
 
 #### Example Response
 

docs/en/install.md

@@ -15,7 +15,7 @@ Check [Quick start](/en/quickstart.md)。
 Pull specified version of hpr:
 
 ```bash
-$ docker pull icyleafcn/hpr:0.6.2
+$ docker pull icyleafcn/hpr:0.7.0
 ```
 
 Or pull the latest version:
@@ -99,6 +99,8 @@ Actions:
     -c, --create                     Create a mirror repository
     -u, --update                     Updated a mirrored repository
     -d, --delete                     Delete a mirrored repository
+    -v, --version                    Show version
+    -h, --help                       Show this help
 
 Option in server action:
 
@@ -107,26 +109,26 @@ Option in server action:
 Option in create action:
 
     -U URL, --url URL                The url of mirror repository
-    -M, --mirror-only                Only mirror the repository without clone in create action
+    --no-create                      Do not create project in gitlab
+    --no-clone                       Do not clone mirror of git repository from url
 
 Global options:
 
-    -v, --version                    Show version
-    -h, --help                       Show this help
+    -f FILE, --file FILE             the path of hpr.json config file
 
 Examples:
 
        o Start a API server:
 
                $ hpr -s
 
-       o List all mirrored repositories:
+       o Start a API server with custom port and different config path:
 
-               $ hpr -l
+               $ hpr -s --port 3001 --file ~/.config/hpr/hpr.json
 
-       o Start a API server with custom port:
+       o List all mirrored repositories:
 
-               $ hpr -s --port 3001
+               $ hpr -l
 
        o Search all repositories include icyleaf keywords:
 
@@ -138,7 +140,7 @@ Examples:
 
        o Clone and push a new repository without create gitlab project:
 
-               $ hpr -c --mirror-only --url https://github.com/icyleaf/hpr.git icyleaf-hpr
+               $ hpr -c --no-create --url https://github.com/icyleaf/hpr.git icyleaf-hpr
 
        o Update a repository:
 
@@ -150,5 +152,5 @@ Examples:
 
        More detail to check: https://icyleaf.github.io/hpr/
 
-hpr v0.6.2 in Crystal v0.24.2
+hpr v0.7.0 in Crystal v0.26.1
 ```

docs/en/migrate.md

@@ -23,17 +23,9 @@ Enable MR | merge_requests_enabled | gitlab.project_merge_request | Yes
 
 More about hpr's config to check [Configurateion](/en/configuration.md) page.
 
-Then, migrate old repositories directory to hpr:
+Next step, you need get the path of gitlab-mirrors's repositories directory: get $repo_dir value from config.sh，default is /home/gitmirror/repositories
 
-```bash
-# get $repo_dir value from config.sh，default is /home/gitmirror/repositories
-$ cd /home/gitmirror/repositories
-
-# Copy the whole directory to hpr's directory
-$ cp -r mirrors /path/to/hpr/repositories
-```
-
-Finally, edit docker-compose.yml file:
+Then edit docker-compose.yml file, next move is run `docker-compose up -d`
 
 ```yaml
 version: '2'
@@ -44,8 +36,8 @@ services:
     ports:
       - 8848:8848
     volumes:
-      - ./config:/app/config
-      - /path/to/hpr/repositories:/app/repositories
+      - /my/own/hprdir:/app
+      - /home/gitmirror/repositories:/tmp/old-repositories
     environment:
       REDIS_URL: tcp://redis:6379
       REDIS_PROVIDER: REDIS_URL
@@ -58,22 +50,20 @@ services:
     image: redis:alpine
 ```
 
-Run `docker-compose up -d`
+Hpr is running now, but the data is not migrate, hpr provides a migration command tool named "hpr-migration" to make this move easily:
 
-Apply the update by schedule, you need do this:
-
-```ruby
-# gem install http
-require 'http'
-
-# Change to ip or address which hpr is
-hpr_url = 'http://localhost:8848/repositories'
-
-repositories = HTTP.get(hpr_url).parse
-repositories.each do |repo|
-  url = File.join(hpr_url, repo["name"])
-  HTTP.put url
-end
+```bash
+$ docker-compose exec hpr hpr-migration --endpoint "http://localhost:8848" /tmp/old-repositories
+* project1
+ - Configuring git remote ...
+ - Updating and pushing mirror
+* project2
+ - Create gitlab repository
+ - Configuring git remote ...
+ - Updating and pushing mirror
+* project3
+ - Existed, Skip
 ```
 
+You can get migrated data via [stats](/en/api.md#id=stats) api.
 By default, Update cycle is every hour in `schedule` (`config/hpr.json`).

docs/en/quickstart.md

@@ -49,7 +49,8 @@ Here has 4 places to change your own.
 
 > About more params check [Configuration](configuration?id=basic_auth-接口认证) page.
 
-Then set some optional `ENV` variables if you need in `docker-compose.yml`:
+1. Create a data directory on a suitable volume on your host system. e.g. **/my/own/hprdir**.
+2. Set some optional `ENV` variables if you need in `docker-compose.yml`:
 
 ```yaml
 version: '2'
@@ -74,7 +75,7 @@ services:
     image: redis:alpine
 ```
 
-the `HPR_SSH_HOST` and `HPR_SSH_PORT` variables will update your gitlab ssh config, ignore if your gitlab server use 22 port in ssh protocol.
+The `HPR_SSH_HOST` and `HPR_SSH_PORT` variables will update your gitlab ssh config, ignore if your gitlab server use 22 port in ssh protocol.
 
 Then run it:
 
@@ -97,6 +98,11 @@ hpr_1      |  | '_ \| '_ \| '__|
 hpr_1      |  | | | | |_) | |
 hpr_1      |  |_| |_| .__/|_|
 hpr_1      |        |_|
+hpr_1      | [12] Salt server starting ...
+hpr_1      | [12] * Version 0.4.2 (Crystal 0.26.1)
+hpr_1      | [12] * Environment: production
+hpr_1      | [12] * Listening on http://0.0.0.0:8848/
+hpr_1      | [12] Use Ctrl-C to stop
 ```
 
 Be attention to copy generated ssh public key in terminal output.