A multi-functional platform integrating file storage, editing, communication, entertainment and system management.
- Create, Delete, Rename, Move, and Export folders
- Upload, Download, Create, Delete, Move, Rename, and Share files
- Supports OnlyOffice (Word, Excel, PowerPoint) online editing and multi-user collaborative editing
- Supports online editing functions of txt, markdown, xmind, sheet, and document
- Support online editing and running of python scripts
- Support add desktop shortcuts for files
- Support auto-backup of all files in the specified folder
- Support remote connection to Linux server
- Support peer-to-peer video chat and screen sharing (based on WebRTC)
- Music player, supports playing music from this cloud-drive (Server) and local (Client)
- Karaoke, supports building your own song library
- Integrate aria2, and support multiple download protocols such as HTTP, FTP, BitTorrent, etc.
- Add game center, supports Snake, tetris games (plans to support more games in the future).
- Support restart and automatic update
- Supports multiple languages and supports configuration of multiple languages
- Single sign-on, data of different users is completely isolated
- Support PWA, it can be installed on the mobile
- Multiple disks can be mounted arbitrarily
View detailed page style, Please click me.
- Framework: FastApi
- Database: SQLite3 or MySQL
- Front-end: html + js + css
See the blog for detailed deployment steps
1.Clone git clone https://github.com/leeyoshinari/WinHub.git ;
2.cd WinHub, and check configuration in config.conf；
Note: If you need the restart and automatic update functions, you need to set the configuration that needs to be modified in config.conf as system environment variables. See below for configuration details.
3.Install third-party packages
pip3 install -r requirements.txtNote: If you use Windows system, you need to install pywin32 package, run command: pip install pywin32。
4.Initialize the database and execute the following commands in sequence
aerich init -t settings.TORTOISE_ORM
aerich init-db5.Install download tool aria2, running aria2c -v to verify whether the installation is successful.
6.Startup
sh startup.sh7.Create user
In order to avoid malicious creation of users by others, the page does not open the entrance to create users. So, you can create a user in the API interface documentation, entering the swagger-ui page and finding the createUser interface.
http://IP:Port/ prefix IN config.conf /swagger-ui8.Configure and start nginx, the location configuration is as follows:
(1)Front-end configuration: The front-end file is in web, /Windows can be modified to any name you like.
location /Windows {
alias /home/WinHub/web/;
index index.html;
}(2)Backend request: proxy_pass is the IP and port in config.conf, /mycloud must be the same as prefix in config.conf.
location /mycloud {
proxy_pass http://127.0.0.1:15200;
proxy_set_header Host $proxy_host;
proxy_set_header lang $http_lang;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection $proxy_connection;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
}(3) In the http module, a mapping need to be add.
map $http_upgrade $proxy_connection {
default upgrade;
"" close;
}（4）Swagger page
location /api/openapi {
proxy_pass http://127.0.0.1:15200;
}Usually nginx will limit the size of the request body, and you need to add client_max_body_size 4096M; to nginx.conf. There are other configurations, you can search for information and modify them online by yourself.
If you don’t know nginx, please go to nginx official website to download nginx and install it. After the installation is completed, replace the installed nginx.conf with the nginx.conf in this project, and then restart nginx.
9.Page, the url is http://IP:Port/Windows (the IP and port are the IP and port set in Nginx. Windows is the name of the front-end configuration in step 8)
If the following configuration needs to be modified, it must be configured in the system environment variables. If the environment variables are not set, the configuration in config.conf will be used by default. After setting the environment variables, if it does not take effect, please reopen the command line or re-ssh the server.
The IP and port that the service listens on.
The front-end prefix, is the same as that in nginx, and is only used for swagger page. If prefix is not needed, please set it to empty.
The back-end prefix, is the same as that in nginx. If prefix is not required, please set it to empty.
Database connection, only supports sqlite3 and MySQL.
The root directory of each disk file, is configured as follows: all files in the D drive are placed in the home/WinHub/data directory, and all files in the E drive are placed in the /opt/Windows/data directory. The directories must exist.
{"D": "/home/WinHub/data", "E": "/opt/Windows/data", "F": "/data/data"}
The startup URL of PWA. If the prefix of the front-end is empty, then it can also be configured as empty. Otherwise, you need to configure the URL to use PWA. Note: PWA only supports the https protocol.
Whether to enable OnlyOffice, 0: not enabled, 1: enabled
They are the URL of OnlyOffice and the jwt secret of OnlyOffice respectively.
The directory where historical versions of OnlyOffice files are stored during editing.
Whether to enable the backup function, 0 is not enabled, 1 is enabled
Backup directory, must exist.
Backup cycle, unit: day, that is, backup once every x days.
Whether to enable the auto-update system function, 0 is not enabled, 1 is enabled
URL of available tracker, aria2c needs tracker to download BT seeds.
STUN server address, mainly used for audio and video calls.
TURN server address, mainly used for audio and video calls.
Username and password for the TURN service
Log Level
1.Supports multiple platforms such as Linux, Windows, MacOS, etc. It is recommended to deploy on Linux.
2.Cluster deployment and distributed storage are not supported.
3.Playing videos online uses streaming playback, which requires that the metadata of the video must be at the front of the video file. So, you need to manually move the metadata of the video to the front of the video file. Using the ffmpeg to move the metadata of the video. The command: ffmpeg -i input_video.mp4 -map_metadata 0 -c:v copy -c:a copy -movflags +faststart output_video.mp4.
4.Whether you are using a PC browser or a mobile browser, setting the browser to display in full screen will provide a better user experience.
This repository uses the GPL-2.0 License. When you use this repository, please comply with the terms of the GPL-2.0 License. Please respect our work results consciously.
If you don't wish to comply with the terms of the GPL-2.0 License, please contact me in the Issues for commercial licensing information.
Thanks to the following projects