zrok/docs/concepts/files.md
Rui Chen ed7f19dc9c
chore: normalize encoding for the text files
Signed-off-by: Rui Chen <rui@chenrui.dev>
2024-02-12 21:00:52 +01:00

1.6 KiB

title sidebar_position
Sharing Websites and Files 30

With zrok it is possible to share files quickly and easily as well. To share files using zrok use the --backend-mode web, for example: zrok share private . --backend-mode web.

Running with this mode will make it trivially easy to share files from the directory which the command was run from.

For example if you have a directory with a structure like this:

-rw-r--r--+ 1 Michael None     7090 Apr 17 12:53 CHANGELOG.md
-rw-r--r--+ 1 Michael None    11346 Apr 17 12:53 LICENSE
-rw-r--r--+ 1 Michael None     2885 Apr 17 12:53 README.md
-rwxr-xr-x+ 1 Michael None 44250624 Apr 17 13:00 zrok.exe*

The files can be shared using a command such as:

zrok share public --backend-mode web .

Then the files can be access with a private or public share, for example as shown:

zrok_share_web_files

zrok will automatically provide a stock website, which will allow the accessing user to browse and navigate the file tree. Clicking the files allows the user to download them.

zrok can also share a pre-rendered static HTML website. If you have a directory like this:

-rw-rw-r--+ 1 Michael None 56 Jun 26 13:23 index.html

If index.html contains valid HTML, like this:

<html>
<body>
        <h1>Hello <code>zrok</code></h1>
</html>

Sharing the directory will result in the following when you access the share in a web browser:

zrok_share_web_website

zrok contains a built-in web server, which you can use to serve static websites as a share.