https://github.com/ovh/vbridge

X11 cloud desktop software
https://github.com/ovh/vbridge

Last synced: about 2 months ago
JSON representation

X11 cloud desktop software

• Host: GitHub
• URL: https://github.com/ovh/vbridge
• Owner: ovh
• License: bsd-3-clause
• Archived: true
• Created: 2017-10-24T14:31:45.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2017-11-06T10:55:40.000Z (almost 7 years ago)
• Last Synced: 2024-07-03T04:06:01.827Z (3 months ago)
• Language: C
• Homepage:
• Size: 120 KB
• Stars: 7
• Watchers: 8
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# vbridge

Cloud desktop software

## Usage

vBridge is a client/server tool.

`vbridged`, the server, must be launched on the X session you want to connect to.

`vbridge`, the client, can be launched anywhere as long as it can connect to `vbridged`.

### Example

On the desktop you want to connect:

~~~

$ vbridged

~~~

On the desktop you want to see the remote one:

~~~

$ vbridge host-to-connect-to.tld

~~~

## Authentication

Two methods are possible: via a key or via login/password.

For using the login/password, simply use the login and password of the account where you launched the server.

For the key:

- Launch the server

- Launch the client. The client will ask you to confirm you trust the server. Accepts both times and quit without performing the login with password.

- On the client's host, copy the content of the `~/.vbridge/connect` file

- On the servers's host, paste the content copied on the previous step into `~/.vbridge/accept` file

- On the servers's host, kill and relaunch the server `vbridged`

- On the client's host, launch the client. It will be authenticated without asking login and password.

### Options

~~~

  --port=PORT              port to listen

  --ciphers=LIST           sets the list of ciphers

  --rsa-length=NUMBER      RSA modulus length (in bits)

  --rsa-exponent=NUMBER    RSA public exponent

  --ecdh-curve=NAME        ECDH curve name

  --background             run in background

  --reinit-cred            reinitialize the user's pam credentials

  --timeout=NUMBER         inactivity timeout

  --version                display version information

  --help                   display this help

~~~

## Compilation

### Compilation requirements

vBridge needs the following packets to be installed for the compilation:

- gcc

- make

- libx11-dev

- libxfixes-dev

- libxext-dev

- libxi-dev

- libxtst-dev

- libxrandr-dev

- libkrb5-dev

- libpam0g-dev

- libssl-dev

- libcap-dev

### Compilation

`make` compiles and produces the `vbridge` and `vbridged` binaries.

Additionnally, you can compile it inside a Docker container.

Simply type the commands below:

~~~

$ docker build -t vbridge .

$ docker create vbridge vbridge

$ docker cp vbridge:/home/vbridge/vbridge .

$ docker cp vbridge:/home/vbridge/vbridged .

~~~