Server Open Source Version Deployment Guide - Windows #

Install docker desktop #

Please download the corresponding Docker Desktop, and start it after the installation is complete.

Docker Desktop for Windows

Install AO.space Server #

Please execute the following commands on the host machine using "Windows PowerShell":

1. Create docker network

docker network create ao-space

2. Start aospace-all-in-one

docker run -d --name aospace-all-in-one `
--restart always `
--network=ao-space `
--publish 5678:5678 `
--publish 127.0.0.1:5680:5680 `
-v c:/aospace:/aospace `
-v //var/run/docker.sock:/var/run/docker.sock:ro `
-e AOSPACE_DATADIR=/run/desktop/mnt/host/c/aospace `
ghcr.io/ao-space/space-agent:latest

In the above command, c:/aospace means that the data is stored in the c:/aospace directory and can be changed by yourself. Please note that when modifying this directory, you need to also modify c/aospace in /run/desktop/mnt/host/c/aospace (where c means C drive). This data storage directory requires read and write permissions.

Use #

Firewall #

Please allow network access to ports 5678, 9980, and 9443 in the computer firewall. You can also turn off the firewall for testing.

The above 5678 port is generally used for interface calls such as binding and unbinding in the LAN. If you deploy it on a cloud server and use it on the public network, you can turn off external access to port 5678 in the cloud host manufacturer's firewall settings after binding the mobile APP. Ports 9980 and 9443 are used to directly connect the mobile phone APP to the Aospace server in the local area network. If it is deployed on the cloud server, it is also recommended to close it in the firewall settings of the cloud host manufacturer, which will not affect the normal use. UDP 61001 to 62000 are used for peer-to-peer access (P2P) and can also be opened in the firewall for cloud server deployment.

Apply to Beta #

The open beta quota is now full. For the latest news, please follow the official account of AO.space.

Bind Device #

Please open the following URL on your computer's browser: http://< local area network IP address of your computer >:5678. For example, http://192.168.0.115:5678, where 192.168.0.115 is the local area network IP address of your current computer, and you need to replace it with the IP address of your personal computer,please do not use 127.0.0.1. In the opened webpage, enter the email address you applied for, and the activation code in the email, and click "Submit". If the AO.space docker container image has not been fully downloaded at this time, it will prompt that it is downloading, and the web page does not need to be closed. After the container installation is complete, click the "Submit" button.

After the verification of the public beta activation code is successful, the QR code that appears on the web page is the QR code of the Aospace computer terminal device. You need to download and install the Ao Space APP client to use it together. You can search for "AO.space" in the App Store or enter AO.space Download Center to scan the code to download, open the AO.space App on the login page Click the "Bind Device" button to enter the bound device page and click "Scan QR Code" to scan the QR code of the device on the computer to bind. After the binding is successful, you can start using it.

Precautions #

• When binding the device, it is necessary to ensure that the computer and the mobile phone are in the same LAN. After the binding is successful, it is not necessary to be in the same LAN.
• The activation code is valid for 24 hours, please obtain it again after it expires.
• One mailbox can only activate one PC device. If you want to use more devices, please change the mailbox and apply again.

Update #

Method 1 Upgrade within the AO.space App #

AO.space App [Mine] - [Device] - [System Upgrade] You can choose to upgrade automatically or manually

Method 2 Command line upgrade #

Delete aospace-all-in-one #

Please execute the following commands in sequence on the command line of the host machine. Please use "Windows PowerShell" to execute them :

docker stop aospace-all-in-one
docker rm aospace-all-in-one
docker rmi -f $(docker images -q ghcr.io/ao-space/space-agent)

Update aospace-all-in-one #

Execute the installation command in the section Installing AO.space Server in this document, but do not create the docker network again. Please execute this command using "Windows PowerShell":

docker run -d --name aospace-all-in-one `
--restart always `
--network=ao-space `
--publish 5678:5678 `
--publish 127.0.0.1:5680:5680 `
-v c:/aospace:/aospace `
-v //var/run/docker.sock:/var/run/docker.sock:ro `
-e AOSPACE_DATADIR=/run/desktop/mnt/host/c/aospace `
ghcr.io/ao-space/space-agent:latest

The update is now complete. The original data remains in the data directory specified during installation.

Uninstall #

Please execute this command using "Windows PowerShell":

docker exec -t aospace-all-in-one /usr/bin/docker-compose -f /aospace/opt/tmp/docker-compose.yml down
docker stop aospace-all-in-one
docker rm aospace-all-in-one
docker rmi -f $(docker images -q ghcr.io/ao-space/*)
docker network rm ao-space

Delete the data directory specified in the Install AO.space Server section on the host.

So far the uninstallation is complete.

Clean #

Use the following command to delete the Docker images and data volumes that are not used by containers. Note that this command will delete the temporarily closed container and the temporarily unused Docker image. Please use with caution!

docker system prune --all --force --volumes

Contact us #

If you encounter difficulties in using it, you can check AO.space Help or Contact us.