Skip to content

Commit 1c76bb4

Browse files
committed
feature(main): add readme
Signed-off-by: cuisongliu <[email protected]>
1 parent 1e35ea2 commit 1c76bb4

File tree

2 files changed

+116
-1
lines changed

2 files changed

+116
-1
lines changed

README.md

+58-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,58 @@
1-
# sreg
1+
# sreg - Sealos Registry Tool
2+
3+
sreg is a tool focused on managing Sealos registry. Its goal is to provide a solution that doesn't rely on buildah, allowing for more flexible image management and support for Sealos deployments.
4+
5+
## Installation
6+
7+
You can install sreg by following these steps:
8+
9+
1. Download the latest version of the sreg release package for your operating system: [sreg](https://github.com/labring/sreg/releases)
10+
11+
2. Extract the downloaded release package:
12+
```sh
13+
tar -xzf sreg_0.1.1_linux_amd64.tar.gz
14+
```
15+
16+
3. Move the extracted executable to your PATH for global access:
17+
```sh
18+
sudo mv sreg /usr/local/bin/
19+
```
20+
21+
## Usage
22+
23+
### Save an Image to a Local File
24+
```sh
25+
sreg save --registry-dir=/tmp/registry1 my-context
26+
```
27+
28+
### Start a Filesystem Image Repository Service
29+
```sh
30+
sreg serve filesystem --port=5000
31+
```
32+
33+
### Start an In-Memory Image Repository Service
34+
```sh
35+
sreg serve inmem --port=5000
36+
```
37+
38+
### Sync an Image to a Different Repository
39+
```sh
40+
sreg sync source-image dst
41+
```
42+
43+
### Copy an Image to a Different Repository
44+
```sh
45+
sreg copy source-image dst
46+
```
47+
48+
## Building Your Own Version
49+
50+
If you wish to build your own version of sreg, you can use [goreleaser](https://goreleaser.com/) for building. Use the following command to build:
51+
52+
```sh
53+
goreleaser build --snapshot --timeout=1h --rm-dist
54+
```
55+
56+
## Why Choose sreg?
57+
58+
sreg's development aims to meet the need for image repository management in Sealos deployments without relying on buildah. It offers a more flexible and secure image management approach. Whether you require stricter image security or more controlled image distribution, sreg is an ideal choice.

README_zh.md

+58
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# sreg - Sealos 镜像仓库工具
2+
3+
sreg 是一个专注于 Sealos 镜像仓库管理的工具,它的目标是提供一个不依赖于 buildah 的解决方案,以便更灵活地管理镜像,并为 Sealos 部署提供支持。
4+
5+
## 安装
6+
7+
您可以通过以下步骤来安装 sreg:
8+
9+
1. 下载适用于您的操作系统的最新版本 sreg 发布包:[sreg](https://github.com/labring/sreg/releases)
10+
11+
2. 解压下载的发布包:
12+
```sh
13+
tar -xzf sreg_0.1.1_linux_amd64.tar.gz
14+
```
15+
16+
3. 将解压后的可执行文件移动到您的 PATH 中,以使其可以全局访问:
17+
```sh
18+
sudo mv sreg /usr/local/bin/
19+
```
20+
21+
## 使用方法
22+
23+
### 保存镜像到本地文件
24+
```sh
25+
sreg save --registry-dir=/tmp/registry1 my-context
26+
```
27+
28+
### 启动文件系统镜像仓库服务
29+
```sh
30+
sreg serve filesystem --port=5000
31+
```
32+
33+
### 启动内存中的镜像仓库服务
34+
```sh
35+
sreg serve inmem --port=5000
36+
```
37+
38+
### 同步镜像到不同仓库
39+
```sh
40+
sreg sync source-image dst
41+
```
42+
43+
### 复制镜像到不同仓库
44+
```sh
45+
sreg copy source-image dst
46+
```
47+
48+
## 构建自己的版本
49+
50+
如果您希望构建自己的 sreg 版本,您可以使用 [goreleaser](https://goreleaser.com/) 进行构建。使用以下命令进行构建:
51+
52+
```sh
53+
goreleaser build --snapshot --timeout=1h --rm-dist
54+
```
55+
56+
## 为什么选择 sreg?
57+
58+
sreg 的开发旨在满足在 Sealos 部署中无需依赖 buildah 的镜像仓库需求,提供了更灵活和安全的镜像管理方式。无论您需要更严格的镜像安全性还是更受控的镜像分发,sreg 都是理想的选择。

0 commit comments

Comments
 (0)