The arozos repo

Alan Yeung 1485c2824c replaced log.Println to systemWideLogger.PrintAndLog 3 gadi atpakaļ
documents 1485c2824c replaced log.Println to systemWideLogger.PrintAndLog 3 gadi atpakaļ
examples 0f84a11f18 Added darknet_arm64 and smart_arm64 binary 3 gadi atpakaļ
legacy 2360e6660b Fixed bug in R2V translator in webdav driver 3 gadi atpakaļ
mod d6c8350936 Finalized File System abstraction, broke zip handler 3 gadi atpakaļ
subservice 4a05bb04be Added v1.130 mascot design drafts and revisions 3 gadi atpakaļ
system 1a97e5ba28 Fixed personal homepage bug 3 gadi atpakaļ
web d6c8350936 Finalized File System abstraction, broke zip handler 3 gadi atpakaļ
.gitignore 3dd7c868ac Added WIP system wide log 3 gadi atpakaļ
AGI Documentation.md 87008a5ec7 Completed Photo module, added WIP Nightly API call to agi interface 3 gadi atpakaļ
Makefile 3dd7c868ac Added WIP system wide log 3 gadi atpakaļ
README.md 988b5ccd24 Removed trash and updated README 4 gadi atpakaļ
agi.go 3dd7c868ac Added WIP system wide log 3 gadi atpakaļ
apt.go 3dd7c868ac Added WIP system wide log 3 gadi atpakaļ
auth.go 3dd7c868ac Added WIP system wide log 3 gadi atpakaļ
autopush.bat 8052702e98 Updated permission modes 4 gadi atpakaļ
autopush.sh 8052702e98 Updated permission modes 4 gadi atpakaļ
backup.go.disabled 2360e6660b Fixed bug in R2V translator in webdav driver 3 gadi atpakaļ
build.sh 7ef75ffbd1 Fixed more bugs 3 gadi atpakaļ
buildFullErrorList.bat 8052702e98 Updated permission modes 4 gadi atpakaļ
build_binary-only.sh 8052702e98 Updated permission modes 4 gadi atpakaļ
cluster.go 32bf29e0ab Updated shutdown sequence log 3 gadi atpakaļ
common.go_disabled f3ed495937 Migrated all root source code to use common module 3 gadi atpakaļ
console.go f3ed495937 Migrated all root source code to use common module 3 gadi atpakaļ
desktop.go 1485c2824c replaced log.Println to systemWideLogger.PrintAndLog 3 gadi atpakaļ
devices.go cdc2320d26 Moved locate.html to info tab 4 gadi atpakaļ
disk.go 32bf29e0ab Updated shutdown sequence log 3 gadi atpakaļ
error.go f3ed495937 Migrated all root source code to use common module 3 gadi atpakaļ
file_system.go d6c8350936 Finalized File System abstraction, broke zip handler 3 gadi atpakaļ
go.mod e38c43c50e Fixed File Manager remove share issue 3 gadi atpakaļ
go.sum e38c43c50e Fixed File Manager remove share issue 3 gadi atpakaļ
hardware.power.go 32bf29e0ab Updated shutdown sequence log 3 gadi atpakaļ
iot.go f3ed495937 Migrated all root source code to use common module 3 gadi atpakaļ
ldap.go 41ab40a03d Updated LDAP to make it better 3 gadi atpakaļ
localhost.crt 40ea2c13f5 Updated certificate 4 gadi atpakaļ
localhost.key 40ea2c13f5 Updated certificate 4 gadi atpakaļ
main.flags.go 3dd7c868ac Added WIP system wide log 3 gadi atpakaļ
main.go 1485c2824c replaced log.Println to systemWideLogger.PrintAndLog 3 gadi atpakaļ
main.router.go 94368c0f15 Finalized everything I guess 3 gadi atpakaļ
mediaServer.go 32bf29e0ab Updated shutdown sequence log 3 gadi atpakaļ
module.go 32bf29e0ab Updated shutdown sequence log 3 gadi atpakaļ
module.util.go 0aaf1582e5 Updated many smaller pages from tocasv2 to segmentic 3 gadi atpakaļ
network.forward.go 1485c2824c replaced log.Println to systemWideLogger.PrintAndLog 3 gadi atpakaļ
network.ftp.go 32bf29e0ab Updated shutdown sequence log 3 gadi atpakaļ
network.go 1485c2824c replaced log.Println to systemWideLogger.PrintAndLog 3 gadi atpakaļ
network.webdav.go f3ed495937 Migrated all root source code to use common module 3 gadi atpakaļ
notification.go 1485c2824c replaced log.Println to systemWideLogger.PrintAndLog 3 gadi atpakaļ
oauth.go 52791b19f8 Fixed diskmg unable to render not partitioned disk bug 4 gadi atpakaļ
openwrt-build.bat 0f84a11f18 Added darknet_arm64 and smart_arm64 binary 3 gadi atpakaļ
permission.go 1485c2824c replaced log.Println to systemWideLogger.PrintAndLog 3 gadi atpakaļ
quota.go 1485c2824c replaced log.Println to systemWideLogger.PrintAndLog 3 gadi atpakaļ
register.go f3ed495937 Migrated all root source code to use common module 3 gadi atpakaļ
riscv64-build.bat e523a3e131 Added experimental riscv64 support 3 gadi atpakaļ
scheduler.go 1485c2824c replaced log.Println to systemWideLogger.PrintAndLog 3 gadi atpakaļ
security.go f3ed495937 Migrated all root source code to use common module 3 gadi atpakaļ
setting.advance.go f3ed495937 Migrated all root source code to use common module 3 gadi atpakaļ
setting.go f3ed495937 Migrated all root source code to use common module 3 gadi atpakaļ
start.sh ecdded5c02 Added localization for authreq 4 gadi atpakaļ
startup.flags.go 1485c2824c replaced log.Println to systemWideLogger.PrintAndLog 3 gadi atpakaļ
startup.go 1485c2824c replaced log.Println to systemWideLogger.PrintAndLog 3 gadi atpakaļ
storage.bridge.go 1485c2824c replaced log.Println to systemWideLogger.PrintAndLog 3 gadi atpakaļ
storage.go 1485c2824c replaced log.Println to systemWideLogger.PrintAndLog 3 gadi atpakaļ
storage.pool.go 1485c2824c replaced log.Println to systemWideLogger.PrintAndLog 3 gadi atpakaļ
subservice.go f3ed495937 Migrated all root source code to use common module 3 gadi atpakaļ
system.go 1485c2824c replaced log.Println to systemWideLogger.PrintAndLog 3 gadi atpakaļ
system.info.go 1485c2824c replaced log.Println to systemWideLogger.PrintAndLog 3 gadi atpakaļ
system.resetpw.go f3ed495937 Migrated all root source code to use common module 3 gadi atpakaļ
test.go 0f84a11f18 Added darknet_arm64 and smart_arm64 binary 3 gadi atpakaļ
user.go 1485c2824c replaced log.Println to systemWideLogger.PrintAndLog 3 gadi atpakaļ
wifi.go 1485c2824c replaced log.Println to systemWideLogger.PrintAndLog 3 gadi atpakaļ

README.md

ArozOS

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

Development Notes

  • Start each module with {ModuleName}Init() function, e.g. WiFiInit()
  • Put your function in module (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)

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 AJGI Documentation.

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 (Not tested)

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