jobdiogenes / rustdesk-api-server

rustdesk api server

The project has been upgraded to Rustdesk-api-server-pro

This is an open source rustdesk api server , it is based on the yii2 framework development.

REQUIREMENTS

• PHP >= 7.4.
• rustdesk >= 1.2.3
• mysql >= 5.7 or sqlite3

INSTALLATION

Installation using composer

If you do not have Composer, you may install it by following the instructions at getcomposer.org.

You can then install dependencies using the following command:

composer install -vvv

Install with Docker

Update your vendor packages

docker-compose run --rm php composer update --prefer-dist

Run the installation triggers (creating cookie validation code)

docker-compose run --rm php composer install    

Start the container

docker-compose up -d

You can then access the application through the following URL:

http://127.0.0.1:8000

NOTES:

• Minimum required Docker engine version 17.04 for development (see Performance tuning for volume mounts)
• The default configuration uses a host-volume in your home directory .docker-composer for composer caches

CONFIGURATION

Database

Edit the file config/db.php with real data, for example:

return [
    'class' => 'yii\db\Connection',
    'dsn' => 'mysql:host=localhost;dbname=yii2basic',
    'username' => 'root',
    'password' => '1234',
    'charset' => 'utf8',
];

NOTES:

• Yii won't create the database for you, this has to be done manually before you can access it.
• Check and edit the other files in the config/ directory to customize your application as required.
• The server uses a sqlite database by default

Database Migration

You can migrate the database using the following command:

./yii migrate/up

RUN

./yii serve

Now, You can access it at http://localhost:8080

Create Your Account

http://localhost:8080/register/do?username=<username>&password=<password>&name=<nickname>&email=<email>&note=<note>

- username required
- password required
- name optional (It's like a nickname.)
- email optional
- note optional