first working version of the Shutter Scp plugin
[shutter-scp.git] / README.rst
1 *************************
2 Shutter scp upload plugin
3 *************************
4 Copies a file via ``scp`` to a remote server and gives you the HTTP URL.
5
6 This is an upload plugin for Shutter__.
7
8 __ http://shutter-project.org/
9
10 =====
11 Setup
12 =====
13 0. Copy ``Scp.pm`` to ``/usr/share/shutter/resources/system/upload_plugins/upload/``
14 1. In the Shutter preferences, go to the upload tab and configure the username
15    and password for the Scp plugin:
16
17    Username is the remote path you want to copy it to,
18    e.g. ``example.org:screenshots/``.
19
20    Password is the HTTP base URL to prepend before the file name,
21    e.g. ``http://example.org/~user/screenshots/``
22
23 3. I expect that you have a ssh key setup, so that no password is asked.
24 4. That's it.
25
26
27 =====
28 Usage
29 =====
30 0. Make screenshot
31 1. Right-click on it, "export"
32 2. Select "Scp"
33 3. Click "Upload"
34
35
36 =======
37 License
38 =======
39 Licensed under the GPLv3 or later.
40
41
42 ======
43 Author
44 ======
45 Christian Weiske, cweiske@cweiske.de