2019-02-24 08:23:09 +00:00
|
|
|
# nas
|
|
|
|
small go nas platform for my raspberry pi
|
2019-02-24 18:10:08 +00:00
|
|
|
|
2019-02-24 22:51:40 +00:00
|
|
|
## usage
|
|
|
|
|
2020-03-15 23:48:37 +00:00
|
|
|
### configuration
|
|
|
|
|
|
|
|
unlike the initial version of this project, the current build uses _providers_ to determine how to handle various
|
|
|
|
functions related to files. currently, two are implemented, `disk` and `backblaze`, since they are the primary providers
|
|
|
|
i use myself. the providers you would like to use can be added to `providers.yml` alongside the binary.
|
|
|
|
|
|
|
|
for example, here is a sample configuration implementing both of them:
|
|
|
|
|
|
|
|
```yaml
|
|
|
|
disk:
|
|
|
|
provider: disk
|
|
|
|
path: /tmp/nas
|
|
|
|
backblaze:
|
|
|
|
provider: backblaze
|
|
|
|
config:
|
|
|
|
appKeyId: APP_KEY_ID
|
|
|
|
appId: APP_ID
|
|
|
|
bucket: BUCKET_ID
|
2019-02-24 22:51:40 +00:00
|
|
|
```
|
|
|
|
|
2020-03-15 23:48:37 +00:00
|
|
|
(read more here: [#providers](#providers))
|
|
|
|
|
|
|
|
### running
|
|
|
|
|
|
|
|
after adding the providers you would like to use, the application can be run simply with `./nas`.
|
|
|
|
|
|
|
|
### building
|
2019-02-24 22:51:40 +00:00
|
|
|
|
2020-03-15 23:48:37 +00:00
|
|
|
this project uses go modules and a makefile, so building should be relatively straightforward.
|
|
|
|
|
|
|
|
- `make` will build the project for your system's architecture.
|
|
|
|
- `make pi` will build the project with the `GOOS=linux GOARCH=arm GOARM=5 go` flags set for raspberry pis.
|
2019-02-24 22:51:40 +00:00
|
|
|
|
2019-03-03 01:41:13 +00:00
|
|
|
## api
|
|
|
|
|
|
|
|
initially the heavy lifting was done by the server, but the need for a better frontend was clear.
|
|
|
|
|
2019-04-02 06:43:57 +01:00
|
|
|
full documentation coming soon once actual functionality has been nailed down.
|
|
|
|
|
2020-03-15 23:48:37 +00:00
|
|
|
## providers
|
|
|
|
|
|
|
|
// todo
|
|
|
|
|
2019-02-24 18:10:08 +00:00
|
|
|
## credits
|
|
|
|
|
|
|
|
svg icons via https://iconsvg.xyz
|
|
|
|
|
2019-04-02 06:43:57 +01:00
|
|
|
raspberry pi svg via https://www.vectorlogo.zone/logos/raspberrypi/index.html
|