mirror of
https://github.com/gmemstr/sliproad.git
synced 2024-09-20 00:21:15 +01:00
Add example config, adding instructions to README.
This commit is contained in:
parent
23177b6b54
commit
bd6b7c86b2
16
README.md
16
README.md
|
@ -1,6 +1,22 @@
|
||||||
# nas
|
# nas
|
||||||
small go nas platform for my raspberry pi
|
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`
|
||||||
|
|
||||||
## credits
|
## credits
|
||||||
|
|
||||||
svg icons via https://iconsvg.xyz
|
svg icons via https://iconsvg.xyz
|
||||||
|
|
4
assets/config/config.example.json
Normal file
4
assets/config/config.example.json
Normal file
|
@ -0,0 +1,4 @@
|
||||||
|
{
|
||||||
|
"ColdStorage": "",
|
||||||
|
"HotStorage": ""
|
||||||
|
}
|
Loading…
Reference in a new issue