An open-source web file browser in one binary: run it in a folder and browse every file in your browser, with previews and instant search.
Try it in your browser · okfs.jrnxf.co
okfs ("ok file server") serves a folder as a keyboard-driven web file browser. The page is compiled into the binary and loads nothing from another site: a dense list, a preview of whatever is under the cursor, and a search of every name in the tree.
brew install jrnxf/tap/okfs # macOS or Linux
nix run github:jrnxf/okfs # or run it once with nix
docker run -p 8080:8080 -v "$PWD:/srv:ro" ghcr.io/jrnxf/okfs
cargo install --git https://github.com/jrnxf/okfs
Release archives for Linux, macOS and Windows are on the releases page. See docs/install.md for them, Docker, building from source and platform notes.
okfs ~/photos # serve a folder and open it in the browser
okfs --bind 0.0.0.0 --qr # let a phone on the same network in, with a QR code to scan
okfs --help # every flag, with examples
okfs listens on 127.0.0.1:8080 and opens the page. Press ? in it for the keys, and Ctrl K or Cmd K to find any file in the tree. Every flag also reads from an OKFS_* environment variable. See docs/usage.md for the flags, keys and stable addresses.
- Previews for images, video, audio, PDF, Markdown, source code, CSV, JSON, zip files and HTML pages. Hold
jand each file shows as the cursor passes it. - A palette that finds any file in the whole tree at once, from an index kept in memory.
- Columns that show what is inside the folder under the cursor. The page follows the folder as files change, with no reload.
- Eleven built-in themes, each one CSS file: themes.
- Read only unless you turn writes on:
--allow-upload,--allow-editand--allow-deleteare separate flags. A delete goes to a Trash for 30 days, with Undo. There are no accounts. Writing. - Loopback by default. Beyond it, only a link with a key that okfs prints gets in, and
--tls-certserves HTTPS. Network.
- Install: every way to get okfs
- Using okfs: flags, environment, keys, addresses, big folders
- Network: the key, HTTPS, proxies, systemd and launchd
- Writing: uploading, editing, deleting and the Trash
- Themes and what is safe to serve
- How okfs compares and developing it
okfs is released under the MIT License. See LICENSE. Bundled fonts and other work are credited in THIRD_PARTY.md.