3 Star 26 Fork 6

Alvin / Gitlab-Sync

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

Gitlab仓库迁移工具

1. 简介

Gitlab-Sync是一款专为解决Gitlab仓库迁移问题而设计的高效、灵活的工具,它可以帮助用户在不丢失数据,轻松的迁移Gitlab中的用户、组、和项目,支持用户根据自己的需求选择迁移指定的用户、组或项目,或者一次性迁移所有用户、组和项目。

1.1 主要功能

  • 用户迁移:支持迁移指定用户或所有用户,确保用户信息完整无损地迁移到到目标仓库。
  • **组迁移:**支持迁移指定的组或所有组,包括组内成员和权限信息完整无损的迁移到目标仓库。
  • **项目迁移:**支持迁移指定的项目或所有项目,包括项目中的代码、提交记录、问题和合并请求等信息完整无损的迁移到目标仓库。
  • **灵活配置:**用户可以根据需要灵活配置迁移规则,如:一次只迁移10个项目、或迁移组时自动迁移组下的所有项目

2. 约束条件

Gitlab-Sync 基于 Goland 开发和构建, 运行时环境兼容Linux(包括RHEL和Ubuntu等)、 Mac、 Windows等操作系统。为保障更好的系统运行时兼容性,请务必使用同类型操作系统环境下编译构建的二进制版本。

2.1 环境要求

  • Gitlab-Sync运行时环境需要连接配置的Gitlab仓库地址,确保Gitlab仓库地址可以被正确访问。
  • success_push_remove_local配置等于false 时Gitlab-Sync会将旧仓库的项目拉取到指定的目录,确保该目录磁盘有足够的可用空间。

3. 使用指南

3.1 下载安装包

  • 安装包文件:gitlab-sync.tar.gz
  • 解压安装包
tar -zxvf gitlab-sync.tar.gz	
#设置权限
chmod +x gitlab-sync
  • 解压目录结构说明:
├── gitlab-sync                           #gitlab-sync主程序二进制文件
├── gitlab-sync.exe                       #gitlab-sync主程序(windows环境)
├── config.json                           #配置文件

3.2 修改配置文件

  • 加载方式: gitlab-sync服务启动时加载生效,若变更配置文件内容,需重启服务加载更新后的配置信息。
  • 相关配置:
{
  "gitlab": {
    "origin_remote_url": "源仓库地址",
    "target_remote_url": "目标仓库地址",
    "down_local_path": "仓库下载到本地的路径",
    "success_push_remove_local": 成功推送到目标仓库后是否删除本地文件 true/false,
    "skip_projects": "跳过项目(不做迁移),多个项目用逗号拼接",
    "auto_skip_size_mb": "自动跳过超过大小的项目(单位MB),并会在同级目录生成一个大文件清单",
    "project_default_pull_pre_page":"项目默认每次拉取数量,默认100 最大也是100"
  },
  "originGitlab": {
    "username": "用户名",
    "password": "密码",
    "private_token": "gitlab private token"
  },
  "targetGitlab": {
    "username": "用户名",
    "password": "密码",
    "private_token": "gitlab private token",
    "parent_group": "仓库的第一级分组"
  },
  "log": {
    "log_file_path": "日志路径,为空则控制台打印",
    "open_request_log": 打开接口请求的日志 true/false
  }
}

3.3 迁移操作

  • 提供三种迁移方式【迁移用户】、【迁移组】和【迁移项目】,可根据以下的命令进行迁移你想要的数据;
  • Windows环境和Linux环境命令唯一的区别就是多了一个.exe后缀,如果在Windows环境下执行使用 gitlab-sync.exe xxx。

3.3.1 迁移用户

  • 指定用户
./gitlab-sync user -d=zhangsan
  • 全部用户
./gitlab-sync user -d=all

3.3.2 迁移组

  • 指定组
./gitlab-sync group -d=test
#组下的项目一起迁移
./gitlab-sync group -d=test -p=Y
  • 全部组
./gitlab-sync group -d=all
#组下的项目一起迁移
./gitlab-sync group -d=all -p=Y

3.3.3 迁移项目

  • 指定项目
./gitlab-sync project -d=test
  • 全部项目
./gitlab-sync group -d=all
  • 按分页模式迁移(如:一次只迁移第一页的20个项目,或一次迁移第二页的20个项目)
#迁移0-20条
./gitlab-sync project -d=all -p=1 -s=20
#迁移20-40条
./gitlab-sync project -d=all -p=2 -s=20
命令 说明
-p 第几页
-s 条数

4. 注意事项

  • **手动激活用户:**迁移到目标仓库的用户默认是未激活状态,管理员需要登录gitlab系统,手动激活用户。

Snipaste_2023-12-22_10-59-32

Snipaste_2023-12-22_11-03-54

  • **用户密码:**因密码无法同步,所以迁移到目标仓库的用户,使用用户名作为密码(用户名长度大于8位:登录密码同用户名一致,若用户名长度小于8位:用户名+123456 )如下表格所示:
用户名 密码
zhangsan zhangsan
lisi lisi123456
  • 如果目标仓库中已存在相同的用户、组或者项目,迁移时不会覆盖,需要先删除目标仓库中的用户、组和项目然后再迁移。

Gitlab工具集

  • Gitlab-Helper Java语言-导出gitlab仓库内大项目的清单输出到Excel文件。
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

Gitlab-Sync是一款专为解决Gitlab仓库迁移问题而设计的高效、灵活的工具,它可以帮助用户在不丢失数据,轻松的迁移Gitlab中的用户、组、和项目,支持用户根据自己的需求选择迁移指定的用户、组或项目,或者一次性迁移所有用户、组和项目。 展开 收起
Go
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
Go
1
https://gitee.com/alvin-1998/gitlab-sync.git
git@gitee.com:alvin-1998/gitlab-sync.git
alvin-1998
gitlab-sync
Gitlab-Sync
master

搜索帮助