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 and extract it.
112 $ wget http://cweiske.de/download/grauphel/grauphel-0.6.1.tar.bz2
113 $ tar xjvf grauphel-0.6.1.tar.bz2
114 $ rm grauphel-0.6.1.tar.bz2
116 You do have a directory ``/var/www/owncloud/apps/grauphel`` now.
117 #. Using your browser, login as administrator into ownCloud and click
118 the "Apps" icon in the main menu ("+" icon).
119 #. Click on "Grauphel: Tomboy note server" and then on the "Enable" button.
120 #. In the main menu, click the "Tomboy notes" icon.
122 It may be that grauphel now shows you an error message::
124 PHP extension "oauth" is required
126 You have to install the PHP PECL oauth extension now.
127 On Debian 7, do the following::
129 $ apt-get install libpcre3-dev php-pear php5-dev
130 $ pecl install oauth-1.2.3
131 $ echo 'extension=oauth.so' > /etc/php5/conf.d/oauth.ini
132 $ /etc/init.d/apache2 restart
134 Reload the ownCloud page in your browser now.
137 ``oauth-1.2.3`` is only needed on PHP 5.x
138 For PHP 7, simply use ``pecl install oauth``.
144 Christian Weiske, cweiske@cweiske.de, http://cweiske.de/
151 - `grauphel on apps.owncloud.com`__
152 - `Source code repository`__
153 - `Github source code mirror`__
155 __ http://cweiske.de/grauphel.htm
156 __ http://apps.owncloud.com/content/show.php?action=content&content=166654
157 __ http://git.cweiske.de/grauphel.git/
158 __ https://github.com/cweiske/grauphel
164 * JSON coming from Tomboy: Title is html-escaped already
165 (e.g. ``>`` is ``>``).
166 We store it that way in the database, so there is no need to escape the
168 * ``latest-sync-revision`` sent from Tomboy during PUT sync is already
174 - `ownCloud unit testing documentation`__
175 - `grauphel on Travis CI`__
177 .. image:: https://travis-ci.org/cweiske/grauphel.svg
178 :target: https://travis-ci.org/cweiske/grauphel
180 __ https://doc.owncloud.org/server/8.0/developer_manual/core/unit-testing.html
181 __ https://travis-ci.org/cweiske/grauphel
186 To release a new version, do the following:
188 #. Increase version number in ``appinfo/version`` and ``appinfo/info.xml``.
189 #. Fill the ``ChangeLog`` file with the changes since the last release,
190 mention the new version number.
191 #. Update ``README.rst`` and increase the version number
192 #. Create the grauphel release file with::
196 The file will be in ``dist/``
197 #. Test the release on a server
198 #. Tag the release in git
199 #. Upload the release to http://cweiske.de/grauphel.htm
200 #. Link the new release on https://apps.owncloud.com/content/show.php?content=166654