kylehoell/mydrive repository overview

‎ ‎ ‎

Download⁠

⁠☁️ MyDrive

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.

Website⁠ | Live demo⁠

⁠🔍 Index

• Features⁠
• Tech stack⁠
• Running⁠
  • Docker⁠
  • Non-Docker⁠
• Common installation issues⁠
• Screenshots⁠
• Video⁠
• Live demo⁠
• Feature requests/bug reports⁠
• Updating from a previous version of myDrive⁠
• Known issues and future improvments⁠

⁠⭐️ 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
• Jest

⁠Running

⁠🐳 Docker

⁠Docker Compose

1. Make folder for docker-compose.yml and env file.
2. Copy docker-compose.yml⁠ and .env.example⁠ to your directory.
3. Rename .env.example to .env and fill in / change the values.
4. Run the following command:

docker compose up -d

1. Access the app at http://localhost:3000

⁠Docker Run

1. Pull the image

docker pull kylehoell/mydrive:latest

1. Run the image

Using .env file. Copy the .env.example file and fill in the values.

docker run -d \
  -p 3000:3000 \
  --env-file ./.env \
  -v /path/example/mydrive/data/:/data/ \
  -v /path/example/mydrive/temp/:/temp/ \
  --name mydrive \
  kylehoell/mydrive:latest

Or directly pass in the environment variables

docker run -d \
  -p 3000:3000 \
  -e MONGODB_URL=mongodb://127.0.0.1:27017/mydrive \
  -e DB_TYPE=fs \
  -e PASSWORD_ACCESS=secretaccesspassword \
  -e PASSWORD_REFRESH=secretrefreshpassword \
  -e PASSWORD_COOKIE=secretcookiepassword \
  -e KEY=encryptionkey \
  -e VIDEO_THUMBNAILS_ENABLED=true \
  -e TEMP_VIDEO_THUMBNAIL_LIMIT=5000000000 \
  -v /path/example/mydrive/data/:/data/ \
  -v /path/example/mydrive/temp/:/temp/ \
  --name mydrive \
  kylehoell/mydrive:latest

1. Access the app at http://localhost:3000

⁠💻 Non - Docker

1. Install dependencies

npm install

1. 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.

1. Run the build command

npm run build

1. 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⁠.

⁠📸 Screenshots

Modern and colorful design

Upload Files

Download Files

Image Viewer

Video Viewer

Media Gallery

Share Files

Search For Files/Folders

Move File/Folders

Multi-select

Custom context menu

Trash

⁠🎥 Video

I created a short YouTube video, showing off myDrives design and features:

⁠🕹️ 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.

Also this is just a 512mb RAM droplet go easy on her.

⁠👾 Bug reports and feature requests

Please only open issues for actual bugs, feature requests or discussions should happen in Discussions or via my email.

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.

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 (This may be a current iOS limitation and not a myDrive issue).
• 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

• OIDC Support (Top priority)
• Option to disable encryption
• File sync from a local device
• An alternative to using mongoDB
• Dark mode
• Enhance service worker, currently only caches thumbnails. This includes potentially adding offline support.
• Typescript type cleanup
• Better error handling
• Logging
• More test coverage (currently only basic backend tests)
• Some tailwind classes still need some slight tweaking