README.rst

   1 *****************************
   2 grauphel - tomboy REST server
   3 *****************************
   4 ownCloud__ application implementing the `Tomboy`__ `REST API`__ for syncing notes.
   5
   6 Pretty stable.
   7
   8 __ http://owncloud.org/
   9 __ https://wiki.gnome.org/Apps/Tomboy
  10 __ https://wiki.gnome.org/Apps/Tomboy/Synchronization/REST/1.0
  11
  12
  13 .. contents::
  14
  15 ======
  16 Status
  17 ======
  18
  19 What works
  20 ==========
  21 - Note synchronization
  22 - OAuth token management interface
  23 - Database management interface (reset)
  24 - Viewing notes
  25 - Searching notes
  26 - Downloading notes as HTML and reStructuredText
  27
  28 What is missing
  29 ===============
  30 - Web interface to edit notes. I will probably not implement this.
  31   Patches welcome :-)
  32
  33
  34 =================
  35 Supported clients
  36 =================
  37 * Conboy__ (Nokia N900 Maemo)
  38 * Tomboy__ (Linux, Windows)
  39 * Tomdroid__ (Android)
  40
  41 __ http://conboy.garage.maemo.org/
  42 __ https://wiki.gnome.org/Apps/Tomboy
  43 __ https://launchpad.net/tomdroid
  44
  45
  46 Known working versions
  47 ======================
  48 grauphel 0.2.1 is known to work with:
  49
  50 * Tomboy 1.15.2, Linux
  51 * Tomboy 1.15.1, Windows
  52 * Tomdroid 0.7.5, Android 4.4.1
  53
  54 See the HowTo__ document for client-specific configuration instructions.
  55
  56 __ docs/howto.rst
  57
  58
  59 =============
  60 Functionality
  61 =============
  62
  63 Search
  64 ======
  65 You can use ownCloud's global search on the top right.
  66
  67 During search, the note's titles, tags and content are searched.
  68
  69 Search syntax:
  70
  71 ``foo``
  72   Search for notes containing "foo"
  73 ``foo bar``
  74   Search for notes containing "foo" and "bar"
  75 ``"foo bar" baz``
  76   Search for notes containing "foo bar" and "baz"
  77 ``foo -bar``
  78   Search for notes containing "foo" but not "bar"
  79
  80
  81 ============
  82 Dependencies
  83 ============
  84 * PHP
  85 * PHP `oauth extension`__
  86
  87 __ http://pecl.php.net/package/oauth
  88
  89
  90 ============
  91 Installation
  92 ============
  93
  94 Manual installation
  95 ===================
  96
  97 #. SSH onto your web server
  98 #. Navigate to the owncloud ``apps`` directory, often in ``/var/www/owncloud/apps``
  99 #. Download the latest release from http://cweiske.de/grauphel.htm and extract it.
 100    For example::
 101
 102      $ wget http://cweiske.de/download/grauphel/grauphel-0.5.1.tar.bz2
 103      $ tar xjvf grauphel-0.5.1.tar.bz2
 104      $ rm grauphel-0.5.1.tar.bz2
 105
 106    You do have a directory ``/var/www/owncloud/apps/grauphel`` now.
 107 #. Using your browser, login as administrator into ownCloud and click
 108    the "Apps" icon in the main menu ("+" icon).
 109 #. Click on "Grauphel: Tomboy note server" and then on the "Enable" button.
 110 #. In the main menu, click the "Tomboy notes" icon.
 111
 112 It may be that grauphel now shows you an error message::
 113
 114   PHP extension "oauth" is required
 115
 116 You have to install the PHP PECL oauth extension now.
 117 On Debian 7, do the following::
 118
 119   $ apt-get install libpcre3-dev php-pear php5-dev
 120   $ pecl install oauth
 121   $ echo 'extension=oauth.so' > /etc/php5/conf.d/oauth.ini
 122   $ /etc/init.d/apache2 restart
 123
 124 Reload the ownCloud page in your browser now.
 125
 126
 127 ======
 128 Author
 129 ======
 130 Christian Weiske, cweiske@cweiske.de, http://cweiske.de/
 131
 132
 133 =====
 134 Links
 135 =====
 136 - `Homepage`__
 137 - `grauphel on apps.owncloud.com`__
 138 - `Source code repository`__
 139 - `Github source code mirror`__
 140
 141 __ http://cweiske.de/grauphel.htm
 142 __ http://apps.owncloud.com/content/show.php?action=content&content=166654
 143 __ http://git.cweiske.de/grauphel.git/
 144 __ https://github.com/cweiske/grauphel
 145
 146
 147 =================
 148 Development hints
 149 =================
 150 * JSON coming from Tomboy: Title is html-escaped already
 151   (e.g. ``>`` is ``&gt;``).
 152   We store it that way in the database, so there is no need to escape the
 153   output.
 154 * ``latest-sync-revision`` sent from Tomboy during PUT sync is already
 155   incremented by 1.
 156
 157
 158 Releasing grauphel
 159 ==================
 160 To release a new version, do the following:
 161
 162 #. Increase version number in ``appinfo/version`` and ``appinfo/info.xml``.
 163 #. Fill the ``ChangeLog`` file with the changes since the last release,
 164    mention the new version number.
 165 #. Update ``README.rst`` and increase the version number
 166 #. Create the grauphel release file with::
 167
 168      $ phing
 169
 170    The file will be in ``dist/``
 171 #. Test the release on a server
 172 #. Tag the release in git
 173 #. Upload the release to http://cweiske.de/grauphel.htm
 174 #. Link the new release on https://apps.owncloud.com/content/show.php?content=166654