arch/sliproad
1
0
Fork 0
mirror of https://github.com/gmemstr/sliproad.git synced 2024-09-20 00:21:15 +01:00
Code Issues Packages Projects Releases Wiki Activity

Add example config, adding instructions to README.

Browse source
This commit is contained in:
Gabriel Simmer 2019-02-24 14:51:40 -08:00
parent 23177b6b54
commit bd6b7c86b2
No known key found for this signature in database
GPG key ID: 0394452F45EF2817
2 changed files with 20 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -1,6 +1,22 @@
# 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`
## credits
svg icons via https://iconsvg.xyz

4
assets/config/config.example.json Normal file
View file

@ -0,0 +1,4 @@
{
"ColdStorage": "",
"HotStorage": ""
}