sliproad/README.md
Gabriel Simmer 88e0d6c7b1
Add disk usage statistics to index & API.
Update README.md

Add disk usage statistics to index & API.
2019-04-01 22:45:33 -07:00

31 lines
743 B
Markdown

# nas
small go nas platform for my raspberry pi
## usage
```
cp assets/config/config.example.json assets/config/config.json
# edit config file with your hot/cold storage locations
nano assets/config/config.json
# run
go run webserver.go
# or build and run
go build; ./nas
```
you can also optionally use the `build-pi.sh` to build it for a raspberry pi (tested with raspberry pi 3 model b+)
then navigate to `localhost:3000`
## api
initially the heavy lifting was done by the server, but the need for a better frontend was clear.
full documentation coming soon once actual functionality has been nailed down.
## credits
svg icons via https://iconsvg.xyz
raspberry pi svg via https://www.vectorlogo.zone/logos/raspberrypi/index.html