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
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.
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
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.
112 It may be that grauphel now shows you an error message::
114 PHP extension "oauth" is required
116 You have to install the PHP PECL oauth extension now.
117 On Debian 7, do the following::
119 $ apt-get install libpcre3-dev php-pear php5-dev
121 $ echo 'extension=oauth.so' > /etc/php5/conf.d/oauth.ini
122 $ /etc/init.d/apache2 restart
124 Reload the ownCloud page in your browser now.
130 Christian Weiske, cweiske@cweiske.de, http://cweiske.de/
137 - `grauphel on apps.owncloud.com`__
138 - `Source code repository`__
139 - `Github source code mirror`__
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
150 * JSON coming from Tomboy: Title is html-escaped already
151 (e.g. ``>`` is ``>``).
152 We store it that way in the database, so there is no need to escape the
154 * ``latest-sync-revision`` sent from Tomboy during PUT sync is already
160 - `ownCloud unit testing documentation`__
161 - `grauphel on Travis CI`__
163 .. image:: https://travis-ci.org/cweiske/grauphel.svg
164 :target: https://travis-ci.org/cweiske/grauphel
166 __ https://doc.owncloud.org/server/8.0/developer_manual/core/unit-testing.html
167 __ https://travis-ci.org/cweiske/grauphel
172 To release a new version, do the following:
174 #. Increase version number in ``appinfo/version`` and ``appinfo/info.xml``.
175 #. Fill the ``ChangeLog`` file with the changes since the last release,
176 mention the new version number.
177 #. Update ``README.rst`` and increase the version number
178 #. Create the grauphel release file with::
182 The file will be in ``dist/``
183 #. Test the release on a server
184 #. Tag the release in git
185 #. Upload the release to http://cweiske.de/grauphel.htm
186 #. Link the new release on https://apps.owncloud.com/content/show.php?content=166654