README.md 11.4 KB
Newer Older
Antenore Gatta's avatar
Antenore Gatta committed
1
[![](https://img.shields.io/liberapay/patrons/:entity.svg)](https://liberapay.com/Remmina/)
2
[![Snap Status](https://build.snapcraft.io/badge/FreeRDP/Remmina.svg)](https://build.snapcraft.io/user/FreeRDP/Remmina)
larchunix's avatar
larchunix committed
3 4 5
[![Build Status](https://gitlab.com/Remmina/Remmina/badges/master/build.svg)](https://gitlab.com/Remmina/Remmina/pipelines)
[![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
6

Antenore Gatta's avatar
Antenore Gatta committed
7 8
# IMPORTANT NOTICE

Antenore Gatta's avatar
Antenore Gatta committed
9
We have moved to [gitlab](https://gitlab.com/Remmina/Remmina)
Antenore Gatta's avatar
Antenore Gatta committed
10

Antenore Gatta's avatar
Antenore Gatta committed
11
Since the 1st of July 2018 the following links have to be used instead of GitHub.
Antenore Gatta's avatar
Antenore Gatta committed
12

13 14
* [issues URL](https://gitlab.com/Remmina/Remmina/issues)
* [wiki URL](https://gitlab.com/Remmina/Remmina/wikis/home)
Antenore Gatta's avatar
Antenore Gatta committed
15

16 17 18 19 20 21 22 23
# 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
24
multiple network protocols in an integrated and consistent user interface.
Antenore Gatta's avatar
Antenore Gatta committed
25
Currently RDP, VNC, SPICE, NX, XDMCP, SSH and EXEC are supported.
26 27 28 29 30 31 32 33 34 35 36 37 38 39

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.

40 41 42 43 44 45 46 47 48 49 50
### 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
51
sudo apt install -t stretch-backports remmina remmina-plugin-rdp remmina-plugin-secret
52 53
```

54 55
### Ubuntu

56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75
#### 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
```

76
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:
77 78 79 80 81

```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
82
sudo snap connect remmina:password-manager-service :password-manager-service # gnome-keyring
83 84 85 86 87 88
```

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

#### From PPA

89 90 91 92 93 94 95 96 97 98
[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
99
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:
100 101 102 103 104
```sh
sudo add-apt-repository ppa:kedazo/libssh-0.7.x
sudo apt-get update
```

105
### Fedora and Red Hat
106

107
As of March 2018 Remmina is available on most fedora testing and stable, we still have a (not updated) copr provided by [Hubbitus](https://github.com/Hubbitus) (Pavel Alexeev), to install just execute as root:
108 109

```sh
Antenore Gatta's avatar
Antenore Gatta committed
110 111
dnf copr enable hubbitus/remmina-next
dnf upgrade --refresh 'remmina*' 'freerdp*'
112 113
```

Antenore Gatta's avatar
Antenore Gatta committed
114 115
~~On Red Hat you can enable the EPEL repository:~~

Antenore Gatta's avatar
Antenore Gatta committed
116
Note: Unlucky Remmina is not yet in EPEL, you can help submitting a request on the [Red Hat bugzilla](https://bugzilla.redhat.com/).
117 118 119 120 121 122

```sh
wget http://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm
rpm -ivh epel-release-latest-7.noarch.rpm
```

123 124 125 126
### Arch Linux based

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

127 128 129 130 131 132 133 134 135 136 137
### openSUSE

Remmina is in the offical repositories for all openSUSE distributions.
In case the version in the released stable branch of openSUSE is too old you can install the latest one from the [devel project](https://build.opensuse.org/package/show/X11%3ARemoteDesktop/remmina) via:

```
zypper ar -f obs://X11:RemoteDesktop/remmina remmina
zypper ref
zypper in remmina
```

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

Antenore Gatta's avatar
Antenore Gatta committed
140 141 142 143 144 145 146 147 148 149 150 151 152 153 154
## Development snapshot

Download [this](https://gitlab.com/Remmina/Remmina/-/jobs/artifacts/master/raw/flatpak/remmina-dev.flatpak\?job\=flatpak:test) flatpak
and install it as described here

```sh
flatpak remote-add --user --if-not-exists flathub https://flathub.org/repo/flathub.flatpakrepo
flatpak install --user --bundle remmina-dev.flatpak
flatpak run org.remmina.Remmina
```

## Last stable official build on [FlatHub](https://flathub.org/apps/details/org.remmina.Remmina)

Execute the following commands.

Antenore Gatta's avatar
Antenore Gatta committed
155
```sh
Antenore Gatta's avatar
Antenore Gatta committed
156 157
flatpak remote-add --user --if-not-exists flathub https://flathub.org/repo/flathub.flatpakrepo
flatpak install --user flathub org.remmina.Remmina
158
flatpak run org.remmina.Remmina
Antenore Gatta's avatar
Antenore Gatta committed
159
```
160 161 162 163 164
If you use SSH agent (https://github.com/flatpak/flatpak/issues/1438 )

```sh
flatpak run --filesystem=$SSH_AUTH_SOCK --env=SSH_AUTH_SOCK=$SSH_AUTH_SOCK org.remmina.Remmina
```
Antenore Gatta's avatar
Antenore Gatta committed
165 166 167 168 169 170

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

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

Antenore Gatta's avatar
Antenore Gatta committed
173 174 175 176 177 178 179
* [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.
180

181 182
### From the source code

Giovanni Panozzo's avatar
Giovanni Panozzo committed
183
Follow the guides available on the wiki:
larchunix's avatar
larchunix committed
184
* [Wiki and compilation instructions](https://gitlab.com/Remmina/Remmina/wikis/home)
185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203

## 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
204
  -V, --full-version          Show the application's version, including the plugin versions
205 206 207 208 209
  --display=DISPLAY           X display to use
```

## Configuration

Antenore Gatta's avatar
Antenore Gatta committed
210
You can configure everything from the graphical interface or editing by hand the files under $HOME/.remmina or $HOME/.config/remmina
211 212 213

## Contributing

214
See [CONTRIBUTING.md](CONTRIBUTING.md) for a better overview.
Antenore Gatta's avatar
Antenore Gatta committed
215

216 217
If you want to contribute with code:

218
1. Fork it
219 220 221 222 223 224 225
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
226 227
### Donations

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

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

232
See the [THANKS.md](THANKS.md) file for an exhaustive list of supporters.
233

Antenore Gatta's avatar
Antenore Gatta committed
234 235
#### Paypal

Antenore Gatta's avatar
Antenore Gatta committed
236
[![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
237

Antenore Gatta's avatar
Antenore Gatta committed
238 239
#### Bitcoin

Antenore Gatta's avatar
Antenore Gatta committed
240
[![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
241

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

Antenore Gatta's avatar
Antenore Gatta committed
244 245
- Remmina bitcoin address:  1298H2vaxcbDQRuRYkDjfFbvGEgxE1CNjk
- Message: Remmina Donation
246 247 248 249 250 251 252

## Authors

Remmina is maintained by:

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

255
See the [AUTHORS](AUTHORS) for an exhaustive list.
256 257 258 259
If you are not listed and you have contributed, feel free to update that file.

## Resources

larchunix's avatar
larchunix committed
260
 * [Wiki and compilation instructions](https://gitlab.com/Remmina/Remmina/wikis/home)
261
 * [G+ Remmina community](https://plus.google.com/communities/106276095923371962010)
262
 * [Website](http://www.remmina.org)
263
 * IRC we are on freenode.net , in the channel #remmina, you can also use a [web client](https://webchat.freenode.net/) in case
264 265 266 267

## License

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