Skip to content

Latest commit

 

History

History
executable file
·
249 lines (163 loc) · 5.8 KB

readme.md

File metadata and controls

executable file
·
249 lines (163 loc) · 5.8 KB

MyDrive Homepage

☁️ MyDrive

MyDrive is an Open Source cloud file storage server (Similar To Google Drive). Host myDrive on your own server or trusted platform and then access myDrive through your web browser. MyDrive uses mongoDB to store file/folder metadata, and supports multiple databases to store the file chunks, such as Amazon S3, or the Filesystem.

Main myDrive website

Live demo

🔍 Index

⭐️ Features

  • Upload Files
  • Download Files
  • Upload Folders
  • Download Folders (Automatically converts to zip)
  • Multiple DB Support (Amazon S3, Filesystem)
  • Photo, Video Viewer and Media Gallery
  • Generated Photo And Video Thumbnails
  • File Sharing
  • PWA Support
  • AES256 Encryption
  • Service Worker
  • Mobile Support
  • Docker
  • Email Verification
  • JWT (Access and Refresh Tokens)

👨‍🔬 Tech Stack

  • React
  • Typescript
  • Node.js
  • Express
  • MongoDB
  • Vite

💻 Installation

Required:

  • Node.js (20 Recommended)
  • MongoDB (Unless using a service like Atlas)
  • FFMPEG (Optional, used for video thumbnails)
  • build-essential package (If using linux)

Setup (Non Docker Method):

Install Node Modules

npm install

Create Environment Variables:

You can find enviroment variable examples under:

backend/config -> Backend Enviroment Variables
src/config -> Frontend Enviroment Variables

Simply remove the .example from the end of the filename, and fill in the values.


Run the build command

npm run build

Start the server

npm run start

Possible installation issues

Make issue

npm error gyp ERR! stack Error: not found: make

This is because you do not have the build essentials installed which is required for Linux. You can install them by running the following command:

sudo apt-get install build-essential

Memory issue

Aborted (core dumped)

When running the npm run build command it may take more memory than node allows by default. You will get the above error in such a case. To fix this, you can run the following command instead when building:

NODE_OPTIONS="--max-old-space-size=4096" npm run build

You can read more about this issue here.

🐳 Docker

Setup:

Create Environment Variables:

You can find enviroment variable examples under:

backend/config -> Backend Enviroment Variables
src/config -> Frontend Enviroment Variables

Simply remove the .example from the end of the filename, and fill in the values.


Start the Docker image

npm run docker:production

📸 Screenshots

Modern and colorful design MyDrive Design

Upload Files MyDrive Upload

Download Files MyDrive Upload

Image Viewer Image Viewer

Video Viewer Video Viewer

Media Gallery Search

Share Files Share

Search For Files/Folders Search

Move File/Folders Move

Trash Trash

🎥 Video

I created a short YouTube video, showing off myDrives design and features: (Coming soon)

🕹️ Live demo

Demo

Note: Creating, deleting and other features are disabled in the demo. Also the service worker is not enabled in the demo, images thumbnails are not cached because of this.

👾 Bug reports and Feature Requests

Contact Email: [email protected]

⬆️ Updating from a previous version of myDrive

If you are upgrading from myDrive 3 there is some data migration and scripts you must run for myDrive 4 to work properly.

Run the migration script
Note: Make sure you have env variables set

npm run migrate-to-mydrive4

Also, if you are updating from myDrive 3, or if you did not have video thumbnails enabled and would like to enable them now you can do so by running the following command:
Note: Make sure you have video thumbnails enabled in your env variables and FFMPEG installed.

npm run create-video-thumbnails

🔮 Known issues and future improvments

Issues

  • Video streaming does not always work, especially on Safari.
  • PWA downloads does not work on iOS.
  • Upload folder will sometimes fail on complex folder structures.
  • Generating video thumbnails with the default method will often fail, requiring the whole file to be downloaded to temporary storage and then the thumbnail generated from that.

Future improvments

  • An alternative to using mongoDB
  • Typescript type cleanup
  • Better error handling
  • Logging
  • More test coverage (currently only basic backend tests)
  • Some tailwind classes still need some slight tweaking