The arozos repo

Toby Chui f397779be9 Final push for v2.023 4 days ago
documents 626c406aa4 Added more localization 5 days ago
examples 0f84a11f18 Added darknet_arm64 and smart_arm64 binary 3 years ago
installer 54a976c5ca Added uninstall script 2 years ago
legacy f68720026a Updated go version and dependencies to 1.20 2 years ago
mod aad7acf928 Updated 5 days ago
res a1b1478984 Migrated legacy wallpapers out from web folder 2 years ago
subservice d6fe8282a9 Deprecated all ioutils 2 years ago
system 62f59c9586 sync download page pr 5 days ago
web f397779be9 Final push for v2.023 4 days ago
.gitignore e31844ec45 Added auto release 1 year ago
Makefile c4520d143b Updated make file 2 years ago
README.md e31844ec45 Added auto release 1 year ago
agi-doc.md 8cbe4bf6a6 Fixed shit before sleep 1 year ago
agi.go ab71858698 Replaced all Mv with GetPara or PostPara 2 years ago
apt.go b23ce82990 Deprecated common and replaced with utils 2 years ago
auth.go 2194b9e049 Added more samba api 1 year ago
autopush.bat 1846561d94 Fixed embedded photo viewer 2 years ago
autopush.sh 8052702e98 Updated permission modes 4 years ago
cluster.go bc5cb1f191 Extended cluster scanning duration 2 years ago
console.go aada156457 Added list log API 2 years ago
desktop.go dbcc5d8fb2 Fixed desktop file share icon and context menu darktheme mode bug 1 year ago
devices.go cdc2320d26 Moved locate.html to info tab 4 years ago
disk.go 8a8c417bb6 Finalized RAID health check function 1 year ago
error.go 70e028b2e4 Added ffmpeg factpry 2 protpty 1 year ago
file_system.go 81078f8ff9 Removed gzip from media server and demo mode flag 1 year ago
generateCoverageReport.bat 23611ed297 more test cases 1 year ago
go.mod aad7acf928 Updated 5 days ago
go.sum aad7acf928 Updated 5 days ago
hardware.power.go 2194b9e049 Added more samba api 1 year ago
iot.go e5f5b7f48c Added on boot iot scan logic 2 years ago
ldap.go db8d0a87ae Added wip vendor-res 2 years ago
localhost.crt 40ea2c13f5 Updated certificate 4 years ago
localhost.key 40ea2c13f5 Updated certificate 4 years ago
main.flags.go 8d3c3e573f Updated version code 5 days ago
main.go 7106a1736f Updated version number and added photo preview in share 11 months ago
main.router.go 34fb906eff Removed COOP and COEP 1 year ago
mediaServer.go b335e1fa6a Added experimental realtime transcode 1 year ago
module.go ab71858698 Replaced all Mv with GetPara or PostPara 2 years ago
module.util.go 9438ae6edc Fixed height on many webapp windows 2 years ago
network.forward.go ab71858698 Replaced all Mv with GetPara or PostPara 2 years ago
network.go aad7acf928 Updated 5 days ago
notification.go ee4cdd3116 Update notification.go 3 years ago
oauth.go 52791b19f8 Fixed diskmg unable to render not partitioned disk bug 4 years ago
permission.go b23ce82990 Deprecated common and replaced with utils 2 years ago
quota.go ab71858698 Replaced all Mv with GetPara or PostPara 2 years ago
register.go db8d0a87ae Added wip vendor-res 2 years ago
release.sh c5aad89289 Updated releash.sh 1 year ago
scheduler.go b23ce82990 Deprecated common and replaced with utils 2 years ago
security.go b23ce82990 Deprecated common and replaced with utils 2 years ago
setting.advance.go b23ce82990 Deprecated common and replaced with utils 2 years ago
setting.go f3cea080c9 Added module list localization 1 year ago
start.sh ecdded5c02 Added localization for authreq 4 years ago
startup.flags.go ab71858698 Replaced all Mv with GetPara or PostPara 2 years ago
startup.go 9e039e934a Finished RAID creation and mount system 1 year ago
storage.bridge.go 44a1eb26e9 Added patch to bridged fsh disconnect on origin fsh reload 2 years ago
storage.go cc2e9df05d Added remove RAID function 1 year ago
storage.pool.go d8ae16eb78 Fixed FSH toggle bug 1 year ago
subservice.go b23ce82990 Deprecated common and replaced with utils 2 years ago
system.go 6148e45abc Updated System setting localization and icons 2 years ago
system.info.go d4d66391e5 Fixed desktop folder creation and user root creation bug 2 years ago
system.resetpw.go 70e028b2e4 Added ffmpeg factpry 2 protpty 1 year ago
test.go 0f84a11f18 Added darknet_arm64 and smart_arm64 binary 3 years ago
update-licenses.bat 328858bf9a Added template for nfs abstraction 3 years ago
user.go d717f056b8 Backup before trting user inject 1 year ago
wifi.go ab71858698 Replaced all Mv with GetPara or PostPara 2 years ago

README.md

ArozOS 2.0

This is the go implementation of ArozOS (aka ArOZ Online) Web Desktop environment,designed to run on linux, but somehow still works on Windows and Mac OS

This README file is intended for developer only. If you are normal users, please refer to the README file outside of the /src folder.

Development Notes

  • Start each module with {ModuleName}Init() function, e.g. WiFiInit()
  • Put your function in mod (if possible) and call it in the main program
  • Do not change the sequence in the startup() function unless necessary
  • When in doubt, add startup flags (and use startup flag to disable experimental functions on startup)

Vendor Resources Overwrite

If you want to overwrite vendor related resources in ArozOS 2.012 or above, create a folder in the system root named vendor-res and put the replacement files inside here. Here is a list of supported replacement resources files

Filename Recommended Format Usage
auth_bg.jpg 2938 x 1653 px Login Wallpaper
auth_icon.png 5900 x 1180 px Authentication Page Logo
vendor_icon.png 1560 x 600 px Vendor Brand Icon

(To be expanded)

File System Virtualization and File System Abstractions Layers

The ArozOS system contains both the virtualization layer and abstraction layer. The easiest way to check if your path is under which layer is by looking at their starting dir name.

Path Structure Example Path Layer
{vroot_id}:/{subpath} user:/Desktop/myfile.txt File System Virtualization Layer (Highest Layer)
fsh (*File System Handler) + subpath (string) fsh (localfs) + /files/users/alan/Desktop/myfile.txt File System Abstraction
{physical_location}/{subpath} /home/aroz/arozos/files/users/Desktop/myfile.txt Physical (Disk) Layer

Since ArozOS v2.000, we added File System Abstraction (fsa, or sometime as seen as fshAbs, abbr for "File System Handler underlaying File System Abstraction) to the (already complex) File System Handler (fsh) infrastruture. There are two type of fsh that are currently supported by ArozOS File System Abstraction layer.

ArOZ JavaScript Gateway Interface / Plugin Loader

The ArOZ AJGI / AGI interface provide a JavaScript programmable interface for ArozOS 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 agi-doc.md

AGI script can be run as different scope and permissions.

Scope Usable Functions
WebApp startup script (init.agi) System Functions and Registrations
WebApp contained scripts System Functions and User Functions
Others (Web Root / Serverless / Scheduler) System Functions, User Functions ( with script register owner scope) and serverless

Subservice Logics and Configuration

To intergrate other binary based web server to the subservice interface, you can create a folder inside the "./subservice/your_service" where your binary executable should be named identically with the containing directory. For example, you have a module that provides web ui named "demo.exe", then your should put the demo.exe into "./subservice/demo/demo.exe".

In the case of Linux environment, the subservice routine will first if the module is installed via apt-get by checking with the "which" program. (If you got busybox, it should be built in) If the package is not found in the apt list, the binary of the program will be searched under the subservice directory.

Please follow the naming convention given in the build.sh template. For example, the corresponding platform will search for the corresponding binary excitable filename:

demo_linux_amd64    => Linux AMD64
demo_linux_arm      => Linux ARMv6l / v7l
demo_linux_arm64    => Linux ARM64
demo_macOS_amd64    => MacOS AMD64 

Startup Flags

During the startup of the subservice, two types of parameter will be passed in. Here are the examples

demo.exe -info
demo.exe -port 12810 -rpt "http://localhost:8080/api/ajgi/interface"

In the case of receiving the "info" flag, the program should print the JSON string with correct module information as stated in the struct below.

//Struct for storing module information
type serviecInfo struct{
    Name string                //Name of this module. e.g. "Audio"
    Desc string                //Description for this module
    Group string            //Group of the module, e.g. "system" / "media" etc
    IconPath string            //Module icon image path e.g. "Audio/img/function_icon.png"
    Version string            //Version of the module. Format: [0-9]*.[0-9][0-9].[0-9]
    StartDir string         //Default starting dir, e.g. "Audio/index.html"
    SupportFW bool             //Support floatWindow. If yes, floatWindow dir will be loaded
    LaunchFWDir string         //This link will be launched instead of 'StartDir' if fw mode
    SupportEmb bool            //Support embedded mode
    LaunchEmb string         //This link will be launched instead of StartDir / Fw if a file is opened with this module
    InitFWSize []int         //Floatwindow init size. [0] => Width, [1] => Height
    InitEmbSize []int        //Embedded mode init size. [0] => Width, [1] => Height
    SupportedExt []string     //Supported File Extensions. e.g. ".mp3", ".flac", ".wav"
}

//Example Usage when reciving the -info flag
infoObject := serviecInfo{
        Name: "Demo Subservice",
        Desc: "A simple subservice code for showing how subservice works in ArOZ Online",            
        Group: "Development",
        IconPath: "demo/icon.png",
        Version: "0.0.1",
        //You can define any path before the actualy html file. This directory (in this case demo/ ) will be the reverse proxy endpoint for this module
        StartDir: "demo/home.html",            
        SupportFW: true, 
        LaunchFWDir: "demo/home.html",
        SupportEmb: true,
        LaunchEmb: "demo/embedded.html",
        InitFWSize: []int{720, 480},
        InitEmbSize: []int{720, 480},
        SupportedExt: []string{".txt",".md"},
    }

jsonString, _ := json.Marshal(info);
fmt.Println(string(infoObject))
os.Exit(0);

When receiving the port flag, the program should start the web ui at the given port. The following is an example for the implementation of such functionality.

var port = flag.String("port", ":80", "The default listening endpoint for this subservice")
flag.Parse()
err := http.ListenAndServe(*port, nil)
if err != nil {
    log.Fatal(err)
}

Subservice Exec Settings

In default, subservice routine will create a reverse proxy with URL rewrite build in that serve your web ui launched from the binary executable. If you do not need a reverse proxy connection, want a custom launch script or else, you can use the following setting files.

.noproxy        => Do not start a proxy to the given port
.startscript    => Send the launch parameter to the "start.bat" or "start.sh" file instead of the binary executable
.disabled        => Do not load this subservice during startup. But the user can enable it via the setting interface

Here is an example "start.bat" used in integrating Syncthing into ArOZ Online System with ".startscript" file placed next to the syncthing.exe file.

if not exist ".\config" mkdir ".\config"
syncthing.exe -home=".\config" -no-browser -gui-address=127.0.0.1%2

Systemd support

To enable systemd in your host that support aroz online system, create a bash script at your aroz online root named "start.sh" and fill it up with your prefered startup paratmers. The most basic one is as follow:

#/bin/bash
sudo ./aroz_online_linux_amd64

And then you can create a new file called "arozos.service" in /etc/systemd/system with the following contents (Assume your aroz online root is at /home/pi/arozos)

[Unit]
Description=ArozOS Cloud Desktop Service.

[Service]
Type=simple
WorkingDirectory=/home/pi/arozos/
ExecStart=/bin/bash /home/pi/arozos/start.sh

Restart=always
RestartSec=10

[Install]
WantedBy=multi-user.target

Finally to enable the service, use the following systemd commands

#Enable the script during the startup process
sudo systemctl enable arozos.service

#Start the service now
sudo systemctl start arozos.service

#Show the status of the service
systemctl status arozos.service


#Disable the service if you no longer want it to start during boot
sudo systemctl disable aroz-online.service