README.md 9.74 KB
Newer Older
1
[![Build Status](https://travis-ci.org/FreeRDP/Remmina.png)](https://travis-ci.org/FreeRDP/Remmina) [![Bountysource](https://img.shields.io/bountysource/team/remmina/activity.svg)](https://www.bountysource.com/teams/remmina) [![CodeTriage](https://www.codetriage.com/freerdp/remmina/badges/users.svg)](https://www.codetriage.com/freerdp/remmina)
Antenore Gatta's avatar
Antenore Gatta committed
2

3 4 5 6 7 8 9 10
# Remmina: The GTK+ Remote Desktop Client

Initially developed by [Vic Lee](https://github.com/llyzs)

## Description
**Remmina** is a remote desktop client written in GTK+, aiming to be useful for
system administrators and travellers, who need to work with lots of remote
computers in front of either large monitors or tiny netbooks. Remmina supports
11
multiple network protocols in an integrated and consistent user interface.
Antenore Gatta's avatar
Antenore Gatta committed
12
Currently RDP, VNC, SPICE, NX, XDMCP, SSH and EXEC are supported.
13 14 15 16 17 18 19 20 21 22 23 24 25 26

Remmina is released in separated source packages:
* "remmina", the main GTK+ application
* "remmina-plugins", a set of plugins

Remmina is free and open-source software, released under GNU GPL license.

## Installation

### Binary distributions
Usually remmina is included in your linux distribution or in an external repository.
Do not ask for distribution packages or precompiled binaries here.
This is a development site.

27 28 29 30 31 32 33 34 35 36 37
### Debian ###

Remmina is not available on the default Debian 9 (Stretch) repositories. It can be installed from the Backports repository.

The [Debian Backports](https://backports.debian.org/Instructions/) repository must be enabled to install it, see [this blog post](https://www.remmina.org/wp/debian-the-boys-are-backport-in-town/) for more information.

To install Remmina from Debian Backports, just copy and paste the following lines on a terminal window:

```
echo 'deb http://ftp.debian.org/debian stretch-backports main' | sudo tee --append /etc/apt/sources.list.d/stretch-backports.list >> /dev/null
sudo apt update
Antenore Gatta's avatar
Antenore Gatta committed
38
sudo apt install -t stretch-backports remmina remmina-plugin-rdp remmina-plugin-secret libfreerdp-plugins-standard
39 40
```

41 42
### Ubuntu

43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62
#### Using Snap Package (also for other [supported distros](https://snapcraft.io/docs/core/install))

You can install the last release from the Ubuntu Software center, looking for `remmina`, otherwise you can install it from terminal with:

```sh
sudo snap install remmina
```

If you want to install latest git revision of remmina, you can use it from the `edge` channel:

```sh
sudo snap install remmina  --edge
```

Or update the current installed version with the selected channel:

```sh
sudo snap refresh remmina --channel=edge # use --channel=stable otherwise
```

63
To enable some advanced features such as `mount-control` (to manage mount positions), `avahi-observer` (to automatically look for local servers to connect to), `cups-control` (to manage printing), `password-manager-service` (to use gnome-keyring) you should run something like:
64 65 66 67 68

```sh
sudo snap connect remmina:avahi-observe :avahi-observe # servers discovery
sudo snap connect remmina:cups-control :cups-control # printing
sudo snap connect remmina:mount-observe :mount-observe # mount management
69
sudo snap connect remmina:password-manager-service :password-manager-service # gnome-keyring
70 71 72 73 74 75
```

Snap packages will be updated automatically and will include both latest `FreeRDP` git and latest `libssh 0.7` release (for better security).

#### From PPA

76 77 78 79 80 81 82 83 84 85
[Ubuntu ppa:remmina-ppa-team/remmina-next](https://launchpad.net/~remmina-ppa-team/+archive/ubuntu/remmina-next)

To install it, just copy and paste the following three lines on a terminal window
```sh
sudo apt-add-repository ppa:remmina-ppa-team/remmina-next
sudo apt-get update
sudo apt-get install remmina remmina-plugin-rdp libfreerdp-plugins-standard
```
By default the RDP, SSH and SFTP plugins are installed. You can view a list of available plugins with `apt-cache search remmina-plugin`

Giovanni Panozzo's avatar
Giovanni Panozzo committed
86
If you want to connect to more securely configured SSH servers on Ubuntu 16.04 and below, you have to upgrade libssh to 0.7.X. This can be achieved by adding the following PPA containing libssh 0.7.X by David Kedves and upgrading your packages:
87 88 89 90 91
```sh
sudo add-apt-repository ppa:kedazo/libssh-0.7.x
sudo apt-get update
```

92 93
### Fedora

Antenore Gatta's avatar
Antenore Gatta committed
94 95
As of March 2018 Remmina is available on most fedora testing and stable, we still have a (not updated) copr

96 97 98
[Hubbitus](https://github.com/Hubbitus) (Pavel Alexeev) provided us a copr, to install just execute as root:

```sh
Antenore Gatta's avatar
Antenore Gatta committed
99 100
dnf copr enable hubbitus/remmina-next
dnf upgrade --refresh 'remmina*' 'freerdp*'
101 102 103 104 105 106
```

### Arch Linux based

Install [remmina-git](https://aur.archlinux.org/packages/remmina-git) from [AUR](https://aur.archlinux.org/)

Antenore Gatta's avatar
Antenore Gatta committed
107 108 109
### For users with a distro that supports [Flatpak](https://flathub.org/), including Ubuntu ###

```sh
Antenore Gatta's avatar
Antenore Gatta committed
110 111 112
flatpak remote-add --user --if-not-exists flathub https://flathub.org/repo/flathub.flatpakrepo
flatpak install --user flathub org.remmina.Remmina
flatpak run --user org.remmina.Remmina
Antenore Gatta's avatar
Antenore Gatta committed
113 114 115 116 117 118 119
```

Just be aware that flatpak store data for installed applications (the XDG config/data folders) under ```$HOME/.var```
So for instance, if you previously have installed remmina with another package manager, you will have to transfer what was under ```$HOME/.config/remmina``` and ```$HOME/.local/share/remmina``` under, respectively ```~/.var/app/org.remmina.Remmina/config/remmina``` and ```~/.var/app/org.remmina.Remmina/data/remmina```

### External not supported plugins

120 121
There are also some external, not supported plugins provided by [Muflone](https://github.com/muflone) :

Antenore Gatta's avatar
Antenore Gatta committed
122 123 124 125 126 127 128
* [remmina-plugin-folder](https://aur.archlinux.org/packages/remmina-plugin-folder/) A protocol plugin for Remmina to open a folder.
* [remmina-plugin-open](https://aur.archlinux.org/packages/remmina-plugin-open/) A protocol plugin for Remmina to open a document with its associated application.
* [remmina-plugin-rdesktop](https://aur.archlinux.org/packages/remmina-plugin-rdesktop/) A protocol plugin for Remmina to open a RDP connection with rdesktop.
* [remmina-plugin-teamviewer](https://aur.archlinux.org/packages/remmina-plugin-teamviewer/) A protocol plugin for Remmina to launch a TeamViewer connection.
* [remmina-plugin-ultravnc](https://aur.archlinux.org/packages/remmina-plugin-ultravnc/) A protocol plugin for Remmina to connect via VNC using UltraVNC viewer.
* [remmina-plugin-url](https://aur.archlinux.org/packages/remmina-plugin-url/) A protocol plugin for Remmina to open an URL in an external browser.
* [remmina-plugin-webkit](https://aur.archlinux.org/packages/remmina-plugin-webkit/) A protocol plugin for Remmina to launch a GTK+ Webkit browser.
129

130 131
### From the source code

Giovanni Panozzo's avatar
Giovanni Panozzo committed
132 133
Follow the guides available on the wiki:
* [Wiki and compilation instructions](https://github.com/FreeRDP/Remmina/wiki)
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152

## Usage

Just select Remmina from your application menu or execute remmina from the command line

Remmina support also the following options:

```sh
  -a, --about                 Show about dialog
  -c, --connect=FILE          Connect to a .remmina file
  -e, --edit=FILE             Edit a .remmina file
  -n, --new                   Create a new connection profile
  -p, --pref=PAGENR           Show preferences dialog page
  -x, --plugin=PLUGIN         Execute the plugin
  -q, --quit                  Quit the application
  -s, --server=SERVER         Use default server name
  -t, --protocol=PROTOCOL     Use default protocol
  -i, --icon                  Start as tray icon
  -v, --version               Show the application's version
Matteo F. Vescovi's avatar
Matteo F. Vescovi committed
153
  -V, --full-version          Show the application's version, including the plugin versions
154 155 156 157 158
  --display=DISPLAY           X display to use
```

## Configuration

Antenore Gatta's avatar
Antenore Gatta committed
159
You can configure everything from the graphical interface or editing by hand the files under $HOME/.remmina or $HOME/.config/remmina
160 161 162

## Contributing

Antenore Gatta's avatar
Antenore Gatta committed
163 164
See [CONTRIBUTING.md](https://raw.githubusercontent.com/FreeRDP/Remmina/next/CONTRIBUTING.md) for a better overview.

165 166 167 168 169 170 171 172 173 174
If you want to contribute with code:

1. [Fork it](https://github.com/FreeRDP/Remmina#fork-destination-box)
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request

If you want to contribute in other ways, drop us an email using the form provided in our web site.

Antenore Gatta's avatar
Antenore Gatta committed
175 176
### Donations

Antenore Gatta's avatar
Antenore Gatta committed
177
If you rather prefer to contribute to Remmina with money you are more than welcome.
Antenore Gatta's avatar
Antenore Gatta committed
178

Antenore Gatta's avatar
Antenore Gatta committed
179
For more informations See the [Remmina web site donation page](http://remmina.org/wp/donations).
Antenore Gatta's avatar
Antenore Gatta committed
180

Igor Vuk's avatar
Igor Vuk committed
181
See the [THANKS.md](https://raw.githubusercontent.com/FreeRDP/Remmina/next/THANKS.md) file for an exhaustive list of supporters.
182

Antenore Gatta's avatar
Antenore Gatta committed
183 184
#### Paypal

Antenore Gatta's avatar
Antenore Gatta committed
185
[![paypal](https://www.paypalobjects.com/en_US/CH/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=ZBD87JG52PTZC)
Antenore Gatta's avatar
Antenore Gatta committed
186

Antenore Gatta's avatar
Antenore Gatta committed
187 188
#### Bitcoin

Antenore Gatta's avatar
Antenore Gatta committed
189
[![bitcoin](http://www.remmina.org/wp/wp-content/uploads/2016/06/bitcoin_1298H2vaxcbDQRuR-e1465504491655.png)](bitcoin:1298H2vaxcbDQRuRYkDjfFbvGEgxE1CNjk?label=Remmina%20Donation)
Antenore Gatta's avatar
Antenore Gatta committed
190

Antenore Gatta's avatar
Antenore Gatta committed
191
If clicking on the line above does not work, use this payment info:
Antenore Gatta's avatar
Antenore Gatta committed
192

Antenore Gatta's avatar
Antenore Gatta committed
193 194
- Remmina bitcoin address:  1298H2vaxcbDQRuRYkDjfFbvGEgxE1CNjk
- Message: Remmina Donation
195 196 197 198 199 200 201

## Authors

Remmina is maintained by:

 * [Antenore Gatta](https://github.com/antenore)
 * [Giovanni Panozzo](https://github.com/giox069)
Antenore Gatta's avatar
Antenore Gatta committed
202
 * [Dario Cavedon](https://github.com/ic3d)
203

Igor Vuk's avatar
Igor Vuk committed
204
See the [AUTHORS](https://raw.githubusercontent.com/FreeRDP/Remmina/next/AUTHORS) for an exhaustive list.
205 206 207 208 209
If you are not listed and you have contributed, feel free to update that file.

## Resources

 * [Wiki and compilation instructions](https://github.com/FreeRDP/Remmina/wiki)
210
 * [G+ Remmina community](https://plus.google.com/communities/106276095923371962010)
211
 * [Website](http://www.remmina.org)
212
 * IRC we are on freenode.net , in the channel #remmina, you can also use a [web client](https://webchat.freenode.net/) in case
213 214 215 216

## License

Licensed under the [GPLv2](http://www.opensource.org/licenses/GPL-2.0) license