Skip to content

iQuickDev/OpenCloud

Repository files navigation

OpenCloud

The repository contains both the frontend and the backend files, this readme file illustrates how to properly set the server up.

Building

In order to build the project all you need to do is enter the directory and run bash build.sh, the script will update, install and create all the files required by the server to run. This step may be skipped by downloading the current release which already contains the production build.

Setup

As of now the server uses a .env configuration file where you can specify your parameters. The server requires a MongoDB database on the MongoDB Atlas (locally hosted DBs will be implemented in a future release).

MONGO_USERNAME is the variable that will be used as username to log into the database
MONGO_PASSWORDE is the variable that will be used as password to log into the database
JWT_PRIVATE_KEY is a string that will be used to make sessions, it works as an encryption key to sign the tokens
PORT defines on which port your server will be running (defaults to 5555)
FILES_FOLDER is the directory that will store all the files you upload on the cloud
NODE_ENV defines if the server is running in development or production mode (it is recommended to leave it untouched)

Known bugs

[CRITICAL] The embedded terminal allows escaping from the files directory

Showcase

The Login (animated)

login

The Dashboard

dashboard

The Terminal

terminal