diff --git a/github_images/homepage.png b/github_images/homepage.png new file mode 100644 index 0000000..ebfb847 Binary files /dev/null and b/github_images/homepage.png differ diff --git a/readme.md b/readme.md index e69de29..f2228cf 100755 --- a/readme.md +++ b/readme.md @@ -0,0 +1,192 @@ +# ![MyDrive Homepage](github_images/homepage.png) + +# MyDrive + +MyDrive is an Open Source Cloud Server (Similar To Google Drive), the service uses mongoDB to store file/folder metadata, and supports multiple databases to store the file chunks, such as Amazon S3, the Filesystem, or just MongoDB. MyDrive is built using Node.js, and Typescript. The service now even supports Docker images! + +## Index + +* [Features](#features) +* [Installation](#installation) +* [Guided Installation](https://github.com/subnub/myDrive/wiki/Guided-Installation-Setup) +* [Guided Installation (Docker)](https://github.com/subnub/myDrive/wiki/Guided-Installation-Setup-(Docker)) +* [WebUI For Encryption Key](#webui-for-encryption-key) +* [Docker](#docker) +* [Environment Variables](#environment-variables) +* [Screenshots](#screenshots) +* [Wiki](https://github.com/subnub/myDrive/wiki) +* [Video](#video) +* [Demo](#demo) +* [Fund/Donate](#fund) + +## Features + +* Upload Files +* Download Files +* Share Files +* Multiple DB Support (MongoDB, S3, Filesystem) +* Photo Viewer +* Video Viewer +* Thumbnails +* One-time download links +* Move Folder/Files +* Mobile Support +* Docker Support +* Search/Filter Options +* AES256 Encryption + +## Installation + +Required: +- Node.js (13+ Recommended) +- MongoDB (Unless using a service like Atlas) + +Windows users will usually need both the microsoft visual build tools, and python 2. These are required to build the sharp module: +- Visual Tools: http://go.microsoft.com/fwlink/?LinkId=691126 +- Python 2: https://www.python.org/downloads/release/python-2717/ + +Linux users will need to make sure they have 'build-essential' installed: +```bash +sudo apt-get install build-essential +``` + +Setup: +>Install Node Modules +``` javascript +npm install +``` + +>Create Environment Variables, Users can use the built in command to easily create the needed Environment files, or view the Environment Variables section to see how to manually create the files. +``` javascript +npm run setup +``` + +>Run the build command +``` javascript +npm run build +``` + +>(Optional) Create the MongoDB indexes, this increases performance. MongoDB must be running for this command to work. +```javascript +npm run create-indexes-database +``` + +>Start the server +``` javascript +npm run start +``` + +## WebUI For Encryption Key + +MyDrive will first host a server on http://localhost:3000 in order to safely get the encryption key, just navigate to this URL in a browser, and enter the encryption key. + +If you're using a service like SSH or a Droplet, you can forward the localhost connection safely like so: +```bash +ssh -L localhost:3000:localhost:3000 username@ip_address +``` + +Note: You can also disable using the webUI for the encryption key by providing a key in the server environment variables (e.g. KEY=password), but this is not recommended because it greatly reduces security. + +## Docker + +MyDrive has built in Docker support, there are two options when using Docker, users can either use the Docker image that has MongoDB built in, or use the Docker image that just has the MyDrive image (If you're using a service like Atlas). + +Create the Docker environment variables by running the 'npm run setup' command as seen in the installation section. Or by manually creating the file (e.g. docker-variables.env on the root of the project, see the environment section for more infomation). + +Docker with mongoDB image: +```bash +docker-compose build +``` + +Docker without mongoDB image: +```bash +docker-compose -f docker-compose-no-mongo.yml build +``` +Start the Docker Image: +```bash +docker-compose up +``` + +## Screenshots + +Upload Files +![MyDrive Upload](github_images/upload-screenshot.png) + +Image Viewer +![Image Viewer](github_images/image-screenshot.png) + +Video Viewer +![Video Viewer](github_images/video-screenshot.png) + +Search For Files/Folders +![Search](github_images/search-screenshot.png) + +Move File/Folders +![Move](github_images/move-screenshot.png) + +Share +![Share](github_images/share-screenshot.png) + +Folders +![Folders](github_images/folder-screenshot.png) + +Mobile +
+ +
+ +## Environment Variables + +You can easily create environment variables using the built in setup tool 'npm run setup', or manually create the files. + +Create a config folder on the root of the project, and create a file with the name prod.env for the server. For the client variables create a .env.production file in the root of the project. + +Docker: If you're using Docker, instead create a file named 'docker-variables.env' on the root of the project. You must also include DOCKER=true in the servers environment variables. + +Server Environment Variables: + +- MONGODB_URL (Required): Sets the MongoDB URL, this should also work with DocumentDB. +- HTTP_PORT (Required): Sets the HTTP port number. +- HTTPS_PORT (Required): Sets the HTTPS port number. +- PASSWORD (Required): Sets the JWT password. +- DB_TYPE (Required): Sets the Database Type, options include s3/mongo/fs. +- NODE_ENV (Required): Must be set to 'production'. +- SSL (Optional): Enables SSL, place certificate.crt, certificate.ca-bundle, and certificate.key at the root of the project. Set this to 'true' +- KEY (Optional): Encryption key for data, this is not recommended, please use the built in webUI for setting the key. +- DOCKER (Optional/Required): Sets the server to use docker, set this to 'true'. +- FS_DIRECTORY (Optional/Required): Sets the directory for file data on the file system. +- S3_ID (Optional/Required): Sets the Amazon S3 ID. +- S3_KEY (Optional/Required): Sets the Amazon S3 Key. +- S3_BUCKET (Optional/Required): Sets the Amazon Bucket. +- ROOT (Optional): Uses a filesystem path, is used for storage space. +- URL (Optional): Allows to specify URL to host on, this is usually not needed. +- USE_DOCUMENT_DB (Optional): Enables documentDB, this is experimental, set this to 'true'. +- DOCUMENT_DB_BUNDLE (Optional): Enables SSL with documentDB, set this to 'true'. +- BLOCK_CREATE_ACCOUNT (Optional): Blocks the ability to create accounts, set this to 'true'. + +Client Environment Variables + +- REMOTE_URL (Required): Sets the Remote URL for the client. +- DISABLE_STORAGE (Optional): Disables storage, use this if you're not using ROOT on the server. + +## Wiki + +For a more detailed list of myDrive features, including examples with images, visit the wiki here: https://github.com/subnub/myDrive/wiki + +## Video + +I created a short YouTube video, showing off myDrives design and features: https://www.youtube.com/watch?v=9tz1f9oDP5I + +## Demo + +Demo: https://mydrive-demo.herokuapp.com/ +- Note: The Upload and Download Features, and other core features, are disabled in the demo. + +## Fund + +Like myDrive? Perhaps you'd like to contribute by funding me through patreon! MyDrive is made by myself, and only myself. I am a 22 year old developer, who goes to school, and work (A non-programming job) so any amount really helps! I hope to do programming as a full time job one day. + +Patreon: https://www.patreon.com/subnub + +## Questions? Feature Requests? Hiring? Contact Me! +Contact Email: kyle.hoell@gmail.com \ No newline at end of file