Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/cartersusi/bstore

Blob Storage Server
https://github.com/cartersusi/bstore

blob blob-storage file-download file-hosting file-upload filesystem go home-server server storage

Last synced: 22 days ago
JSON representation

Blob Storage Server

Host: GitHub
URL: https://github.com/cartersusi/bstore
Owner: cartersusi
License: mit
Created: 2024-09-30T23:55:00.000Z (about 1 month ago)
Default Branch: main
Last Pushed: 2024-10-05T02:49:45.000Z (about 1 month ago)
Last Synced: 2024-10-05T06:54:33.686Z (about 1 month ago)
Topics: blob, blob-storage, file-download, file-hosting, file-upload, filesystem, go, home-server, server, storage
Language: Go
Homepage: https://pkg.go.dev/github.com/cartersusi/bstore
Size: 50.3 MB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE
- Support: support/README.md

Awesome Lists containing this project

README

        


  

  Bstore

  A simple blob storage.





  [![bstore](https://img.shields.io/badge/go-bstore-00ADD8?style=flat-square&logo=go)](https://github.com/cartersusi/bstore)

  [![NPM Package](https://img.shields.io/badge/npm-bstorejs-red?style=flat-square&logo=npm)](https://www.npmjs.com/package/bstorejs)

  [![React Package](https://img.shields.io/badge/react-bstorejs--react-61DAFB?style=flat-square&logo=react)](https://www.npmjs.com/package/bstorejs-react)

  [![Demo](https://img.shields.io/badge/demo-bstorejs--demo-brightgreen?style=flat-square)](https://github.com/cartersusi/bstore-demo)



## About 

### **Fast**: 

**1mb** files **encrypted** and **compressed**.

|Storage|Tier|Upload|Download|

|-|-|-|-|

[bstorejs](https://www.npmjs.com/package/bstorejs) | 8c/16t - 1 Gbps | 924 upload/s | 617 download/s|

[@vecel/blob](https://www.npmjs.com/package/@vercel/blob)| Free | 4.1 upload/s | 57 download/s |

[@aws-sdk/client-s3](https://www.npmjs.com/package/@aws-sdk/client-s3)| Free | 5.3 upload/s | 72 download/s |

### **Secure**: 

  * AES 256-bit encryption

### **Efficient**: 

  * zstd compression

### Lightweight:

|OS|Size|

|-|-|

|darwin-amd64|(8.44 MB)|

|darwin-arm64|(8.09 MB)|

|linux-arm64|(7.94 MB)|

|linux-amd64|(8.25 MB)|

## Use Cases

* DIY Movies/TV Server

* PDF Books

* Data Backups

## Build (Recommended)

1. **Clone Repository**

```sh

git clone https://github.com/cartersusi/bstore.git

```

2. **Build For your OS (Requires Go)**

```sh

cd bstore

make build

```

3. **Generate a Config File and Keys**

```go

./bstore -init

```

- **Edit your config file (Optional)**

  ```sh

  nvim ~/.bstore/conf.yml

  ```

- **Print your keys (Optional)**

  ```sh

  cat ~/.bstore/keys.env

  ```

4. **Start Server**

```sh

./bstore

```

- **Use a different config (Optional)**

  ```sh

  ./bstore -config new_conf.yml

  ```

## Install

```sh

curl -fsSL https://cartersusi.com/bstore/install | bash

```

## APIs

- [bstorejs](https://github.com/cartersusi/bstorejs.git) - Express/Vanilla Js/Ts APIs

```sh

npm i bstorejs

```

- [bstorejs-react](https://github.com/cartersusi/bstorejs-react.git) - React Server Actions & Components

```sh

npm i bstorejs-react

```