## README is update pending
This is a copy of the ArozOS v1.0 readme file. We didn't have time to update this yet so please do not following the instruction below to compile ArozOS 2.0. (We recommend using make if you want to try the latest version on any devices)
## Features
### User Interface
- Web Desktop Interface (Better than Synology DSM)
- Ubuntu remix Windows style startup menu and task bars
- Clean and easy to use File Manager (Support drag drop, upload etc)
- Simplistic System Setting Menu
- No-bull-shit module naming scheme
### Networking
- FTP Server
- Static Web Server
- WebDAV Server
- UPnP Port Forwarding
- Samba (Supported via 3rd party sub-services)
- WiFi Management (Support wpa_supplicant for Rpi or nmcli for Armbian)
### File / Disk Management
- Mount / Format Disk Utilities (support NTFS, EXT4 and more!)
- Virtual File System Architecture
- File Sharing (Similar to Google Drive)
- Basic File Operations with Real-time Progress (Copy / Cut / Paste / New File or Folder etc)
### Security
- oAuth
- LDAP
- IP White / Blacklist
- Exponential login timeout
### Extensibility
- ECMA5 (JavaScript like) scripting interface
- 3rd party Go / Python module development with sub-service reverse proxy
### Others
- Require as little as 512MB system memory and 8GB system storage
- Base on one of the most stable Linux distro - Debian
- Support for Desktop, Laptop (touchpad) and Mobile screen sizes
## Installation
Require GO 1.14 or above (See [Instllation tutorial](https://dev.to/tobychui/install-go-on-raspberry-pi-os-shortest-tutorial-4pb))
Run the following the command to build the system
```
git clone https://github.com/tobychui/arozos
cd ./arozos/src/
go build
./arozos
#sudo ./arozos for enabling hardware and WiFi management features
```
(Yes, it is that simple)
## Deploy
### For Raspberry Pi (For Raspberry Pi 4B+)
If you are using Raspberry Pi as your host, you can download one of the images and flash the image into your SD card. You will find a new network device named "ArozOS (ARxxx)" pop up in your "Network Neighbourhood". Double click the icon and you will be redirect to the system Web setup interface. If you cannot find the new device in your network, you can also connect to the ArozOS directly via ```http://{raspberry_pi_ip_address}:8080/```
**All the image listed above require 8GB or above microSD card**
To optain the .img file, you can unzip the compressed image using 7zip. If you don't have it, you can get it [here](https://www.7-zip.org/download.html)
### For All Pi models
#### Build from source using installer script (Recommended)
Since v1.119, arozos pre-build image has been moved from the original Raspberry Pi OS 32-bit to 64-bit for better utilization of system resources. For older version of Pis, you can install arozos with the command below with a fresh installation of Raspberry Pi OS
```
curl -L https://raw.githubusercontent.com/tobychui/arozos/master/installer/install_for_pi.sh | bash
```
or without curl
```
cd ~/
wget https://raw.githubusercontent.com/tobychui/arozos/master/installer/install_for_pi.sh
sudo chmod 775 ./install_for_pi.sh
./install_for_pi.sh
```
The installer will install all the required dependencies including ffmpeg and go compiler. To confirm installation success, check for the execution status of arozos using the following command.
```
sudo systemctl status arozos
```
#### Using prebuilt binary
See installation steps for other ARM SBC (but use the ```arozos_linux_arm``` binary instead of ```arozos_linux_arm64```)
### For other ARM SBC(e.g. Orange Pi / Banana Pi / Friendly ARM's Pis)
Download the correct architecture binary from the "release" tab and upload the binary with the "web" and "system" folder in "/src".
After upload, you should have the following file structure
```
$ ls
arozos_linux_arm64 web system
```
Start the binary by calling ``` sudo ./arozos_linux_arm64 ``` (or without sudo if you prefer no hardware management)
### Windows
If you are deploying on Windows, you need to add ffmpeg to %PATH% environment variable.
This system can be built and run on Windows hosts with the following build instructions
```
# Download the whole repo as zip and cd into it
cd .\arozos\src\
go build
arozos.exe
```
**However, not all features are available for Windows**.
## Docker
Thanks [Saren](https://github.com/Saren-Arterius) for creating this amazing DockerFile
See his repo over [here](https://github.com/Saren-Arterius/aroz-dockerize)
## Screenshots
## Start the ArozOS Platform
### Supported Startup Parameters
The following startup parameters are supported (v1.113)
```
-allow_autologin
Allow RESTFUL login redirection that allow machines like billboards to login to the system on boot (default true)
-allow_cluster
Enable cluster operations within LAN. Require allow_mdns=true flag (default true)
-allow_iot
Enable IoT related APIs and scanner. Require MDNS enabled (default true)
-allow_mdns
Enable MDNS service. Allow device to be scanned by nearby ArOZ Hosts (default true)
-allow_pkg_install
Allow the system to install package using Advanced Package Tool (aka apt or apt-get) (default true)
-allow_ssdp
Enable SSDP service, disable this if you do not want your device to be scanned by Windows's Network Neighborhood Page (default true)
-allow_upnp
Enable uPNP service, recommended for host under NAT router
-beta_scan
Allow compatibility to ArOZ Online Beta Clusters
-cert string
TLS certificate file (.crt) (default "localhost.crt")
-console
Enable the debugging console.
-demo_mode
Run the system in demo mode. All directories and database are read only.
-dir_list
Enable directory listing (default true)
-disable_http
Disable HTTP server, require tls=true
-disable_ip_resolver
Disable IP resolving if the system is running under reverse proxy environment
-disable_subservice
Disable subservices completely
-enable_hwman
Enable hardware management functions in system (default true)
-gzip
Enable gzip compress on file server (default true)
-homepage
Enable user homepage. Accessible via /www/{username}/ (default true)
-hostname string
Default name for this host (default "My ArOZ")
-iobuf int
Amount of buffer memory for IO operations (default 1024)
-key string
TLS key file (.key) (default "localhost.key")
-max_upload_size int
Maxmium upload size in MB. Must not exceed the available ram on your system (default 8192)
-ntt int
Nightly tasks execution time. Default 3 = 3 am in the morning (default 3)
-port int
Listening port for HTTP server (default 8080)
-public_reg
Enable public register interface for account creation
-root string
User root directories (default "./files/")
-session_key string
Session key, must be 16, 24 or 32 bytes long (AES-128, AES-192 or AES-256). Leave empty for auto generated.
-storage_config string
File location of the storage config file (default "./system/storage.json")
-tls
Enable TLS on HTTP serving (HTTPS Mode)
-tls_port int
Listening port for HTTPS server (default 8443)
-tmp string
Temporary storage, can be access via tmp:/. A tmp/ folder will be created in this path. Recommend fast storage devices like SSD (default "./")
-tmp_time int
Time before tmp file will be deleted in seconds. Default 86400 seconds = 24 hours (default 86400)
-upload_async
Enable file upload buffering to run in async mode (Faster upload, require RAM >= 8GB)
-upload_buf int
Upload buffer memory in MB. Any file larger than this size will be buffered to disk (slower). (default 25)
-uuid string
System UUID for clustering and distributed computing. Only need to config once for first time startup. Leave empty for auto generation.
-version
Show system build version
-wlan_interface_name string
The default wireless interface for connecting to an AP (default "wlan0")
-wpa_supplicant_config string
Path for the wpa_supplicant config (default "/etc/wpa_supplicant/wpa_supplicant.conf")
```
Example
```
//Starting aroz online with standard web port
./arozos -port 80
//Start aroz online in demo mode
./arozos -demo_mode=true
//Use https instead of http
./arozos -tls=true -tls_port 443 -key mykey.key -cert mycert.crt -disable_http=true
//Start both HTTPS and HTTP server on two different port
./arozos -port 80 -tls=true -key mykey.key -cert mycert.crt -tls_port 443
//Change max upload size to 25MB
./arozos -max_upload_size 25
```
See documentation for more examples.
### ArozOS Launcher (Required for OTA Update support)
See https://github.com/aroz-online/launcher
### Storage Configuration
#### Deploying Single Machine
If you are deploying single machine, you can visit System Setting > Disk & Storage > Storage Pools and edit the "system" storage pool for setting up the global storage pools for all users in the system.
#### Deploying on Multiple Machines
If you are deploying on multiple machines, you can take a look at the storage configuration file located in:
```
src/system/storage.json.example
```
Rename the storage.json.example to storage.json and start arozos. The required virtual storage drives will be mounted accordingly.
## ArOZ JavaScript Gateway Interface (AGI) / Plugin Loader
The ArOZ AJGI / AGI interface provide a javascript programmable interface for ArOZ Online users to create
plugin for the system. To initiate the module, you can place a "init.agi" file in the web directory of the module
(also named the module root). See more details in the .
## ArozOS OTA Update Launcher
Since v1.119, ArozOS can perform OTA update with the help of the [ArozOS Launcher](https://github.com/aroz-online/launcher). See the launcher's github repo for installation instructions.
## Other Resources
If you are looking for other WebApps (Installed via System Setting) or subservices (Require SSH login to install, for OEM only), please take a look at our collections over here:
https://github.com/aroz-online/WebApp-and-Subservice-Index
## Community / Q&A
### 💬 Direct Contact
You can reach the authors using [Telegram](https://t.me/ArOZBeta)! We welcome all kind of feedbacks and questions.
### 🖥️ Device Compatibility Showcase
Using ArozOS on something other than Raspberry Pis? Show us your server configuration & hardware specs!
https://github.com/tobychui/arozos/issues/50
### 📝 Related Articles
If you are looking for tutorials or need help on debugging some minor issues, feel free to take a look at these articles written by our users. (Thank you so much for sharing this project :D )
#### English
- [I write my own web desktop OS for 3 years and this is what it looks like now ](https://dev.to/tobychui/i-write-my-own-web-desktop-os-for-3-years-and-this-is-what-it-looks-like-now-2903)
#### Chinese
- [ArozOS+树莓派打造随身NAS（避坑专用）](https://blog.csdn.net/m0_37728676/article/details/113876815)
- [ArozOS+树莓派小型NAS](http://www.huajia.online/2021/10/23/ArozOS-%E6%A0%91%E8%8E%93%E6%B4%BE%E5%B0%8F%E5%9E%8BNAS/)
- [树莓派 Arozos 指北](https://blog.pi-dal.com/%E9%80%82%E7%94%A8%E4%BA%8E%E6%A0%91%E8%8E%93%E6%B4%BE%E7%9A%84%E9%80%9A%E7%94%A8Web%E6%A1%8C%E9%9D%A2%E6%93%8D%E4%BD%9C%E7%B3%BB%E7%BB%9F)
- [Linux:ArozOS 安裝與建立開機自啟動服務](https://pvecli.xuan2host.com/linux-arozos-install-service/)
#### Portuguese
- [DESKTOP WEB construído e desenvolvido na LINGUAGEM GO](https://www.youtube.com/watch?v=C42UdgOySY)
Feel free to create a PR if you have written an article for ArozOS!
## License
### Source Code
ArozOS - General purpose cloud desktop platform
Copyright (C) 2021 tobychui
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License version 3 as published by the Free Software Foundation.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program. If not, see .
### Documentations
Copyright (C) 2021 tobychui
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3
or any later version published by the Free Software Foundation;
with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
A copy of the license is included in the section entitled "GNU
Free Documentation License".
### Artwork and Mascot Design
Copyright (C) 2021 tobychui, All Right Reserved
## Buy me a coffee
I am working on this project as a hobby / side project and I am not really into collecting donation from this project.