Files

Jan De Landtsheer bf62e887e8 feat: Create minimal Zero-OS initramfs with console support

- Fixed build system to clone source repositories instead of downloading binaries
- Enhanced scripts/fetch-github.sh with proper git repo cloning and branch handling
- Updated scripts/compile-components.sh for RFS compilation with build-binary feature
- Added minimal firmware installation for essential network drivers (73 modules)
- Created comprehensive zinit configuration set (15 config files including getty)
- Added util-linux package for getty/agetty console support
- Optimized package selection for minimal 27MB initramfs footprint
- Successfully builds bootable vmlinuz.efi with embedded initramfs
- Confirmed working: VM boot, console login, network drivers, zinit init system

Components:
- initramfs.cpio.xz: 27MB compressed minimal Zero-OS image
- vmlinuz.efi: 35MB bootable kernel with embedded initramfs
- Complete Zero-OS toolchain: zinit, rfs, mycelium compiled from source

2025-08-16 23:25:59 +02:00

10 KiB

Raw Blame History

RFS User Guide

This document provides an overview of the commands available in the RFS application and their usage.

Commands

1. Mount

Mount an FL (Flist) to a target directory.

Usage:

rfs mount --meta <path_to_flist> --cache <cache_directory> [--daemon] [--log <log_file>] <target>

Options:

--meta: Path to the metadata file (flist).
--cache: Directory used as a cache for downloaded file chunks (default: /tmp/cache).
--daemon: Run the process in the background.
--log: Log file (only used with daemon mode).
<target>: Target mount point.

2. Pack

Create an FL and upload blocks to the provided storage.

Usage:

rfs pack --meta <path_to_flist> --store <store_url>... [--no-strip-password] <target_directory>

Options:

--meta: Path to the metadata file (flist).
--store: Store URL(s) in the format [xx-xx=]<url>. Multiple stores can be specified.
--no-strip-password: Disable automatic password stripping from the store URL.
<target_directory>: Directory to upload.

3. Unpack

Download the content of an FL to a specified location.

Usage:

rfs unpack --meta <path_to_flist> --cache <cache_directory> [--preserve-ownership] <target_directory>

Options:

--meta: Path to the metadata file (flist).
--cache: Directory used as a cache for downloaded file chunks (default: /tmp/cache).
--preserve-ownership: Preserve file ownership from the FL (requires sudo).
<target_directory>: Directory to unpack the content.

4. Clone

Copy data from the stores of an FL to another store.

Usage:

rfs clone --meta <path_to_flist> --store <store_url>... --cache <cache_directory>

Options:

--meta: Path to the metadata file (flist).
--store: Store URL(s) in the format [xx-xx=]<url>. Multiple stores can be specified.
--cache: Directory used as a cache for downloaded file chunks (default: /tmp/cache).

5. Config

List or modify FL metadata and stores.

Usage:

rfs config --meta <path_to_flist> <subcommand>

Subcommands:

tag list: List all tags.
tag add --tag <key=value>: Add a tag.
tag delete --key <key>: Delete a tag.
store list: List all stores.
store add --store <store_url>: Add a store.
store delete --store <store_url>: Delete a store.

6. Docker

Convert a Docker image to an FL.

Usage:

rfs docker --image-name <image_name> --store <store_url>... [--username <username>] [--password <password>] [--auth <auth>] [--email <email>] [--server-address <server_address>] [--identity-token <token>] [--registry-token <token>]

Options:

--image-name: Name of the Docker image to convert.
--store: Store URL(s) in the format [xx-xx=]<url>. Multiple stores can be specified.
Additional options for Docker credentials (e.g., --username, --password, etc.).

7. Server

Run the FL server.

Usage:

rfs server --config-path <config_file> [--debug]

Options:

--config-path: Path to the server configuration file.
--debug: Enable debugging logs.

8. Upload

Upload a file to a server.

Usage:

rfs upload <file_path> --server <server_url> [--block-size <size>]

Options:

<file_path>: Path to the file to upload.
--server: Server URL (e.g., http://localhost:8080).
--block-size: Block size for splitting the file (default: 1MB).

9. UploadDir

Upload a directory to a server.

Usage:

rfs upload-dir <directory_path> --server <server_url> [--block-size <size>] [--create-flist] [--flist-output <output_path>]

Options:

<directory_path>: Path to the directory to upload.
--server: Server URL (e.g., http://localhost:8080).
--block-size: Block size for splitting the files (default: 1MB).
--create-flist: Create and upload an FL file.
--flist-output: Path to output the FL file.

10. Download

Download a file from a server using its hash.

Usage:

rfs download  <file_hash> --output <output_file> --server <server_url>

Options:

<file_hash>: Hash of the file to download.
--output: Name to save the downloaded file as.
--server: Server URL (e.g., http://localhost:8080).

11. DownloadDir

Download a directory from a server using its FL hash.

Usage:

rfs download-dir <flist_hash> --output <output_directory> --server <server_url>

Options:

<flist_hash>: Hash of the FL to download.
--output: Directory to save the downloaded files to.
--server: Server URL (e.g., http://localhost:8080).

12. Exists

Check if a file or hash exists on the server.

Usage:

rfs exists <file_or_hash> --server <server_url> [--block-size <size>]

Options:

<file_or_hash>: Path to the file or hash to check.
--server: Server URL (e.g., http://localhost:8080).
--block-size: Block size for splitting the file (default: 1MB).

13. flist create

Creates an flist from a directory.

Usage:

rfs flist create <directory> --output /path/to/output.flist --server http://localhost:8080 --block-size 1048576

Options:

<directory>: Path to the directory to create the flist from.
--output: Path to save the generated flist file.
--server: Server URL (e.g., http://localhost:8080).
--block-size: Block size for splitting the files (default: 1MB).

14. Website Publish

Publish a website directory to the server.

Usage:

rfs website-publish <directory_path> --server <server_url> [--block-size <size>]

Options:

<directory_path>: Path to the website directory to publish.
--server: Server URL (e.g., http://localhost:8080).
--block-size: Block size for splitting the files (default: 1MB).

15. Token

Retrieve an authentication token using username and password.

Usage:

rfs token --username <username> --password <password> --server <server_url>

Options:

--username: Username for authentication.
--password: Password for authentication.
--server: Server URL (e.g., http://localhost:8080).

16. Track

Track user blocks on the server and their download statistics.

Usage:

rfs track --server <server_url> --token <auth_token> [--details]

Options:

--server: Server URL (e.g., http://localhost:8080).
--token: Authentication token for the server.
--details: Display detailed information about each block.

17. TrackBlocks

Track download statistics for specific blocks or all blocks.

Usage:

rfs track-blocks --server <server_url> --token <auth_token> [--hash <block_hash>] [--all] [--details]

Options:

--server: Server URL (e.g., http://localhost:8080).
--token: Authentication token for the server.
--hash: Specific block hash to track (conflicts with --all).
--all: Track all blocks (default if no hash is provided).
--details: Display detailed information about each block.

18. TrackWebsite

Track download statistics for a website using its flist hash.

Usage:

rfs track-website <flist_hash> --server <server_url> [--details]

Options:

<flist_hash>: Hash of the website's flist.
--server: Server URL (e.g., http://localhost:8080).
--details: Display detailed information about each block.

Examples

Upload a File:

Upload a file to the server with a custom block size:

rfs upload big_file.txt --server http://localhost:8080 --block-size 2097152

Download a Directory:

Download a directory from the server using its FL hash:
```
rfs download-dir abc123 --output ./mydir --server http://localhost:8080
```
Pack a Directory:

Create an FL from a directory and upload it to a specific store:
```
rfs pack --meta myflist.fl --store http://store.url --target ./mydir
```
Unpack an FL:

Unpack the contents of an FL to a target directory while preserving file ownership:
```
rfs unpack --meta myflist.fl --cache /tmp/cache --preserve-ownership --target ./output
```
Convert a Docker Image to an FL:

Convert a Docker image to an FL and upload it to a store with authentication:
```
rfs docker --image-name redis --store server://http://localhost:4000 --username myuser --password mypass
```

Publish a Website:

Publish a website directory to the server:

rfs website-publish ./website --server http://localhost:8080

Check if a File Exists:

Verify if a file exists on the server using its hash:
```
rfs exists myfilehash --server http://localhost:8080
```
Create an FL from a Directory:

Create an FL from a directory and save it to a specific output path:
```
rfs flist create ./mydir --output ./mydir.flist --server http://localhost:8080
```
Run the FL Server:

Start the FL server with a specific configuration file:
```
rfs server --config-path ./config.yaml --debug
```
List FL Metadata Tags:

List all tags in an FL metadata file:
```
rfs config --meta myflist.fl tag list
```
Add a Tag to FL Metadata:

Add a custom tag to an FL metadata file:
```
rfs config --meta myflist.fl tag add --tag key=value
```
Delete a Tag from FL Metadata:

Remove a specific tag from an FL metadata file:
```
rfs config --meta myflist.fl tag delete --key key
```

Clone an FL to Another Store:

Clone the data of an FL to another store:

rfs clone --meta myflist.fl --store http://newstore.url --cache /tmp/cache

Get an Authentication Token:

Retrieve an authentication token from the server:

```bash
rfs token --username myuser --password mypass --server http://localhost:8080
```

Track User Blocks:

Track all blocks uploaded by the authenticated user:

```bash
rfs track --server http://localhost:8080 --token mytoken
```

Track a Specific Block:

Track download statistics for a specific block:

```bash
rfs track-blocks --server http://localhost:8080 --hash abc123def456
```

Track Website Downloads:

Track download statistics for a published website:
```
rfs track-website abc123def456 --server http://localhost:8080 --details
```

For more details, refer to the documentation or use the --help flag with any command.

10 KiB Raw Blame History

RFS User Guide

Commands

1. Mount

2. Pack

3. Unpack

4. Clone

5. Config

6. Docker

7. Server

8. Upload

9. UploadDir

10. Download

11. DownloadDir

12. Exists

13. flist create

14. Website Publish

15. Token

16. Track

17. TrackBlocks

18. TrackWebsite

Examples

10 KiB

Raw Blame History