Metadata-Version: 2.1
Name: termidesk-assistant
Version: 0.9.0.26172
Summary: A Django application for remote support of Termidesk users.
Home-page: https://termidesk.ru/
Author: Termidesk Team
Author-email: support@uveon.ru
License: BSD-3-Clause  # Example license
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 3.2.22  # Replace "X.Y" as appropriate
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Requires-Python: >=3.7
License-File: LICENSE
Requires-Dist: Django==3.2.22
Requires-Dist: daphne==3.0.2
Requires-Dist: channels==4.0.0
Requires-Dist: channels-redis==4.1.0
Requires-Dist: setuptools==65.5.1
Requires-Dist: cryptography==41.0.6
Requires-Dist: structlog==23.1.0
Requires-Dist: django-structlog==5.3.0
Requires-Dist: websockets==11.0.3
Requires-Dist: asgiref==3.7.2
Requires-Dist: djangorestframework==3.14.0
Requires-Dist: uritemplate==4.1.1
Requires-Dist: redis==5.0.1
Requires-Dist: twisted==23.8.0
Requires-Dist: pymemcache==4.0.0
Requires-Dist: pyOpenSSL==25.0.0
Requires-Dist: legacy-cgi>=1.0.0; python_version >= "3.13"

=========
Assistant
=========

Assistant is an application for remote support of Termidesk users


Build package
1. To build package need executed script in ci directory:

cd ci && build_plugins.sh

Install package
---------------

1. To install the package, use pip in Termidesk environment only:

cd /opt/termidesk/share/termidesk-vdi
source venv/bin/activate
pip install path/to/termidesk-assistant-0.0.1.tar.gz

2. Update static files

manage.py collectstatic

3. Restart server Termidesk

sudo systemctl restart termidesk-vdi.service

4. Go to index page http://termidesk-server/assistant/

Uninstall package
---------------

1. To uninstall the package, need stoped server 

sudo systemctl stop termidesk-vdi.service

2. To remove the package, use pip in Termidesk environment only:

cd /opt/termidesk/share/termidesk-vdi
source venv/bin/activate
pip uninstall termidesk-assistants

2. Start server again

sudo systemctl start termidesk-vdi.service

Developer Guide
---------------

1. Create and activate pip environment

mkdir -p ~/workplace/assistant
cd ~/workplace/assistant
python -m venv .venv
source .venv/bin/activate

2. Install Django and dependencies

pip install Django>=2.2.17

3. Add "termidesk_assistant" to your INSTALLED_APPS setting like this:

    INSTALLED_APPS = [
        ...
        'termidesk_assistant',
    ]

4. Include the polls URLconf in your project urls.py like this:

    path('admin/', admin.site.urls),
    ...
    path('', include('termidesk_assistant.urls')),

5. Run ``python manage.py migrate`` to create the polls models.

6. Start the development server

./manage.py  runserver

7. Go to index page http://127.0.0.1:8180/assistant/


Installing the server part of the application from deb packages
---------------------------------------------------------------

1. Install deb package

linux-cli$ sudo termidesk-assistant-server_x.x.x.00000_amd64.deb

2. Termidesk Assistant Singnaling

linux-cli$ sudo systemctl enable termidesk-assistant-signaling.service
linux-cli$ sudo systemctl start termidesk-assistant-signaling.service

3. Starting Termidesk Assistant Server

linux-cli$ sudo systemctl enable termidesk-assistant-server.service
linux-cli$ sudo systemctl start termidesk-assistant-server.service

4. In a browser, open the web page https://192.168.16.39/assistant and get the
   connection ID from the line "Our ID xxxx" where the connection ID is xxxx.

Installing the client part of the application from deb packages
---------------------------------------------------------------

1. Install deb package

linux-cli$ sudo termidesk-assistant-client_x.x.x.00000_amd64.deb

2. Starting the client application

linux-cli$ termidesk-assistant

In Server URL filed enter address signaling server, for example
https://192.168.16.39/assistant/ws/signalling
In Session ID filed enter connection ID from server side. Press "Connection" 
and on server side the user's desktop should be displayed.

