Prechádzať zdrojové kódy

Updated more en-HK docs

Toby Chui 6 rokov pred
rodič
commit
782f06a37a

BIN
docs/img/5/advdoc.png


BIN
docs/img/5/advdoc.psd


BIN
docs/img/advdoc.png


BIN
docs/img/advdoc.psd


BIN
docs/img/faq.png


+ 1 - 1
docs/index.html

@@ -47,7 +47,7 @@
 			</tbody>
 			<tfoot>
 				<tr>
-					<th colspan="3">All documentations can be found under the main repo's /docs directory.<br>CopyRight ArOZ Online Project, 2016 - <span id="currentYear">2016</span></th>
+					<th colspan="4">All documentations can be found under the main repo's /docs directory.<br>CopyRight ArOZ Online Project, 2016 - <span id="currentYear">2016</span></th>
 				</tr>
 			</tfoot>
 		</table>

+ 1 - 0
docs/lang/en-HK/0.md

@@ -8,6 +8,7 @@ This is a Cloud software system with Web Desktop Environment specially designed
 
 ## Community Users
 If you are a normal user, feel free to get one of our pre-build image for Raspberry with the link below.
+
 [Link](https://hkwtc.org/aroz_online/dist/)
 
 After your download has been finished, please proceed to the next page.

+ 14 - 2
docs/lang/en-HK/1.md

@@ -14,22 +14,29 @@ You will need the following hardwares to build yourself a ArOZ Cloud System.
 
 First, you will need Win32 Disk Imager and ArOZ Online System Image for Raspberry Pi.
 You can find them in the links below.
+
 [Win32 Disk Imager ](https://sourceforge.net/projects/win32diskimager/)
+
 [ArOZ Online System Images](https://hkwtc.org/aroz_online/dist/)
 
 After finish download and installing the image and software, you would see a new desktop icon appeared. Double click to start the Win32 Disk Imager.
+
 ![](img/1/1.png)
 
 Next, select the "file open" button.
+
 ![](img/1/2.png)
 
 Select the image file you just downloaded. In this case, the aCloud v1.0 image.
+
 ![](img/1/3.png)
 
 Insert your micro SD card into your PC. If you have connected more than one external storage devices on your PC, you might need to change the path for the installation. In this example, the SD card is located on F:\ mount point.
+
 ![](img/1/4.png)
 
 Finally, select "Write" to write the image file to SD card.
+
 ![](img/1/5.png)
 
 ## Hardware Preparation
@@ -37,18 +44,23 @@ Finally, select "Write" to write the image file to SD card.
 You can either choose WiFi AP or Ethernet with LAN access for your initiation network interface.
 
 First, insert the newly flashed SD card into your pi's SD card slot.
+
 <img class="ts fluid image" src="img/1/6.png">
 
 Connect your WiFi USB dongle to your Pi's USB port, or if you are using ethernet connection, plug in the ethernet cable into the Pi's RJ45 network connector.
+
 <img class="ts fluid image" src="img/1/7.png">
 
 ### Setup with WiFi AP
 If you are using WiFi AP setup, open the WiFi discover interface on your devices and search for the following SSID and login with the following password.
 
+```
 SSID: 
-<code> ArOZ Portable </code>
+ArOZ Portable
+
 Password:
-<code>arozportablesystem</code>
+arozportablesystem
+```
 
 After connected and turned off mobile data, open your default browser and enter <code>http://192.168.4.1/AOB/</code> into the URL bar. Following the on screen instructions to continue the account creation process.
 

+ 35 - 27
docs/lang/en-HK/2.md

@@ -20,13 +20,14 @@ You need the following apt packages for ArOZ Online deployment.
 
 You can use the following commands in terminal to install all of them.
 
-<code>sudo apt-get install -y apache2</code>
-<code>sudo apt-get install -y php libapache2-mod-php php-cli php-common php-mbstring php-gd php xml php-zip </code>
-<code>sudo apt-get install libapache2-mod-xsendfile</code>
-<code>sudo apt-get install php-mysql</code>
-<code>sudo apt-get install ffmpeg</code>
-<code>sudo apt-get install samba</code>
-
+```
+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
+sudo apt-get install php-mysql
+sudo apt-get install ffmpeg
+sudo apt-get install samba
+```
 
 If you are using Debian Buster or its forked distributions, you might want to run the following comamnds before installing all the packages listed above. You should run the following command with super user (su) permission.
 
@@ -37,38 +38,45 @@ apt-get install sudo unzip net-tools ntfs-3g
 First, you need to modify the PHP upload file size limit. In most case, the config file can be found at
  /etc/php/{php-version}/apache2/php.ini. Find and replace the following two lines.
 
-<code>upload_max_filesize = 2048M</code>
-<code>post_max_size = 2048M</code>
-
+```
+upload_max_filesize = 2048M
+post_max_size = 2048M
+```
   
 Add www-data into /etc/sudoers. 
 Tips: If your cloud system is deploying for public access, due to security reasons, you should modify the permission setting according to your own needs. If you are deploying under a NAT router or private network for PERSONAL USES, you can just use the command below.
 
-<code>www-data ALL=(ALL:ALL) NOPASSWD:ALL
+```
+www-data ALL=(ALL:ALL) NOPASSWD:ALL
+```
 
   
 Edit /etc/apache2/apache2.conf and add the following two lines at the bottom of the file.
 
-<code>XSendFile on</code>
-<code>XSendFilePath /media</code>
-
+```
+XSendFile on
+XSendFilePath /media
+```
   
 Create new folder at /media/storage1 and /media/storage2 for mounting external storages.
 
-<code>sudo mkdir /media/storage1 /media/storage2</code>
+```
+sudo mkdir /media/storage1 /media/storage2
+```
 
   
-cd into /var/www/html/ ,use "wget" to download the ArOZ Online Distribution Pack. You can use the following commands to automate the process for you. Please remember to replace the <code>{dist-pack}</code> to the dist-pack name you are downloading.
-
-<code>cd /var/www/html/</code>
-<code>sudo wget {dist-pack}.zip</code>
-<code>sudo chmod 777 {dist-pack}.zip</code>
-<code>sudo unzip -o {dist-pack}.zip</code>
-<code>rm install.zip</code>
-<code>sudo mkdir -p "/etc/AOB"</code>
-<code>sudo chmod 777 -R "/etc/AOB"</code>
-<code>sudo chmod 777 -R ./AOB</code>
-<code>sudo chown -R www-data ./</code>
-
+cd into /var/www/html/ ,use "wget" to download the ArOZ Online Distribution Pack. You can use the following commands to automate the process for you. Please remember to replace the ```{dist-pack}``` to the dist-pack name you are downloading.
+
+```
+cd /var/www/html/
+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 [http://{device-IP}/AOB/](http://{device-IP}/AOB/) . Follow the on-screen tutorial to create your first user account on your ArOZ Online System.

+ 15 - 7
docs/lang/en-HK/3.md

@@ -13,26 +13,34 @@ The system only support NTFS formatted USB storage devices like *USB Drives*, *P
 If you just bought a new USB Drive for your cloud system, we recommend a full NTFS format before uses. This is due to many of the new USB Drives comes with a exFAT or FAT32 formats which ArOZ Online System  Auto Mounting Settings do not support. 
 
 You could use the Windows build in tool to format your USB drive to NTFS format as follow.
+
 ![image](img/3/0.png)
+
 It is recommend not to select the "Quick Format" button if your USB drive contains encrypted partitions, your USB drive is 2nd handed or you have use it to install another Opertaion Systems 9aka Bootable USB Drive). 
 
 ## Boot From Hard Disk
 Some advance users might choose to boot from external hard disk instead of the internal Micro SD card. Hence, the system drive will occupied the mount point for  <code> /dev/sda* </code> . To solve the error in auto mounting, you need to edit <code> /etc/fstab </code> and change the mounting devices as follow. Please edit <code> /etc/fstab </code> file and change the following two lines.
 
-<code>/dev/sda1 /media/storage1 ntfs defaults,nofail,noatime,x-systemd.device-timeout=1 0 0</code>
-<code>/dev/sdb1 /media/storage2 ntfs defaults,nofail,noatime,x-systemd.device-timeout=1 0 0</code>
+```
+/dev/sda1 /media/storage1 ntfs defaults,nofail,noatime,x-systemd.device-timeout=1 0 0
+/dev/sdb1 /media/storage2 ntfs defaults,nofail,noatime,x-systemd.device-timeout=1 0 0
+```
 
 into the following
-<code>/dev/sdb1 /media/storage1 ntfs defaults,nofail,noatime,x-systemd.device-timeout=1 0 0</code>
-<code>/dev/sdc1 /media/storage2 ntfs defaults,nofail,noatime,x-systemd.device-timeout=1 0 0</code>
+
+```
+/dev/sdb1 /media/storage1 ntfs defaults,nofail,noatime,x-systemd.device-timeout=1 0 0
+/dev/sdc1 /media/storage2 ntfs defaults,nofail,noatime,x-systemd.device-timeout=1 0 0
+```
 
 ## Adding More Devices
 In most case, you won't be using more than 2 external storage devices at the same time. However if you really need more than 2 mount points, you can create it by creating more folders in the media directory with the following commands. For example, this is the command for creating a 3rd mount point.
-<code>mkdir /media/storage3</code>
+```mkdir /media/storage3```
 Another example for creating the 4th mount point.
-<code>mkdir /media/storage4</code>
+```mkdir /media/storage4```
 And so on.
 
 Be aware that the manual created mount points will not be automatically mounted during the system startup. You might need to edit <code> /etc/fstab </code> according to your needs. You can find out more with the link below.
- [Link](https://wiki.debian.org/fstab) 
+
+ [https://wiki.debian.org/fstab](https://wiki.debian.org/fstab) 
 

+ 5 - 0
docs/lang/en-HK/4.md

@@ -0,0 +1,5 @@
+["Frequently Asked Questions"]
+<img class="ts fluid image" src="img/faq.png">
+# Frequently Asked Questions
+
+To be added

+ 11 - 0
docs/lang/en-HK/5.md

@@ -0,0 +1,11 @@
+["Advanced Documentation"]
+<img class="ts fluid image" src="img/advdoc.png">
+# Advanced Documentation
+Starting from this page, the documentations will focus on explaining the system design and architecture.
+
+## Why I need to know how the system works?
+As a developer, you can still create your new ArOZ Online WebApp without knowing how everything works in the system. However, knowing how the system works will definetly bring you more idea to work around some functions that is not covered by the ao-module wrapper. 
+
+If you are not interested in knowing how the system works, feel free to skip to "Developer" documentations.
+
+![](img/5/advdoc.png)

+ 26 - 0
docs/lang/en-HK/6.md

@@ -0,0 +1,26 @@
+["System Requirement"]
+# System Requirements
+ArOZ Online System requires little resources to run. In most case, it only takes up to < 500MB of storage space and < 150MB of RAM. Here is a list of deivces that you can use as a ArOZ Online System Host.
+
+### Host (Hardware)
+
+#### Minimal:
+1Ghz CPU (ARM or x86 / x64), 512MB RAM, 8GB Storage, 
+
+#### Recommend:
+
+2.2Ghz or faster x86 / x64 CPU, 4GB RAM and 64GB Storage
+(Tested with Raspbian on Raspberry Pi Zero W, Pi 3B+, Debian Jessie on Intel x86 and x64 machines)
+### Host (Software)
+
+Raspbian scratch / Debian Jessie / Debian Stretch with Apache Web Server + PHP 5.0 or above (Recommended PHP 7.2), wpa_supplicant, net-tools, Python 3.4 (or above)
+
+Optional: apache mod_XSendFile, php_gd, libav (ffmpeg), samba
+
+### Client
+Any devices that can run Chrome / Firefox / Safari (Tested with Android 8.0 Webview, Firefox and Chrome, Safari on macOS High Sierra, Windows 7, 8.1, 10 with Chrome, Firefox, partially supported Edge)
+
+### Network Environment
+Network speed of 20Mbps or above (Recommended 100Mbps), WiFI (2.4Ghz / 5Ghz) or Ethernet, 
+
+Dual Interface Required (1 Wireless AP + 1 Ethernet or 1 Wireless AP + 1 Wireless Client)

+ 41 - 0
docs/lang/en-HK/7.md

@@ -0,0 +1,41 @@
+["System Structure"]
+ArOZ Online System is designed with Modular Designs. The system is built with a list of core modules or scripts that deliver the system core services. The modules and its functions are listed below
+
+<table class="ts table">
+<thead>
+<tr>
+<th>Module Name</th>
+<th>Functions</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>auth.php / login.php</td>
+<td>Provide authentication functions</td>
+</tr>
+<tr>
+<td>function_bar.php / function_bar.js</td>
+<td>Provide floatWindow  control API</td>
+</tr>
+<tr>
+<td>./SystemAOB</td>
+<td>Provide core system functions, including file system bridging, hardware management functions and clustering services scripts</td>
+</tr>
+<tr>
+<td>./script</td>
+<td>Provide core system scripts for front ends</td>
+</tr>
+<tr>
+<td>./Desktop</td>
+<td>Provide desktop environment to users for general purpose tasks</td>
+</tr>
+<tr>
+<td>./msb</td>
+<td>Multiple System Booting Interface config files. Allow multiple instances of ArOZ Online running on the same host.</td>
+</tr>
+<tr>
+<td>./*</td>
+<td>Other WebApp modules that runs on ArOZ Online System.</td>
+</tr>
+</tbody>
+</table>

+ 7 - 3
docs/reader.html

@@ -31,6 +31,11 @@ img{
 .selectable:hover{
 	background-color:#f2f2f2;
 }
+pre{
+	background-color: #1c1c1c;
+	color: white;
+	padding: 10px;
+}
 </style>
 </head>
 <body>
@@ -228,9 +233,8 @@ function readDoc(){
 	document.title = metaTag[0];
 	$("#readerTitle").text(metaTag[0]);
 	$("#docLoader").html("");
-	for (var i =0; i < pageInfo.length; i++){
-		$("#docLoader").append(md2html(pageInfo[i]));
-	}
+	pageInfo = pageInfo.join("\n");
+	$("#docLoader").append(md2html(pageInfo));
 	updateStartedIcon();
 }