1 *****************************
2 grauphel - tomboy REST server
3 *****************************
4 ownCloud__ application implementing the `Tomboy`__ `REST API`__ for syncing notes.
8 __ http://owncloud.org/
9 __ https://wiki.gnome.org/Apps/Tomboy
10 __ https://wiki.gnome.org/Apps/Tomboy/Synchronization/REST/1.0
21 - Note synchronization
22 - OAuth token management interface
23 - Database management interface (reset)
26 - Downloading notes as HTML and reStructuredText
30 - Web interface to edit notes. I will probably not implement this.
37 * Conboy__ (Nokia N900 Maemo)
38 * Tomboy__ (Linux, Windows)
39 * Tomdroid__ (Android)
41 __ http://conboy.garage.maemo.org/
42 __ https://wiki.gnome.org/Apps/Tomboy
43 __ https://launchpad.net/tomdroid
46 Known working versions
47 ======================
48 grauphel 0.2.1 is known to work with:
50 * Tomboy 1.15.2, Linux
51 * Tomboy 1.15.1, Windows
52 * Tomdroid 0.7.5, Android 4.4.1
54 See the HowTo__ document for client-specific configuration instructions.
65 You can use ownCloud's global search on the top right.
67 During search, the note's titles, tags and content are searched.
72 Search for notes containing "foo"
74 Search for notes containing "foo" and "bar"
76 Search for notes containing "foo bar" and "baz"
78 Search for notes containing "foo" but not "bar"
85 * PHP `oauth extension`__
87 __ http://pecl.php.net/package/oauth
94 App store installation
95 ======================
96 #. Log into owncloud as administrator
98 #. Enable experimental apps in the settings
99 #. Click "Productivity"
100 #. Look for "grauphel - Tomboy sync server"
107 #. SSH onto your web server
108 #. Navigate to the owncloud ``apps`` directory, often in ``/var/www/owncloud/apps``
109 #. Download the latest release from http://cweiske.de/grauphel.htm#download
113 $ wget http://cweiske.de/download/grauphel/grauphel-0.6.1.tar.bz2
114 $ tar xjvf grauphel-0.6.1.tar.bz2
115 $ rm grauphel-0.6.1.tar.bz2
117 You do have a directory ``/var/www/owncloud/apps/grauphel`` now.
118 #. Using your browser, login as administrator into ownCloud and click
119 the "Apps" icon in the main menu ("+" icon).
120 #. Click on "Grauphel: Tomboy note server" and then on the "Enable" button.
121 #. In the main menu, click the "Tomboy notes" icon.
123 It may be that grauphel now shows you an error message::
125 PHP extension "oauth" is required
127 You have to install the PHP PECL oauth extension now.
128 On Debian 7, do the following::
130 $ apt-get install libpcre3-dev php-pear php5-dev
131 $ pecl install oauth-1.2.3
132 $ echo 'extension=oauth.so' > /etc/php5/conf.d/oauth.ini
133 $ /etc/init.d/apache2 restart
135 Reload the ownCloud page in your browser now.
138 ``oauth-1.2.3`` is only needed on PHP 5.x
139 For PHP 7 simply use ``pecl install oauth``.
146 * `grauphel-0.6.1.tar.gz <http://cweiske.de/download/grauphel/grauphel-0.6.1.tar.gz>`__,
148 SHA256: ``f86cf7b47be857d8a87d413b6315c336e83e9c4beba2cb6ed0eaea8d2b3ea1c3``
150 * `grauphel-0.6.1.tar.bz2 <http://cweiske.de/download/grauphel/grauphel-0.6.1.tar.bz2>`__,
152 SHA256: ``b755b32a453617536eb202cd9d29129df1b04311b633d971108c310a4b9b2e4b``
153 * `grauphel-0.6.0.tar.bz2 <http://cweiske.de/download/grauphel/grauphel-0.6.0.tar.bz2>`__,
155 SHA256: ``42e66ed4db1f0c24ca25e46ac4be6e523352f431daaefb22140a2a2e621049b8``
156 * `grauphel-0.5.1.tar.bz2 <http://cweiske.de/download/grauphel/grauphel-0.5.1.tar.bz2>`__,
158 SHA256: ``fdb6232fa0d09a72e8355e5e4610403717ffe5c7f7193af2b36d991f1eb76127``
159 * `grauphel-0.5.0.tar.bz2 <http://cweiske.de/download/grauphel/grauphel-0.5.0.tar.bz2>`__,
161 SHA256: ``9bbd5426cd7cd36f603c49b0635f24cb9507cf857480edc1f72df0ea0107f7de``
162 * `grauphel-0.4.0.tar.bz2 <http://cweiske.de/download/grauphel/grauphel-0.4.0.tar.bz2>`__,
164 SHA256: ``a625ed127af04af4c0a658fcac8156557ef8098eaeddb72281842ad0c0c00b71``
165 * `grauphel-0.3.0.tar.bz2 <http://cweiske.de/download/grauphel/grauphel-0.3.0.tar.bz2">`__,
167 SHA256: ``c59ac4cab6d747a4fe89ebd59c92e7ec80f9e2fb3b1edf8904357bc161897ae8``
168 * `grauphel-0.2.1.tar.bz2 <http://cweiske.de/download/grauphel/grauphel-0.2.1.tar.bz2>`__,
170 SHA256: ``b66db077fc3e117b2e143b5b177c1d9a8a86c43029936ea65300a4d822e9fdda``
171 * `grauphel-0.2.0.tar.bz2 <http://cweiske.de/download/grauphel/grauphel-0.2.0.tar.bz2>`__,
173 SHA256: ``abb1372e8b8525237bea1b686aa6ee2d390974f84bf2206d3aacc2c191978162``
179 Christian Weiske, cweiske@cweiske.de, http://cweiske.de/
186 - `grauphel on apps.owncloud.com`__
187 - `Source code repository`__
188 - `Github source code mirror`__
190 __ http://cweiske.de/grauphel.htm
191 __ http://apps.owncloud.com/content/show.php?action=content&content=166654
192 __ http://git.cweiske.de/grauphel.git/
193 __ https://github.com/cweiske/grauphel
199 * JSON coming from Tomboy: Title is html-escaped already
200 (e.g. ``>`` is ``>``).
201 We store it that way in the database, so there is no need to escape the
203 * ``latest-sync-revision`` sent from Tomboy during PUT sync is already
209 - `ownCloud unit testing documentation`__
210 - `grauphel on Travis CI`__
212 .. image:: https://travis-ci.org/cweiske/grauphel.svg
213 :target: https://travis-ci.org/cweiske/grauphel
215 __ https://doc.owncloud.org/server/8.0/developer_manual/core/unit-testing.html
216 __ https://travis-ci.org/cweiske/grauphel
221 To release a new version, do the following:
223 #. Increase version number in ``appinfo/version`` and ``appinfo/info.xml``.
224 #. Fill the ``ChangeLog`` file with the changes since the last release,
225 mention the new version number.
226 #. Update ``README.rst`` and increase the version number
227 #. Create the grauphel release file with::
231 The file will be in ``dist/``
232 #. Test the release on a server
233 #. Tag the release in git
234 #. Upload the release to http://cweiske.de/grauphel.htm
235 #. Link the new release on https://apps.owncloud.com/content/show.php?content=166654