Merge branch 'master' of https://github.com/tobychui/ArOZ-Online-Beta

README.md

@@ -1,9 +1,112 @@
-# ArOZ-Online-Beta
-Web Desktop System powered by PHP with modular functionality for Raspberry Pi
+![Image](img/banner.png?raw=true)
+
+<img src="https://img.shields.io/badge/License-Partially%20Open%20Source-blue"> <img src="https://img.shields.io/badge/Build-Community-brightgreen"> <img src="https://img.shields.io/badge/Device-Raspberry%20Pi%203B%2B%20%2F%204B-red"> <img src="https://img.shields.io/badge/Made%20In-Hong%20Kong-blueviolet">
+
+# ArOZ Online System
+Personal Cloud Platform with Web Desktop Environment for Raspberry Pi 3B+ or 4B. A place to start cloud music and video streaming, data storage, office work / text processing, 3D printing file previews, Cloud programming IDE and more!
+
+## Getting Started
+These instructions will show you how to deploy a copy of ArOZ Online System on your own Raspberry Pi or other low power, Linux running SBCs for community review and testing purposes. See "Full Version Deployment" for the instruction to deploy other builds of the system.
+
+### Prerequisites
+The following packages are required for the community edition to run on your Linux system.
+- apache2
+- libapache2-mod-xsendfile
+- php libapache2-mod-php php-cli php-common php-mbstring php-gd php xml php-zip
+- php-mysql (Optional)
+- libav-tools / ffmpeg (Optional)
+- samba (Optional)
+
+To install the package above, copy and paste the following lines into your ssh terminal line by line.
+```
+sudo apt-get install -y apache2
+sudo apt-get install -y php libapache2-mod-php php-cli php-common php-mbstring php-gd php xml php-zip 
+sudo apt-get install libapache2-mod-xsendfile
+#The lines below are optional. But it is recommended to install them for future uses
+sudo apt-get install php-mysql
+#Use libav-tools instead of ffmpeg if you are still using Debian Jessie
+sudo apt-get install ffmpeg
+sudo apt-get install samba
+```
+### Prebuilt Image File
+To install ArOZ Online System to your Raspberry pi, you can use the prebuilt image file for Raspberry Pi 4B / 3B+. You can find the image in the link below:
+
+https://git.hkwtc.org/TC/aCloud-Images
+
+### Manual Installation
+Before installing the ArOZ Online System, you need to firstly setup the package settings. 
+
+1. Edit php.ini to increase the max file upload size setting. The php.ini file can usually be found in /etc/php/{php-version}/apache2/php.ini. Change the two lines below as follows:
+  ```
+  upload_max_filesize = 2048M
+  post_max_size = 2048M
+  ```
+  
+2. Edit /etc/sudoers, add the following line at the bottom of the file.
+  ```
+  www-data ALL=(ALL:ALL) NOPASSWD:ALL
+  ```
+  
+3. Edit /etc/apache2/apache2.conf, add the following two lines to the bottom of the file
+  ```
+  XSendFile on
+  XSendFilePath /media
+  ```
+  
+4. Create directory at /media/storage1 and /media/storage2
+  ```
+  sudo mkdir /media/storage1 /media/storage2
+  ```
+Next, you need to download and install the ArOZ Online System to your webroot (/var/www/html/).
+To do so, you can firsly move into the web root with the following command:
+  ```
+  cd /var/www/html/
+  ```
+And then download the package to the current location, unzip it and setup the permission for ArOZ Online System to work.
+(Replace the {dist-pack} with the link of the current dist-pack zip filepath that you are downloading)
+  ```
+  sudo wget {dist-pack}.zip
+  sudo chmod 777 {dist-pack}.zip
+  sudo unzip -o {dist-pack}.zip
+  rm install.zip
+  sudo mkdir -p "/etc/AOB"
+  sudo chmod 777 -R "/etc/AOB"
+  sudo chmod 777 -R ./AOB
+  sudo chown -R www-data ./
+  ```
+  
+  Open your default browser and visit the http://{Raspberry_Pi_IP_Address}/AOB/ and follow the on scren guide for setting up a new user.
+
+## Preview / Screenshots
+
+## Author
+### Developer
+(Blame them if you encounter any bugs within the system)
+* tobychui - Project initiator / System Developer / Core Modules designer and programmer
+* <a href="https://github.com/yeungalan">yeungalan</a> - Module maintainer / Network Setting Module developer
+
+### Beta Tester
+(Find them if you want to know how to use a specific function in the system)
+* <a href="https://github.com/aceisace">aceisace</a>
+* <a href="https://github.com/RubMing">RubMing</a>
+
+## License
+Core Modules (Audio / Photo / Video) - MIT License
+
+Desktop Module (Desktop) - GPLv3 License
+
+All core scripts and binary files under root (./) and System Scrupt Folder (SystemAOB/*) - tobychui feat. ArOZ Online Project, All Right Reserved.
+
+All other files or modules that is not covered by the license above - See the module's license for more information.
+
+THIS SYSTEM IS ONLY FOR PERSONAL AND NON COMMERCIAL USE ONLY. RE-SELL ,DISTRIBUTE OR CLAIM THIS AS YOUR OWN WORK IS PROHIBITED
+
+## Acknowledgments
+Special thanks for the following projects which bring insights to this project.
+
+TocasUI by Yami Odymel - https://tocas-ui.com/ 
+
+EyeOS - https://en.wikipedia.org/wiki/EyeOS
+
 
-For download or documentation, please visit http://aroz.online
-## What is ArOZ Online?
-ArOZ Online is a WebApp system that is designed to host on devices with low processing power (like the Raspberry Pi or some old thin client with linux installed) and run with client that has relativly average processing power (Like a smartphone or laptop). The system provide a platform for entertaining, file management, programming, development and more through a Windows-like Virtual Desktop Environment.
 
-## Installation
-Please refer to our page for the installation procedures