24 lines
694 B
Markdown
24 lines
694 B
Markdown
|
# TinyFUI
|
||
|
|
|
||
|
|
A tiny web File UI
|
||
|
|
|
||
|
|
## Using
|
||
|
|
|
||
|
|
### Setup
|
||
|
|
|
||
|
|
1. Download or compile the `tinyfui` binary.
|
||
|
|
|
||
|
|
2. Download or create your own templates and styles for the share pages. Static assets can be placed in the `assets/` folder, and templates go in `templates/`. See the example templates in this repository for details.
|
||
|
|
|
||
|
|
1. Create a folder named `shares/` to store all your shares.
|
||
|
|
|
||
|
|
2. Run the server with `tinyfui web --listen 127.0.0.1:3000`
|
||
|
|
|
||
|
|
### Creating a share
|
||
|
|
|
||
|
|
1. Run `tinyfui create-share "<name>"`
|
||
|
|
|
||
|
|
2. Add your files to the newly created folder in `shares/`
|
||
|
|
|
||
|
|
3. Run `tinyfui update-shares` to register the new files. You must re-run this when you update the contents of any of your shares.
|