paprikkafox/aspia-server repository overview

⁠Сервер Aspia (Relay + Router) - Инструкция на Русском языке

https://github.com/paprikkafox/aspia-server-docker⁠

Данный контейнер предназначен для быстрого развертывания сервера удаленного доступа с открытым исходным кодом (aspia.org)

⁠Необходимые условия:

• VDS (или компьютер с выделенным белым IP адресом)
• Установленная на нем ОС Linux (проверено на Debian 11, Ubuntu 20.04, подойдет любая с поддержкой Docker)
• Открытые порты 8060, 8070 на маршрутизаторе
• ROOT (SUDO) доступ в ОС

⁠Установка Docker:

Для Debian и Ubuntu:

sudo apt update # Обновляем репозитории
sudo apt upgrade # Обновляем пакеты системы
sudo apt install docker.io docker-compose # Установка Docker и docker-compose
sudo systemctl enable --now docker.service # Включаем и запускаем главный сервис Docker
sudo usermod -aG docker $USER # Добавляем текущего пользователя в группу docker, для работы без root прав (sudo)`

⁠Установка Сервера Aspia:

⁠С помощью docker run

Для запуска контейнера проверьте что ваше окружение соответствует условиям выше

sudo docker run -d \
  --name=aspia-server \
  --hostname=aspia-server \
  -e EXTERNAL_IP=88.22.11.33 \
  -p 8070:8070 \
  -p 8060:8060 \
  -v ./data/database:/var/lib/aspia:rw \
  -v ./data/config:/etc/aspia:rw \
  --restart always \
  paprikkafox/aspia-server:latest

В данном примере переменная EXTERNAL_IP является ВНЕШНИМ IP адресом ПК или VDS, с открытыми на него портами 8060 и 8080

 sudo docker ps

Вы увидете вывод комманды, статус запущенного контейнера, как на примере ниже Up 1 minutes.

Если в статусе написано Restarting или Down - проверьте правильность выполнения шагов по настройке, повторите снова.

3d590767b3ae   paprikkafox/aspia-server:latest   "/bin/sh -c 'nohup /…"   1 minutes ago   Up 1 minutes  0.0.0.0:8060->8060/tcp, 0.0.0.0:8070->8070/tcp

⁠С помощью docker-compose

Данный метод отличается от предыдущего своей гибкостью и воспроизводимостью.

Для начала создаем в любой директории на VDS файл docker-compose.yml с следующим содержанием:

central-aspia-server:
   image: paprikkafox/aspia-server:latest
   container_name: central-aspia-server
   hostname: central-aspia-server
   environment:
     - EXTERNAL_IP=88.22.11.33
   volumes:
     - ./data/database:/var/lib/aspia:rw
     - ./data/config:/etc/aspia:rw
   ports:
     - 8070:8070
     - 8060:8060
   restart: unless-stopped

Как описано выше EXTERNAL_IP - Ваш внешний IP адрес. central-aspia-server - название контейнера с сервером Aspia.

Конфигурация и база данных в примере хранится в папке 'data', рядом с 'docker-compose.yml'

В той же директории, где находится docker-compose.yml запускаем команду:

docker-compose up -d

И смотрим состояние контейнера:

sudo docker ps

Код проекта доступен под лицензией GNU General Public License 3 - Aspia Remote Control⁠

Главный разработчик и автор проекта - Dmitry Chapyshev - dchapyshev⁠

Сопровождающий Docker-образа Aspia Server - Dmitry Fox - paprikkafox⁠

⁠Aspia Server (Relay + Router) - Guide in English

https://github.com/paprikkafox/aspia-server-docker⁠

This container is designed for rapid deployment of an open source remote access server (aspia.org)

⁠The necessary conditions:

• VDS (or a computer with a dedicated white IP address)
• Linux OS installed on it (tested on Debian 11, Ubuntu 20.04, any with Docker support will do)
• Open ports 8060, 8070 on the router
• ROOT (SUDO) access to the OS

⁠Docker installation:

For Debian and Ubuntu:

sudo apt update # Update repositories
sudo apt upgrade # Update system packages
sudo apt install docker.io docker-compose # Install Docker and docker-compose
sudo systemctl enable --now docker.service # Enable and start the main Docker service
sudo usermod -aG docker $USER # Add the current user to the docker group, to work without root rights (sudo)`

⁠Installing the Aspia Server:

⁠With docker run

To run the container, check that your environment matches the conditions above

sudo docker run -d \
  --name=aspia-server \
  --hostname=aspia-server \
  -e EXTERNAL_IP=88.22.11.33 \
  -p 8070:8070 \
  -p 8060:8060 \
  -v ./data/database:/var/lib/aspia:rw \
  -v ./data/config:/etc/aspia:rw \
  --restart unless-stopped \
  paprikkafox/aspia-server:latest

In this example, the EXTERNAL_IP variable is the EXTERNAL IP address of the PC or VDS, with ports 8060 and 8080 open to it

 sudo docker ps

You will see the output of the command, the status of the running container, as in the example below Up 1 minutes.

If the status says Restarting or Down - check that the configuration steps have been completed correctly, repeat again.

3d590767b3ae paprikkafox/aspia-server:latest "/bin/sh -c 'nohup /…" 1 minutes ago Up 1 minutes 0.0.0.0:8060->8060/tcp, 0.0.0.0:8070->8070/tcp

⁠With docker-compose

This method differs from the previous one in its flexibility and reproducibility.

First, create a docker-compose.yml file in any directory on the VDS with the following content:

central-aspia-server:
   image:paprikkafox/aspia-server:latest
   container_name: central-aspia-server
   hostname: central-aspia-server
   environment:
     - PUID=1000
     - PGID=1000
     - TZ="Europe/Moscow"
     - EXTERNAL_IP=88.22.11.33
   volumes:
     - ./data/database:/var/lib/aspia:rw
     - ./data/config:/etc/aspia:rw
   ports:
     - 8070:8070
     - 8060:8060
   restart: unless-stopped

As described above EXTERNAL_IP - Your external IP address. central-aspia-server - name of the Aspia server container.

The configuration and the database in this example is stored in the 'data' folder, next to 'docker-compose.yml'

In the same directory where docker-compose.yml is located, run the command:

docker-compose up -d

And look at the state of the container:

sudo docker ps

The project code is available under the GNU General Public License 3 - Aspia Remote Control⁠

The main developer and author of the project is Dmitry Chapyshev - dchapyshev⁠

Aspia Server Docker image maintainer - Dmitry Fox - paprikkafox⁠