Lcs-cloud-storage NPM

lcs-cloud-storage server

Visit Documentation website ↗

About

LCS - is a local cloud storage server. The Local Cloud Storage Server project aims to develop a robust and secure local cloud storage solution. This system will provide users with the ability to store, retrieve, and manage their data locally while enjoying the benefits of cloud storage such as scalability, accessibility, and reliability.

The server will expose a RESTful API that allows users to interact with the storage. This API will support operations such as uploading files, downloading and all default filesystem operations.

In addition to the API, the system will provide a Command Line Interface (CLI). This will enable users to use server feature or to configure it.

Getting started

Prerequisites

yarn npm i -g yarn or corepack enable

!IMPORTANT Node.js 18.x+ version must be installed in your OS.

Installation

Clone the repository

$ git clone https://github.com/stbestichhh/lcs-cloud-storage-server.git

Install dependencies

$ yarn install

Or install as NPM package

$ npm i -g lcs-cloud-storage

Deployment

Start the server to production

From cli
See usage instructions to find out how to use cli
```
$ lcs [options] server|run [options]
```
From source code
```
$ yarn build
$ yarn start:prod
```

Without installing

Run default configuration

$ docker build -t lcs-cloud-storage:0.0.5 .
$ docker run -p <port>:9110 lcs-cloud-storage:0.0.5

Override configuration

$ docker build -t lcs-cloud-storage:0.0.5 .
$ docker run -e PORT=<port> -e HOST=<host> -e SECRET_KEY=<jwtkey> -e DB_NAME=<dbname> -p <port>:<port> lcs-cloud-storage:0.0.5 node dist/index.js [options] [command]

Overriding every enviroment variable is not necessary. Options and command see in usage section.