X-Git-Url: https://git.cweiske.de/grauphel.git/blobdiff_plain/3401f499d7f806a4402e897e63a0008602f414bb..0cff53bab0eaf5152e91bebd5070d817d301f0e7:/README.rst diff --git a/README.rst b/README.rst index 5b5d65a..b8c3f2b 100644 --- a/README.rst +++ b/README.rst @@ -1,11 +1,11 @@ ***************************** grauphel - tomboy REST server ***************************** -ownCloud__ application implementing the `Tomboy`__ `REST API`__ for syncing notes. +nextCloud__ application implementing the `Tomboy`__ `REST API`__ for syncing notes. Pretty stable. -__ http://owncloud.org/ +__ https://nextcloud.com/ __ https://wiki.gnome.org/Apps/Tomboy __ https://wiki.gnome.org/Apps/Tomboy/Synchronization/REST/1.0 @@ -40,12 +40,12 @@ Supported clients __ http://conboy.garage.maemo.org/ __ https://wiki.gnome.org/Apps/Tomboy -__ https://launchpad.net/tomdroid +__ https://github.com/tomboy-notes/tomdroid Known working versions ====================== -grauphel 0.2.1 is known to work with: +grauphel 0.7.3 is known to work with: * Tomboy 1.15.2, Linux * Tomboy 1.15.1, Windows @@ -62,7 +62,7 @@ Functionality Search ====== -You can use ownCloud's global search on the top right. +You can use nextCloud's global search on the top right. During search, the note's titles, tags and content are searched. @@ -91,29 +91,35 @@ __ http://pecl.php.net/package/oauth Installation ============ +.. note:: + grauphel needs to be activated for all users. + It will not work with the "enable only for specific groups" setting. + App store installation ====================== -Installation via the app store does not work currently, see -https://github.com/cweiske/grauphel/issues/26 - -If one day it works, you can use the ownCloud "Apps" app, select -"Productivity" and install grauphel with a single click. +#. Log into nextcloud as administrator +#. Goto "Apps" +#. Enable experimental apps in the settings +#. Click "Productivity" +#. Look for "grauphel - Tomboy sync server" +#. Click "Activate" Manual installation =================== #. SSH onto your web server -#. Navigate to the owncloud ``apps`` directory, often in ``/var/www/owncloud/apps`` -#. Download the latest release from http://cweiske.de/grauphel.htm and extract it. +#. Navigate to the nextcloud ``apps`` directory, often in ``/var/www/nextcloud/apps`` +#. Download the latest release from http://cweiske.de/grauphel.htm#download + and extract it. For example:: - $ wget http://cweiske.de/download/grauphel/grauphel-0.6.0.tar.bz2 - $ tar xjvf grauphel-0.6.0.tar.bz2 - $ rm grauphel-0.6.0.tar.bz2 + $ wget http://cweiske.de/download/grauphel/grauphel-0.7.3.tar.gz + $ tar xjvf grauphel-0.7.3.tar.gz + $ rm grauphel-0.7.3.tar.gz - You do have a directory ``/var/www/owncloud/apps/grauphel`` now. -#. Using your browser, login as administrator into ownCloud and click + You do have a directory ``/var/www/nextcloud/apps/grauphel`` now. +#. Using your browser, login as administrator into nextCloud and click the "Apps" icon in the main menu ("+" icon). #. Click on "Grauphel: Tomboy note server" and then on the "Enable" button. #. In the main menu, click the "Tomboy notes" icon. @@ -123,15 +129,26 @@ It may be that grauphel now shows you an error message:: PHP extension "oauth" is required You have to install the PHP PECL oauth extension now. -On Debian 7, do the following:: +On Debian 9 or higher, do the following:: - $ apt-get install libpcre3-dev php-pear php5-dev - $ pecl install oauth - $ echo 'extension=oauth.so' > /etc/php5/conf.d/oauth.ini + $ apt install php-oauth + $ phpenmod oauth $ /etc/init.d/apache2 restart -Reload the ownCloud page in your browser now. +Reload the nextCloud page in your browser now. + +.. note:: + ``oauth-1.2.3`` is only needed on PHP 5.x + For PHP 7 simply use ``pecl install oauth``. + +======== +Download +======== +.. LATESTRELEASE + +See `grauphel downloads page `_ +for all released versions. ====== Author @@ -143,12 +160,12 @@ Christian Weiske, cweiske@cweiske.de, http://cweiske.de/ Links ===== - `Homepage`__ -- `grauphel on apps.owncloud.com`__ +- `grauphel on apps.nextcloud.com`__ - `Source code repository`__ - `Github source code mirror`__ __ http://cweiske.de/grauphel.htm -__ http://apps.owncloud.com/content/show.php?action=content&content=166654 +__ http://apps.nextcloud.com/apps/grauphel __ http://git.cweiske.de/grauphel.git/ __ https://github.com/cweiske/grauphel @@ -181,6 +198,14 @@ Releasing grauphel To release a new version, do the following: #. Increase version number in ``appinfo/version`` and ``appinfo/info.xml``. +#. Validate ``appinfo/info.xml``:: + + $ xmllint --noout --schema tools/info.xsd appinfo/info.xml + +#. Validate ``appinfo/database.xml``:: + + $ xmllint --noout --schema tools/database.xsd appinfo/database.xml + #. Fill the ``ChangeLog`` file with the changes since the last release, mention the new version number. #. Update ``README.rst`` and increase the version number @@ -191,5 +216,14 @@ To release a new version, do the following: The file will be in ``dist/`` #. Test the release on a server #. Tag the release in git -#. Upload the release to http://cweiske.de/grauphel.htm -#. Link the new release on https://apps.owncloud.com/content/show.php?content=166654 +#. Upload the release to http://cweiske.de/grauphel.htm with:: + + $ cd ~/Dev/html/cweiske.de + $ ./scripts/update-grauphel.sh + +#. Upload the new release on + https://apps.nextcloud.com/developer/apps/releases/new + + Signature:: + + $ openssl dgst -sha512 -sign ~/.nextcloud/certificates/grauphel.key dist/grauphel-0.7.3.tar.gz | openssl base64