|
@@ -5,12 +5,12 @@
|
|
|
[中文說明](README-zh-HK.md)
|
|
|
|
|
|
# ArOZ Online System / aCloud
|
|
|
-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!
|
|
|
+Personal Cloud Platform with Web Desktop Environment for Raspberry Pi 3B+ or 4B. A place to start cloud music and video streaming, data storage, lightweight office work / text processing, 3D printing file previews, Cloud programming IDE and more!
|
|
|
|
|
|
**WARNING! THIS SYSTEM IS STILL IN BETA PHRASE.**
|
|
|
|
|
|
## 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. Read more on the [Full System Documentation](https://tobychui.github.io/ArOZ-Online-System/).
|
|
|
+These instructions will guide you through the deployment of a copy of ArOZ Online System on your own Raspberry Pi or other low power, Linux running SBCs for community review and testing purposes. Read more on the [Full System Documentation](https://tobychui.github.io/ArOZ-Online-System/).
|
|
|
|
|
|
### Docker
|
|
|
Follow the instruction from this repo: https://github.com/Saren-Arterius/aroz-dockerize
|
|
@@ -25,94 +25,117 @@ The following packages are required for the system to run on your Linux system.
|
|
|
- samba (Optional)
|
|
|
|
|
|
To install the package above, copy and paste the following lines into your ssh terminal line by line.
|
|
|
-```
|
|
|
-#Add the following line if you are using a fresh install of Debian Buster
|
|
|
+```bash
|
|
|
+# Add the following line if you are using a fresh install of Debian Buster
|
|
|
sudo apt-get install unzip net-tools ntfs-3g dosfstools -y
|
|
|
sudo apt-get update
|
|
|
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
|
|
|
+# 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
|
|
|
+# 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:
|
|
|
|
|
|
-WORK IN PROGRESS
|
|
|
+> WORK IN PROGRESS
|
|
|
|
|
|
### Manual Installation
|
|
|
-ArOZ Online System is only tested to install on Debian Jessie and Debian Buster. 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. If you are a noob and don't want to mess around with the sudoer settings, just edit /etc/sudoers, add the following line at the bottom of the file.
|
|
|
- ```
|
|
|
- www-data ALL=NOPASSWD: /usr/bin/mount, /sbin/mount.ntfs-3g, /usr/bin/ntfs-3g, /usr/bin/umount, /sbin/halt, /sbin/reboot, /sbin/poweroff, /sbin/ifconfig, /sbin/ip, /sbin/mkfs.ntfs, /sbin/mkfs.vfat
|
|
|
- ```
|
|
|
- **(Only if you are using the system in local area network. Please adjust this to suit your needs if you are planning to access the system through the internet.)**
|
|
|
-
|
|
|
- If you are pros and want to have much better control of the system security, add the lines that fits your need according to the selections below.
|
|
|
-
|
|
|
- Allow system to mount and unmount USB drives of your Raspberry Pi
|
|
|
- ```
|
|
|
- www-data ALL=NOPASSWD: /usr/bin/mount, /sbin/mount.ntfs-3g, /usr/bin/umount
|
|
|
- ```
|
|
|
+#### Overview
|
|
|
+
|
|
|
+ArOZ Online System is only tested on Debian Jessie and Debian Buster. Before installing the ArOZ Online System, you need to install necessary software package as shown in the [Prerequisites](#Prerequisites) section.
|
|
|
+
|
|
|
+#### Configuring PHP
|
|
|
+
|
|
|
+ArOZ Online is not compatiable with the default PHP settings.
|
|
|
+
|
|
|
+Edit `php.ini` to increase the max file upload size setting. On Debian systems, the `php.ini` file can usually be found in `/etc/php/{php-version}/apache2/php.ini`. Change these two lines below as follows:
|
|
|
+```
|
|
|
+upload_max_filesize = 2048M
|
|
|
+post_max_size = 2048M
|
|
|
+```
|
|
|
+
|
|
|
+#### Configuring Permissions
|
|
|
+
|
|
|
+Certain features of ArOZ Online System requires explicit authorization through configuration files.
|
|
|
+
|
|
|
+If you are not familiar with `sudoer` configuration syntax, open `/etc/sudoers` with `nano` and add the following to the end of file.
|
|
|
+
|
|
|
+```
|
|
|
+www-data ALL=NOPASSWD: /usr/bin/mount, /sbin/mount.ntfs-3g, /usr/bin/ntfs-3g, /usr/bin/umount, /sbin/halt, /sbin/reboot, /sbin/poweroff, /sbin/ifconfig, /sbin/ip, /sbin/mkfs.ntfs, /sbin/mkfs.vfat
|
|
|
+```
|
|
|
+**(Use the above settings only if you are hosting the system in your local area network. Please adjust this to suit your needs if you are allowing the access of the system from the internet.)**
|
|
|
+
|
|
|
+If you are familiar and want to have much better control of the system security, add the lines that fits your need according to the selections below.
|
|
|
+
|
|
|
+- Allow the system to mount and unmount your USB drives
|
|
|
+
|
|
|
+ www-data ALL=NOPASSWD: /usr/bin/mount, /sbin/mount.ntfs-3g, /usr/bin/umount
|
|
|
|
|
|
- Allow system to be powered off via the Web UI
|
|
|
+- Allow system to be powered off via the Web UI
|
|
|
+
|
|
|
```
|
|
|
www-data ALL=NOPASSWD: /sbin/halt, /sbin/reboot, /sbin/poweroff
|
|
|
```
|
|
|
-
|
|
|
- Allow system to access local area network IP address and WiFi network settings
|
|
|
- ```
|
|
|
- www-data ALL=NOPASSWD: /sbin/ifconfig, /sbin/ip
|
|
|
- ```
|
|
|
-
|
|
|
- Allow system to format and create new partitions
|
|
|
- ```
|
|
|
- www-data ALL=NOPASSWD: /sbin/mkfs.ntfs, /sbin/mkfs.vfat
|
|
|
- ```
|
|
|
-
|
|
|
- TO BE ADDED
|
|
|
-
|
|
|
-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
|
|
|
+
|
|
|
+- Allow system to access local area network IP address and WiFi network settings
|
|
|
+ ```
|
|
|
+ www-data ALL=NOPASSWD: /sbin/ifconfig, /sbin/ip
|
|
|
+ ```
|
|
|
+
|
|
|
+- Allow system to format and erase partitions
|
|
|
+ ```
|
|
|
+ www-data ALL=NOPASSWD: /sbin/mkfs.ntfs, /sbin/mkfs.vfat
|
|
|
+ ```
|
|
|
+
|
|
|
+> TO BE ADDED
|
|
|
+
|
|
|
+#### Apache Settings
|
|
|
+
|
|
|
+Edit `/etc/apache2/apache2.conf`, add the following two lines to the end of file
|
|
|
+
|
|
|
```
|
|
|
-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:
|
|
|
+XSendFile on
|
|
|
+XSendFilePath /media
|
|
|
```
|
|
|
- cd /var/www/html/
|
|
|
+
|
|
|
+#### Creating directories
|
|
|
+
|
|
|
+Create directory at /media/storage1 and /media/storage2
|
|
|
+
|
|
|
+ ```bash
|
|
|
+sudo mkdir /media/storage1 /media/storage2
|
|
|
```
|
|
|
+#### Installing ArOZ Online to webroot directory
|
|
|
|
|
|
-And then download the repo as zip, unzip the "src" folder into /var/www/html and ename "src" to "AOB".
|
|
|
-You can do this with WinSCP if you are using windows. Or otherwise, you can use git clone command similar to the example below. Make sure you have installed git using ```sudo apt-get install git``` before using the git commands.
|
|
|
+You will need to download and install the ArOZ Online System to your webroot (`/var/www/html/`).
|
|
|
+Navigate into the web root using the following command
|
|
|
|
|
|
+ ```bash
|
|
|
+cd /var/www/html/
|
|
|
```
|
|
|
- git clone https://github.com/tobychui/ArOZ-Online-System/
|
|
|
- sudo mv ArOZ-Online-System/src ./AOB
|
|
|
- sudo rm -rf ./ArOZ-Online-System
|
|
|
+
|
|
|
+And then download the repo as zip, unzip the `src` folder into `/var/www/html` and rename `src` to `AOB`.
|
|
|
+You can do this using WinSCP if you on Windows. Otherwise, you can use `git clone` command similar to the example below. Make sure you have installed `git` using ```sudo apt-get install git``` before running `git` command.
|
|
|
+
|
|
|
+ ```bash
|
|
|
+git clone https://github.com/tobychui/ArOZ-Online-System/
|
|
|
+sudo mv ArOZ-Online-System/src ./AOB
|
|
|
+sudo rm -rf ./ArOZ-Online-System
|
|
|
|
|
|
- sudo mkdir -p "/etc/AOB"
|
|
|
- sudo chmod 777 -R "/etc/AOB"
|
|
|
- sudo chmod 777 -R ./AOB
|
|
|
- sudo chown -R www-data ./
|
|
|
+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.
|
|
|
+
|
|
|
+#### Testing
|
|
|
+
|
|
|
+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
|
|
|

|
|
@@ -123,6 +146,7 @@ You can do this with WinSCP if you are using windows. Or otherwise, you can use
|
|
|

|
|
|

|
|
|

|
|
|
+
|
|
|
Click <a href="https://github.com/tobychui/ArOZ-Online-System/tree/master/img/screenshots">here</a> for more preview screenshots
|
|
|
|
|
|
## Versioning
|
|
@@ -134,15 +158,15 @@ Different major change in versioning will lead to an upgrade to the codename. He
|
|
|
| Before Beta 1.2.8 | Sempervivum Tectorum | N/A | Full |
|
|
|
| Beta 12-06-2019 | aCloud | Init Release | Pre-release |
|
|
|
|
|
|
-*Full versions are only disclose to internal developers or testers for review purpose only.
|
|
|
+*Full versions are only available for internal developers or testers for testing purposes only.
|
|
|
|
|
|
## Author
|
|
|
-### Developer
|
|
|
+### Developers
|
|
|
(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
|
|
|
+### Beta Testers
|
|
|
(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>
|
|
@@ -173,7 +197,5 @@ Threejs by Mrdoob - https://threejs.org/
|
|
|
TO BE ADDED
|
|
|
|
|
|
## Buy me a coffee
|
|
|
-Actually I don't drink coffee. Send me something that would make me feel interested if you really want to send me something :)
|
|
|
-
|
|
|
-
|
|
|
-
|
|
|
+Actually I don't drink coffee.
|
|
|
+Send me something that would make me feel interested if you really want to send me something :)
|