Skip to content

Commit 18481d8

Browse files
committed
doc: update docs
1 parent 9ede5ce commit 18481d8

File tree

4 files changed

+41
-53
lines changed

4 files changed

+41
-53
lines changed

README.md

Lines changed: 36 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -8,47 +8,52 @@
88

99
![](https://img.shields.io/badge/Powered%20By-GNU%20C-00d000?style=flat&labelColor=gray&logo=C)
1010

11+
# WARNING:
12+
```
13+
* Your warranty is void.
14+
* I am not responsible for anything that may happen to your device by using this program.
15+
* You do it at your own risk and take the responsibility upon yourself.
16+
* This project is open source, you can make your own fork/rewrite but not to blame the author.
17+
* Docker is a registered trademark of Docker, Inc. This program has no relationship with it.
18+
* This program has no Super Cow Powers.
19+
```
20+
This project does not follow OCI standard and can only be a `PARTIAL` replacement of docker, this project is still under development.
21+
For Android users, You might need to root your phone before using rurima, some container might not work properly with proot.
22+
# Features:
23+
- Get rootfs images from dockerhub or LXC mirror.
24+
- Automatic parse docker image config and convert to ruri cmdline.
25+
- Unpack rootfs images with or without root privileges.
26+
- Backup/Restore rootfs with tar.
27+
- Built-in container runtime by ruri.
28+
- Static binary for multiple architectures.
29+
- Built-in OTA(upgrade) feature.
30+
31+
In a word, rurima is a lightweight container implementation, it tries to get the most features of docker with the least dependencies, even when your kernel does not support cgroups or namespaces.
32+
33+
# Terms of Use:
34+
See [TERMS_OF_USE.md](TERMS_OF_USE.md)
35+
# Full usage doc:
36+
For a full usage documentation,
37+
See [USAGE.md](doc/USAGE.md).
1138
# Send us your feedback!
12-
Your use case, your suggestions, and some ideas, anyway, we would love to hear from you!
39+
Your use case, your suggestions, anyway, we would love to hear from you!
1340
[Discussions](https://github.com/RuriOSS/rurima/discussions/16)
1441
# Also, keep up to date:
1542
Some updates and news will be posted on:
1643
[Twitter(X)](https://x.com/RuriOSS)
17-
And, dont forget to `rurima ota` to get the latest build!
44+
And, don't forget to `rurima ota` to get the latest build!
1845
# What's new:
19-
- Some other OCI compatible registry support like ghcr.io could work with `-f/--fallback` option enabled now.
20-
# The first release:
21-
v0.9.0 is the first release of rurima, some feature are still WIP, but it is already usable as the extended version of ruri.
46+
- We have a unified `pull` command to get images from dockerhub or LXC mirror now.
47+
- Some other OCI compatible registry like ghcr.io could work with `-f/--fallback` option enabled now.
2248
# Backward compatibility:
2349
We promise that rurima has backward compatibility of documented parts since v0.9.x, all unstable parts will be explicitly marked as WIP or unstable, and ruri has already been backward compatible. Users can always keep `rurima ota` to get the latest build.
2450
For any issue, please notify us, and we will fix it ASAP.
2551
# About:
2652
So, what is rurima?
2753
The enhanced version of ruri.
28-
ruri only focus on running container, but rurima can also provide the function of getting rootfs image and backup/restore.
54+
[ruri](https://github.com/Moe-hacker/ruri) only focus on running container, but rurima can also provide the function of getting rootfs image and backup/restore.
2955
And it will be a more powerful container manager in the fulture.
3056
With the `docker` and `lxc` subcommand of rurima, you can search & get & unpack images from dockerhub or LXC mirror easily.
31-
## Not Only Ruri Container Manager:
32-
Rurima was planned to be the ruri container manager, but as rurima has a full integration of ruri now, you can just use it as a more powerful version of ruri, although the container manager function is still WIP.
33-
For more info about ruri, see [ruri](https://github.com/Moe-hacker/ruri)
34-
## Note & WIP:
35-
This project does not follow OCI and can only be a `PARTIAL` replacement of docker, this project is still under development.
36-
## Terms of Use:
37-
See [TERMS_OF_USE.md](TERMS_OF_USE.md)
38-
## For Android user:
39-
You might need to root your phone before using rurima, some container might not work properly with proot.
40-
# Full usage doc:
41-
For a full usage documentation,
42-
See [USAGE.md](doc/USAGE.md)
43-
# WARNING:
44-
```
45-
* Your warranty is void.
46-
* I am not responsible for anything that may happen to your device by using this program.
47-
* You do it at your own risk and take the responsibility upon yourself.
48-
* This project is open source, you can make your own fork/rewrite but not to blame the author.
49-
* Docker is a registered trademark of Docker, Inc. This program has no relationship with it.
50-
* This program has no Super Cow Powers.
51-
```
5257
# Download:
5358
You can get rurima binary (staticly linked) for arm64, armv7, armhf, riscv64, i386, loong64, s390x, ppc64le and x86_64 from the release page.
5459
Or run the follwing command to get rurima to ./rurima and ./rurima-dbg(debug version):
@@ -72,28 +77,11 @@ For Alpine based system, run:
7277
```
7378
apk add wget curl jq coreutils file proot tar xz gzip
7479
```
75-
76-
# The new pull subcommand:
77-
It's a wrap of docker/lxc pull subcommand.
78-
For example:
79-
```sh
80-
rurima pull alpine:edge ./test
81-
```
82-
```sh
83-
rurima pull whyour/qinglong ./test
84-
```
85-
```sh
86-
rurima pull ubuntu ./test
87-
```
88-
It will search lxc image first, if not found, it will auto try to pull rootfs from dockerhub.
8980
# About suid or caps:
9081
Rurima does not allow to set any suid/sgid (with root) or capability on it, it will check it in main() and error() if detected these unsafe settings.
9182
So, please always use sudo instead.
9283
# Reporting bugs:
9384
Please use the debug version(rurima-dbg) in release to get debug logs, and please tell me the command you run to cause the unexpected behavior you think!
94-
# NOTICE:
95-
This program is not official tool of docker or dockerhub, you can report bugs here, but this program has no relation with docker.
96-
Docker is a registered trademark of Docker, Inc.
9785
# Dependent:
9886
rurima needs tar, xz, gzip, file, you can find these static binary for aarch64, armv7, x86_64, i386 or riscv64 in:
9987
[tar-static](https://github.com/Moe-sushi/tar-static)
@@ -118,9 +106,11 @@ https://mirrors.tuna.tsinghua.edu.cn/alpine/edge/testing/aarch64/proot-static-5.
118106
```
119107
and finally, tar -xvf *.apk to unpack it. So you got proot.static, rename it to proot and put it in your $PATH.
120108
# TODO:
121-
Manage ruri containers and configs.
122-
Config support, a bit like Dockerfile.
109+
110+
Manage ruri containers and configs.
111+
sfx pack for container images.
123112
....
113+
124114
---------
125115

126116
<p align="center">「僕らタイムフライヤー</p>
File renamed without changes.

doc/USAGE.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
1-
# Warning:
2-
Since rurima has not released v1.0, some usage/features may change in the future.
31
# Undocumented part:
4-
The `run` and `netns` subcommand is WIP, it should not be used by users.
2+
The `load`, `run`, `sfx` and `netns` subcommand is WIP, it should not be used by users.
53
# Image source:
64
rurima currently supports both lxc-mirror and dockerhub as container image source.
75
# Unified image puller:
@@ -13,7 +11,7 @@ rurima pull alpine:edge ./test
1311
# pull hello-world to ./hello:
1412
rurima pull hello-world ./hello
1513
```
16-
it's a bit like cmdline of docker, but, it will try lxc-mirror first if it found that the image is available there.
14+
it's a bit like cmdline of docker, but, it will try lxc-mirror first, and auto switch to dockerhub if the image is not in lxc-mirror.
1715
## Full options:
1816
```
1917
Usage: rurima pull <options> [image]:[version] [savedir]
@@ -96,7 +94,7 @@ You can add your perfered mirrors for `-T` option to try them first, for example
9694
`-i` and `-t` is required options for `config` and `pull` subcommand.
9795
`-i` is also used for `search` subcommand for image name.
9896
# lxc subcommand:
99-
# Full usage:
97+
## Full usage:
10098
```
10199
Usage: rurima lxc [subcommand] [options]
102100
Subcommands:
@@ -117,5 +115,5 @@ Options:
117115
Note: please remove `https://` prefix from mirror url.
118116
For example: `-m images.linuxcontainers.org`
119117
```
120-
# Note:
118+
## Note:
121119
`-o`, `-s` and `-v` is required options for `pull` subcommand.

src/ssfx

0 commit comments

Comments
 (0)