1 *****************************
2 grauphel - tomboy REST server
3 *****************************
4 nextCloud__ application implementing the `Tomboy`__ `REST API`__ for syncing notes.
8 __ https://nextcloud.com/
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.7.2 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 nextCloud'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
95 grauphel needs to be activated for all users.
96 It will not work with the "enable only for specific groups" setting.
98 App store installation
99 ======================
100 #. Log into nextcloud as administrator
102 #. Enable experimental apps in the settings
103 #. Click "Productivity"
104 #. Look for "grauphel - Tomboy sync server"
111 #. SSH onto your web server
112 #. Navigate to the nextcloud ``apps`` directory, often in ``/var/www/nextcloud/apps``
113 #. Download the latest release from http://cweiske.de/grauphel.htm#download
117 $ wget http://cweiske.de/download/grauphel/grauphel-0.7.2.tar.gz
118 $ tar xjvf grauphel-0.7.2.tar.gz
119 $ rm grauphel-0.7.2.tar.gz
121 You do have a directory ``/var/www/nextcloud/apps/grauphel`` now.
122 #. Using your browser, login as administrator into nextCloud and click
123 the "Apps" icon in the main menu ("+" icon).
124 #. Click on "Grauphel: Tomboy note server" and then on the "Enable" button.
125 #. In the main menu, click the "Tomboy notes" icon.
127 It may be that grauphel now shows you an error message::
129 PHP extension "oauth" is required
131 You have to install the PHP PECL oauth extension now.
132 On Debian 9 or higher, do the following::
134 $ apt install php-oauth
136 $ /etc/init.d/apache2 restart
138 Reload the nextCloud page in your browser now.
141 ``oauth-1.2.3`` is only needed on PHP 5.x
142 For PHP 7 simply use ``pecl install oauth``.
150 See `grauphel downloads page <http://cweiske.de/grauphel-download.htm>`_
151 for all released versions.
156 Christian Weiske, cweiske@cweiske.de, http://cweiske.de/
163 - `grauphel on apps.nextcloud.com`__
164 - `Source code repository`__
165 - `Github source code mirror`__
167 __ http://cweiske.de/grauphel.htm
168 __ http://apps.nextcloud.com/apps/grauphel
169 __ http://git.cweiske.de/grauphel.git/
170 __ https://github.com/cweiske/grauphel
176 * JSON coming from Tomboy: Title is html-escaped already
177 (e.g. ``>`` is ``>``).
178 We store it that way in the database, so there is no need to escape the
180 * ``latest-sync-revision`` sent from Tomboy during PUT sync is already
186 - `ownCloud unit testing documentation`__
187 - `grauphel on Travis CI`__
189 .. image:: https://travis-ci.org/cweiske/grauphel.svg
190 :target: https://travis-ci.org/cweiske/grauphel
192 __ https://doc.owncloud.org/server/8.0/developer_manual/core/unit-testing.html
193 __ https://travis-ci.org/cweiske/grauphel
198 To release a new version, do the following:
200 #. Increase version number in ``appinfo/version`` and ``appinfo/info.xml``.
201 #. Validate ``appinfo/info.xml``::
203 $ xmllint --noout --schema tools/info.xsd appinfo/info.xml
205 #. Validate ``appinfo/database.xml``::
207 $ xmllint --noout --schema tools/database.xsd appinfo/database.xml
209 #. Fill the ``ChangeLog`` file with the changes since the last release,
210 mention the new version number.
211 #. Update ``README.rst`` and increase the version number
212 #. Create the grauphel release file with::
216 The file will be in ``dist/``
217 #. Test the release on a server
218 #. Tag the release in git
219 #. Upload the release to http://cweiske.de/grauphel.htm with::
221 $ cd ~/Dev/html/cweiske.de
222 $ ./scripts/update-grauphel.sh
224 #. Upload the new release on
225 https://apps.nextcloud.com/developer/apps/releases/new
229 $ openssl dgst -sha512 -sign ~/.nextcloud/certificates/grauphel.key dist/grauphel-0.7.2.tar.gz | openssl base64