From bba9907d1ffe993da3bc9b7e6c87169953a11160 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Tue, 3 May 2016 15:50:13 +0200 Subject: Update documentation --- docs/README.rst | 0 docs/en/index.rst | 4 +-- docs/en/user/installation.rst | 63 ++++++++++++++++++++++++++++++++----------- docs/en/user/upgrade.rst | 12 +++++++-- docs/fr/index.rst | 3 ++- docs/fr/user/installation.rst | 56 +++++++++++++++++++++++++++++--------- docs/fr/user/upgrade.rst | 32 ++++++++++++++++++++++ 7 files changed, 138 insertions(+), 32 deletions(-) delete mode 100644 docs/README.rst create mode 100644 docs/fr/user/upgrade.rst diff --git a/docs/README.rst b/docs/README.rst deleted file mode 100644 index e69de29b..00000000 diff --git a/docs/en/index.rst b/docs/en/index.rst index 590c234a..cd0948c2 100644 --- a/docs/en/index.rst +++ b/docs/en/index.rst @@ -8,7 +8,7 @@ wallabag documentation **wallabag** is a read-it-later application: it saves a web page by keeping content only. Elements like navigation or ads are deleted. -.. note:: +.. tip:: This documentation is about wallabag v2. If you want to read documentation for wallabag v1, `please have a look here `__. @@ -25,8 +25,8 @@ The main documentation for this application is organized into a couple sections: user/faq user/installation - user/migration user/upgrade + user/migration user/create_account user/login user/configuration diff --git a/docs/en/user/installation.rst b/docs/en/user/installation.rst index c2174a53..3057373c 100644 --- a/docs/en/user/installation.rst +++ b/docs/en/user/installation.rst @@ -34,6 +34,9 @@ and it's corresponding database server. Installation ------------ +On a dedicated web server (recommended way) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + wallabag uses a big number of libraries in order to function. These libraries must be installed with a tool called Composer. You need to install it if you don't already have. Install Composer: @@ -54,7 +57,7 @@ To install wallabag itself, you must run these two commands: SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist php bin/console wallabag:install --env=prod -To start php's build-in server and test if everything did install correctly, you can do: +To start PHP's build-in server and test if everything did install correctly, you can do: :: @@ -62,14 +65,48 @@ To start php's build-in server and test if everything did install correctly, you And access wallabag at http://yourserverip:8000 -.. note:: +.. tip:: To define parameters with environment variables, you have to set these variables with ``SYMFONY__`` prefix. For example, ``SYMFONY__DATABASE_DRIVER``. You can have a look to the `Symfony documentation `__. -Installing on Apache --------------------- +On a shared hosting +~~~~~~~~~~~~~~~~~~~ + +We provide you a package with all dependancies inside. +The default configuration uses SQLite for the database. If you want to change these settings, please edit ``app/config/parameters.yml``. + +We already created a user: login and password are ``wallabag``. + +.. caution:: With this package, wallabag don't check mandatory extensions used in the application (theses checks are made during ``composer install`` when you have a dedicated web server, see above). + +Execute this command to download and extract the latest package: + +.. code-block:: bash + + wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package + +Now, read the following documentation to create your virtual host, then access to your wallabag. +If you changed the database configuration to use MySQL or PostgreSQL, you need to create a user via this command ``php bin/console wallabag:install --env=prod``. + +Installation with Docker +------------------------ + +We provide you a Docker image to install wallabag easily. Have a look to our repository on `Docker Hub `__ to have more information. -Assuming you install wallabag in the /var/www/wallabag folder and that you want to use php as an Apache module, here's a vhost for wallabag: +Command to launch container +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: bash + + docker pull wallabag/wallabag + +Virtual hosts +------------- + +Configuration on Apache +~~~~~~~~~~~~~~~~~~~~~~~ + +Assuming you install wallabag in the ``/var/www/wallabag`` folder and that you want to use PHP as an Apache module, here's a vhost for wallabag: :: @@ -111,10 +148,10 @@ Assuming you install wallabag in the /var/www/wallabag folder and that you want After reloading or restarting Apache, you should now be able to access wallabag at http://domain.tld. -Installing on Nginx -------------------- +Configuration on Nginx +~~~~~~~~~~~~~~~~~~~~~~ -Assuming you install wallabag in the /var/www/wallabag folder, here's the recipe for wallabag : +Assuming you install wallabag in the ``/var/www/wallabag`` folder, here's the recipe for wallabag : :: @@ -151,22 +188,19 @@ Assuming you install wallabag in the /var/www/wallabag folder, here's the recipe After reloading or restarting nginx, you should now be able to access wallabag at http://domain.tld. -.. note:: +.. tip:: When you want to import large file into wallabag, you need to add this line in your nginx configuration ``client_max_body_size XM; # allows file uploads up to X megabytes``. - Rights access to the folders of the project ------------------------------------------- - -Test Environment +Test environment ~~~~~~~~~~~~~~~~ When we just want to test wallabag, we just run the command ``php bin/console server:run --env=prod`` to start our wallabag instance and everything will go smoothly because the user who started the project can access to the current folder naturally, without any problem. - -Production Environment +Production environment ~~~~~~~~~~~~~~~~~~~~~~ As soon as we use Apache or Nginx to access to our wallabag instance, and not from the command ``php bin/console server:run --env=prod`` to start it, we should take care to grant the good rights on the good folders to keep safe all the folders of the project. @@ -180,4 +214,3 @@ This is due to the fact that we will need to grant the same rights access on the .. code-block:: bash chown -R www-data:www-data /var/www/wallabag/var - diff --git a/docs/en/user/upgrade.rst b/docs/en/user/upgrade.rst index e4735631..7782dc8a 100644 --- a/docs/en/user/upgrade.rst +++ b/docs/en/user/upgrade.rst @@ -5,6 +5,7 @@ Upgrade on a dedicated web server --------------------------------- The last release is published on https://www.wallabag.org/pages/download-wallabag.html. In order to upgrade your wallabag installation and get the last version, run the following commands in you wallabag folder (replace ``2.0.3`` by the last release number): + :: git fetch origin @@ -12,12 +13,19 @@ The last release is published on https://www.wallabag.org/pages/download-wallaba git checkout 2.0.3 SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist php bin/console cache:clear --env=prod - Upgrade on a shared hosting --------------------------- -Backup your ``app/config/parameters.yml`` file. Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours. +Backup your ``app/config/parameters.yml`` file. + +Download the last release of wallabag: + +.. code-block:: bash + + wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package + +Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours. If you use SQLite, you must also copy your ``data/`` folder inside the new installation. diff --git a/docs/fr/index.rst b/docs/fr/index.rst index 29237721..b4275a43 100644 --- a/docs/fr/index.rst +++ b/docs/fr/index.rst @@ -9,7 +9,7 @@ Documentation de wallabag simplement d’archiver une page web en ne conservant que le contenu. Les éléments superflus (menu, publicité, etc.) sont supprimés. -.. note:: +.. tip:: Vous vous trouvez sur la documentation de wallabag v2. Si vous voulez lire la documentation de wallabag v1, `vous pouvez jeter un œil ici `__. @@ -26,6 +26,7 @@ La documentation principale de cette application est découpée en plusieurs sec user/faq user/installation + user/upgrade user/migration user/create_account user/login diff --git a/docs/fr/user/installation.rst b/docs/fr/user/installation.rst index 33a2cf5c..4645ef74 100644 --- a/docs/fr/user/installation.rst +++ b/docs/fr/user/installation.rst @@ -32,6 +32,9 @@ wallabag utilise PDO afin de se connecter à une base de données, donc vous aur Installation ------------ +Sur un serveur dédié (méthode conseillée) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + wallabag utilise un grand nombre de bibliothèques pour fonctionner. Ces bibliothèques doivent être installées à l'aide d'un outil nommé Composer. Vous devez l'installer si ce n'est déjà fait. Installation de Composer : @@ -60,13 +63,47 @@ Pour démarrer le serveur interne à php et vérifier que tout s'est installé c Et accéder wallabag à l'adresse http://lipdevotreserveur:8000 -.. note:: +.. tip:: Pour définir des paramètres via des variables d'environnement, vous pouvez les spécifier avec le préfixe ``SYMFONY__``. Par exemple, ``SYMFONY__DATABASE_DRIVER``. Vous pouvez lire `documentation Symfony `__ pour en savoir plus. -Installation avec Apache +Sur un serveur mutualisé +~~~~~~~~~~~~~~~~~~~~~~~~ + +Nous mettons à votre disposition une archive avec toutes les dépendances à l'intérieur. +La configuration par défaut utilise SQLite pour la base de données. Si vous souhaitez changer ces paramètres, vous devez modifier le fichier ``app/config/parameters.yml``. + +Nous avons déjà créé un utilisateur : le login et le mot de passe sont ``wallabag``. + +.. caution:: Avec cette archive, wallabag ne vérifie pas si les extensions obligatoires sont présentes sur votre serveur pour bien fonctionner (ces vérifications sont faites durant le ``composer install`` quand vous avez un serveur dédié, voir ci-dessus). + +Exécutez cette commande pour télécharger et décompresser l'archive : + +.. code-block:: bash + + wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package + +Maintenant, lisez la documentation ci-dessous pour crééer un virtual host. Accédez ensuite à votre installation de wallabag. +Si vous avez changé la configuration pour modifier le type de stockage (MySQL ou PostgreSQL), vous devrez vous créer un utilisateur via la commande ``php bin/console wallabag:install --env=prod``. + +Installation avec Docker ------------------------ -En imaginant que vous vouliez installer wallabag dans le dossier /var/www/wallabag et que vous utilisiez php comme un module Apache, voici un vhost pour wallabag : +Nous vous proposons une image Docker pour installer wallabag facilement. Allez voir du côté de `Docker Hub `__ pour plus d'informations. + +Commande pour démarrer le containeur +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. code-block:: bash + + docker pull wallabag/wallabag + +Virtual hosts +------------- + +Configuration avec Apache +~~~~~~~~~~~~~~~~~~~~~~~~~ + +En imaginant que vous vouliez installer wallabag dans le dossier ``/var/www/wallabag`` et que vous utilisiez PHP comme un module Apache, voici un vhost pour wallabag : :: @@ -108,10 +145,10 @@ En imaginant que vous vouliez installer wallabag dans le dossier /var/www/wallab Après que vous ayez rechargé/redémarré Apache, vous devriez pouvoir avoir accès à wallabag à l'adresse http://domain.tld. -Installation avec Nginx ------------------------ +Configuration avec Nginx +~~~~~~~~~~~~~~~~~~~~~~~~ -En imaginant que vous vouliez installer wallabag dans le dossier /var/www/wallabag, voici un fichier de configuration Nginx pour wallabag : +En imaginant que vous vouliez installer wallabag dans le dossier ``/var/www/wallabag``, voici un fichier de configuration Nginx pour wallabag : :: @@ -148,22 +185,18 @@ En imaginant que vous vouliez installer wallabag dans le dossier /var/www/wallab Après que vous ayez rechargé/redémarré Nginx, vous devriez pouvoir avoir accès à wallabag à l'adresse http://domain.tld. - -.. note:: +.. tip:: Si vous voulez importer un fichier important dans wallabag, vous devez ajouter cette ligne dans votre configuration nginx ``client_max_body_size XM; # allows file uploads up to X megabytes``. - Droits d'accès aux dossiers du projet ------------------------------------- - Environnement de test ~~~~~~~~~~~~~~~~~~~~~ Quand nous souhaitons juste tester wallabag, nous lançons simplement la commande ``php bin/console server:run --env=prod`` pour démarrer l'instance wallabag et tout se passe correctement car l'utilisateur qui a démarré le projet a accès naturellement au repertoire courant, tout va bien. - Environnement de production ~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -178,4 +211,3 @@ Cela est dû au fait qu'il faut aussi octroyer les mêmes droits d'accès au dos .. code-block:: bash chown -R www-data:www-data /var/www/wallabag/var - diff --git a/docs/fr/user/upgrade.rst b/docs/fr/user/upgrade.rst new file mode 100644 index 00000000..84a1692d --- /dev/null +++ b/docs/fr/user/upgrade.rst @@ -0,0 +1,32 @@ +Mettre à jour wallabag +====================== + +Mise à jour sur un serveur dédié +-------------------------------- + +La dernière version de wallabag est publiée à cette adresse : https://www.wallabag.org/pages/download-wallabag.html. Pour mettre à jour votre installation de wallabag, exécutez les commandes suivantes dans votre répertoire d'installation (remplacez ``2.0.3`` par le numéro de la dernière version) : + +:: + + git fetch origin + git fetch --tags + git checkout 2.0.3 + SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist + php bin/console cache:clear --env=prod + +Mise à jour sur un hébergement mutualisé +---------------------------------------- + +Effectuez une sauvegarde du fichier ``app/config/parameters.yml``. + +Téléchargez la dernière version de wallabag : + +.. code-block:: bash + + wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package + +Décompressez l'archive dans votre répertoire d'installation et remplacez le fichier ``app/config/parameters.yml`` avec le votre. + +Si vous utilisez SQLite, vous devez également conserver le contenu du répertoire ``data/``. + +Videz le répertoire ``var/cache``. -- cgit v1.2.3 From e546a2d6eb3075b4c13f22cc0957bfc96b8e14d9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Tue, 3 May 2016 20:39:49 +0200 Subject: Add LigHTTPd documentation Fix #1931 --- docs/en/user/installation.rst | 41 ++++++++++++++++++++++++++++++++++++++- docs/fr/user/installation.rst | 45 ++++++++++++++++++++++++++++++++++++++++--- 2 files changed, 82 insertions(+), 4 deletions(-) diff --git a/docs/en/user/installation.rst b/docs/en/user/installation.rst index 3057373c..3872ad3a 100644 --- a/docs/en/user/installation.rst +++ b/docs/en/user/installation.rst @@ -91,7 +91,7 @@ If you changed the database configuration to use MySQL or PostgreSQL, you need t Installation with Docker ------------------------ -We provide you a Docker image to install wallabag easily. Have a look to our repository on `Docker Hub `__ to have more information. +We provide you a Docker image to install wallabag easily. Have a look to our repository on `Docker Hub `__ to have more information. Command to launch container ~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -192,6 +192,45 @@ After reloading or restarting nginx, you should now be able to access wallabag a When you want to import large file into wallabag, you need to add this line in your nginx configuration ``client_max_body_size XM; # allows file uploads up to X megabytes``. +Configuration on LigHTTPd +~~~~~~~~~~~~~~~~~~~~~~~~~ + +Edit your ``lighttpd.conf`` file and paste this configuration into it: + +:: + + server.modules = ( + "mod_fastcgi", + "mod_access", + "mod_alias", + "mod_compress", + "mod_redirect", + "mod_rewrite", + ) + server.document-root = "/var/www/wallabag/web" + server.upload-dirs = ( "/var/cache/lighttpd/uploads" ) + server.errorlog = "/var/log/lighttpd/error.log" + server.pid-file = "/var/run/lighttpd.pid" + server.username = "www-data" + server.groupname = "www-data" + server.port = 80 + server.follow-symlink = "enable" + index-file.names = ( "index.php", "index.html", "index.lighttpd.html") + url.access-deny = ( "~", ".inc" ) + static-file.exclude-extensions = ( ".php", ".pl", ".fcgi" ) + compress.cache-dir = "/var/cache/lighttpd/compress/" + compress.filetype = ( "application/javascript", "text/css", "text/html", "text/plain" ) + include_shell "/usr/share/lighttpd/use-ipv6.pl " + server.port + include_shell "/usr/share/lighttpd/create-mime.assign.pl" + include_shell "/usr/share/lighttpd/include-conf-enabled.pl" + dir-listing.activate = "disable" + + url.rewrite-if-not-file = ( + "^/([^?])(?:\?(.))?" => "/app.php?$1&$2", + "^/([^?]*)" => "/app.php?=$1", + "^/wiki$" => "/app.php", + ) + Rights access to the folders of the project ------------------------------------------- diff --git a/docs/fr/user/installation.rst b/docs/fr/user/installation.rst index 4645ef74..9039d608 100644 --- a/docs/fr/user/installation.rst +++ b/docs/fr/user/installation.rst @@ -74,7 +74,7 @@ La configuration par défaut utilise SQLite pour la base de données. Si vous so Nous avons déjà créé un utilisateur : le login et le mot de passe sont ``wallabag``. -.. caution:: Avec cette archive, wallabag ne vérifie pas si les extensions obligatoires sont présentes sur votre serveur pour bien fonctionner (ces vérifications sont faites durant le ``composer install`` quand vous avez un serveur dédié, voir ci-dessus). +.. caution:: Avec cette archive, wallabag ne vérifie pas si les extensions obligatoires sont présentes sur votre serveur pour bien fonctionner (ces vérifications sont faites durant le ``composer install`` quand vous avez un serveur dédié, voir ci-dessus). Exécutez cette commande pour télécharger et décompresser l'archive : @@ -82,7 +82,7 @@ Exécutez cette commande pour télécharger et décompresser l'archive : wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package -Maintenant, lisez la documentation ci-dessous pour crééer un virtual host. Accédez ensuite à votre installation de wallabag. +Maintenant, lisez la documentation ci-dessous pour crééer un virtual host. Accédez ensuite à votre installation de wallabag. Si vous avez changé la configuration pour modifier le type de stockage (MySQL ou PostgreSQL), vous devrez vous créer un utilisateur via la commande ``php bin/console wallabag:install --env=prod``. Installation avec Docker @@ -189,6 +189,45 @@ Après que vous ayez rechargé/redémarré Nginx, vous devriez pouvoir avoir acc Si vous voulez importer un fichier important dans wallabag, vous devez ajouter cette ligne dans votre configuration nginx ``client_max_body_size XM; # allows file uploads up to X megabytes``. +Configuration avec LigHTTPd +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Éditez votre fichier ``lighttpd.conf`` collez-y cette configuration : + +:: + + server.modules = ( + "mod_fastcgi", + "mod_access", + "mod_alias", + "mod_compress", + "mod_redirect", + "mod_rewrite", + ) + server.document-root = "/var/www/wallabag/web" + server.upload-dirs = ( "/var/cache/lighttpd/uploads" ) + server.errorlog = "/var/log/lighttpd/error.log" + server.pid-file = "/var/run/lighttpd.pid" + server.username = "www-data" + server.groupname = "www-data" + server.port = 80 + server.follow-symlink = "enable" + index-file.names = ( "index.php", "index.html", "index.lighttpd.html") + url.access-deny = ( "~", ".inc" ) + static-file.exclude-extensions = ( ".php", ".pl", ".fcgi" ) + compress.cache-dir = "/var/cache/lighttpd/compress/" + compress.filetype = ( "application/javascript", "text/css", "text/html", "text/plain" ) + include_shell "/usr/share/lighttpd/use-ipv6.pl " + server.port + include_shell "/usr/share/lighttpd/create-mime.assign.pl" + include_shell "/usr/share/lighttpd/include-conf-enabled.pl" + dir-listing.activate = "disable" + + url.rewrite-if-not-file = ( + "^/([^?])(?:\?(.))?" => "/app.php?$1&$2", + "^/([^?]*)" => "/app.php?=$1", + "^/wiki$" => "/app.php", + ) + Droits d'accès aux dossiers du projet ------------------------------------- @@ -197,7 +236,7 @@ Environnement de test Quand nous souhaitons juste tester wallabag, nous lançons simplement la commande ``php bin/console server:run --env=prod`` pour démarrer l'instance wallabag et tout se passe correctement car l'utilisateur qui a démarré le projet a accès naturellement au repertoire courant, tout va bien. -Environnement de production +Environnement de production ~~~~~~~~~~~~~~~~~~~~~~~~~~~ Dès lors que nous utilisons Apache ou Nginx pour accéder à notre instance wallabag, et non plus la commande ``php bin/console server:run --env=prod`` pour la démarrer, il faut prendre garde à octroyer les bons droits aux bons dossiers afin de préserver la sécurité de l'ensemble des fichiers fournis par le projet. -- cgit v1.2.3 From fa04bddd01f164f8423de2bffa76dc72d78b09c9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Tue, 3 May 2016 20:51:23 +0200 Subject: Move some parts in FAQ --- docs/en/index.rst | 2 +- docs/en/user/create_account.rst | 21 --------------------- docs/en/user/faq.rst | 25 +++++++++++++++++++++++++ docs/en/user/import.rst | 41 ++--------------------------------------- docs/en/user/login.rst | 10 ---------- docs/en/user/migration.rst | 4 ++-- docs/fr/index.rst | 2 +- docs/fr/user/create_account.rst | 21 --------------------- docs/fr/user/faq.rst | 25 +++++++++++++++++++++++++ docs/fr/user/import.rst | 41 ++--------------------------------------- docs/fr/user/login.rst | 10 ---------- docs/fr/user/migration.rst | 4 ++-- 12 files changed, 60 insertions(+), 146 deletions(-) diff --git a/docs/en/index.rst b/docs/en/index.rst index cd0948c2..6d2ce8f3 100644 --- a/docs/en/index.rst +++ b/docs/en/index.rst @@ -27,13 +27,13 @@ The main documentation for this application is organized into a couple sections: user/installation user/upgrade user/migration + user/import user/create_account user/login user/configuration user/first_article user/errors_during_fetching user/annotations - user/import user/download_articles user/filters user/tags diff --git a/docs/en/user/create_account.rst b/docs/en/user/create_account.rst index f0110e55..2e883c88 100644 --- a/docs/en/user/create_account.rst +++ b/docs/en/user/create_account.rst @@ -23,24 +23,3 @@ Your account is now activated. .. image:: ../../img/user/activated_account.png :alt: Welcome on board! :align: center - -Frequently asked questions --------------------------- - -I can't valid the registration form -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Make sure that all fields are well filled: - -* valid email address -* same passwords in two fields - -I don't receive my activation email -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Are you sure your email address was correct? Did you check your spams folder? - -When I click on the activation link, I've got this message: ``The user with confirmation token "DtrOPfbQeVkWf6N" does not exist``. -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -You already enabled your account or the URL of the activation email is wrong. diff --git a/docs/en/user/faq.rst b/docs/en/user/faq.rst index 04fb25e3..1e36dc26 100644 --- a/docs/en/user/faq.rst +++ b/docs/en/user/faq.rst @@ -8,3 +8,28 @@ It seems you have a problem with your ``composer`` installation. Try to uninstal `Read the documentation about composer to know how to install it `__. + +I can't valid the registration form +----------------------------------- + +Make sure that all fields are well filled: + +* valid email address +* same passwords in two fields + +I don't receive my activation email +----------------------------------- + +Are you sure your email address was correct? Did you check your spams folder? + +When I click on the activation link, I've got this message: ``The user with confirmation token "DtrOPfbQeVkWf6N" does not exist``. +---------------------------------------------------------------------------------------------------------------------------------- + +You already enabled your account or the URL of the activation email is wrong. + +I forgot my password +-------------------- + +You can reset your password by clicking on ``Forgot your password?`` link, +on the login page. Then, fill the form with your email address or your username, +you'll receive an email to reset your password. diff --git a/docs/en/user/import.rst b/docs/en/user/import.rst index d6054d39..84f07be2 100644 --- a/docs/en/user/import.rst +++ b/docs/en/user/import.rst @@ -1,42 +1,5 @@ -Migrate to wallabag -=================== - -From wallabag -------------- - -Export your data from your wallabag 1.x -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -On your config page, click on ``JSON export`` in the ``Export your wallabag data`` section. - -.. image:: ../../img/user/export_wllbg_1.png - :alt: Export from wallabag 1.x - :align: center - -You will have a ``wallabag-export-1-1970-01-01.json`` file. - -Export your data from your wallabag 2.x -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -On the export sidebar, click on ``JSON``. - -.. image:: ../../img/user/export_wllbg_2.png - :alt: Export from wallabag 2.x - :align: center - -You will have a ``Unread articles.json`` file. - -Import your data into wallabag 2.x -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Click on ``Import`` link in the menu, choose the right wallabag version, -select your export file on your computer and import it. - -.. image:: ../../img/user/import_wllbg.png - :alt: Import from wallabag 1.x - :align: center - -All your wallabag articles will be imported. +Migrate from a third service +============================ From Pocket ----------- diff --git a/docs/en/user/login.rst b/docs/en/user/login.rst index 1813f3d8..e66089bd 100644 --- a/docs/en/user/login.rst +++ b/docs/en/user/login.rst @@ -11,13 +11,3 @@ you can check the ``Keep me logged in`` checkbox: wallabag will remember you for .. image:: ../../img/user/login_form.png :alt: Login form :align: center - -Frequently asked questions --------------------------- - -I forgot my password -~~~~~~~~~~~~~~~~~~~~ - -You can reset your password by clicking on ``Forgot your password?`` link, -on the login page. Then, fill the form with your email address or your username, -you'll receive an email to reset your password. diff --git a/docs/en/user/migration.rst b/docs/en/user/migration.rst index e97c6315..e141ae40 100644 --- a/docs/en/user/migration.rst +++ b/docs/en/user/migration.rst @@ -1,5 +1,5 @@ -Migrate wallabag -================ +Migrate from v1 or v2 +===================== From wallabag 1.x ----------------- diff --git a/docs/fr/index.rst b/docs/fr/index.rst index b4275a43..afbacea0 100644 --- a/docs/fr/index.rst +++ b/docs/fr/index.rst @@ -28,13 +28,13 @@ La documentation principale de cette application est découpée en plusieurs sec user/installation user/upgrade user/migration + user/import user/create_account user/login user/configuration user/first_article user/errors_during_fetching user/annotations - user/import user/download_articles user/filters user/tags diff --git a/docs/fr/user/create_account.rst b/docs/fr/user/create_account.rst index 7f29b0f0..6e188ab3 100644 --- a/docs/fr/user/create_account.rst +++ b/docs/fr/user/create_account.rst @@ -23,24 +23,3 @@ Votre compte est maintenant actif. .. image:: ../../img/user/activated_account.png :alt: Bienvenue à bord ! :align: center - -Foire aux questions -------------------- - -Je ne peux pas valider le formulaire de création de compte -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Soyez sur d'avoir bien renseigné tous les champs : - -* une adresse email valide -* le même mot de passe dans les deux champs - -Je n'ai pas reçu mon email d'activation -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Êtes-vous sur d'avoir renseigné votre bonne adresse ? Avez-vous vérifié le dossier de spams ? - -Quand je clique sur le lien d'activation, j'ai ce message : ``The user with confirmation token "DtrOPfbQeVkWf6N" does not exist``. -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Vous avez déjà activé votre compte ou l'URL d'activation n'est pas correcte. diff --git a/docs/fr/user/faq.rst b/docs/fr/user/faq.rst index f5ae2776..e220c8a7 100644 --- a/docs/fr/user/faq.rst +++ b/docs/fr/user/faq.rst @@ -8,3 +8,28 @@ Il semblerait que vous ayiez un problème avec votre installation de ``composer` `Vous pouvez lire la documentation de composer pour savoir comment l'installer `__. + +Je ne peux pas valider le formulaire de création de compte +---------------------------------------------------------- + +Soyez sur d'avoir bien renseigné tous les champs : + +* une adresse email valide +* le même mot de passe dans les deux champs + +Je n'ai pas reçu mon email d'activation +--------------------------------------- + +Êtes-vous sur d'avoir renseigné votre bonne adresse ? Avez-vous vérifié le dossier de spams ? + +Quand je clique sur le lien d'activation, j'ai ce message : ``The user with confirmation token "DtrOPfbQeVkWf6N" does not exist``. +---------------------------------------------------------------------------------------------------------------------------------- + +Vous avez déjà activé votre compte ou l'URL d'activation n'est pas correcte. + +J'ai oublié mon mot de passe +---------------------------- + +Vous pouvez réinitialiser votre mot de passe en cliquant sur ``Mot de passe oublié ?``, +sur la page de connexion. Ensuite, renseignez votre adresse email ou votre nom d'utilisateur, +un email vous sera envoyé. diff --git a/docs/fr/user/import.rst b/docs/fr/user/import.rst index 967df1f6..f0f2b57e 100644 --- a/docs/fr/user/import.rst +++ b/docs/fr/user/import.rst @@ -1,42 +1,5 @@ -Migrer à wallabag -================= - -Depuis wallabag ---------------- - -Exportez vos données de wallabag 1.x -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Sur la page de configuration, cliquez sur ``Export JSON`` dans la section ``Exportez vos données wallabag``. - -.. image:: ../../img/user/export_wllbg_1.png - :alt: Export depuis wallabag 1.x - :align: center - -Vous obtiendrez un fichier ``wallabag-export-1-1970-01-01.json``. - -Exportez vos données de wallabag 2.x -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Dans la barre latérale de téléchargement, cliquez sur ``JSON``. - -.. image:: ../../img/user/export_wllbg_2.png - :alt: Export depuis wallabag 2.x - :align: center - -Vous obtiendrez un fichier ``Unread articles.json``. - -Importez vos données wallabag 2.x -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Cliquez sur le lien ``Importer`` dans le menu, choisissez la version de wallabag correspondante, -sélectionnez votre fichier d'export sur votre ordinateur et importez-le. - -.. image:: ../../img/user/import_wllbg.png - :alt: Import depuis wallabag 1.x - :align: center - -Tous vos articles wallabag seront importés. +Migrer depuis un service externe +================================ Depuis Pocket ------------- diff --git a/docs/fr/user/login.rst b/docs/fr/user/login.rst index 3a02d1d5..522ac259 100644 --- a/docs/fr/user/login.rst +++ b/docs/fr/user/login.rst @@ -11,13 +11,3 @@ vous pouvez cocher la case ``Restez connecté`` : wallabag se souviendra de vous .. image:: ../../img/user/login_form.png :alt: Formulaire de connexion :align: center - -Foire aux questions -------------------- - -J'ai oublié mon mot de passe -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Vous pouvez réinitialiser votre mot de passe en cliquant sur ``Mot de passe oublié ?``, -sur la page de connexion. Ensuite, renseignez votre adresse email ou votre nom d'utilisateur, -un email vous sera envoyé. diff --git a/docs/fr/user/migration.rst b/docs/fr/user/migration.rst index 012c4988..66024572 100644 --- a/docs/fr/user/migration.rst +++ b/docs/fr/user/migration.rst @@ -1,5 +1,5 @@ -Migrer wallabag -=============== +Migrer depuis la v1 ou la v2 +============================ Depuis wallabag 1.x ------------------- -- cgit v1.2.3 From 9039103c3750388dc79996ed58e5a2d7162b32ba Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Wed, 4 May 2016 06:52:26 +0200 Subject: Add Third resources for wallabag API --- docs/en/developer/api.rst | 4 +++- docs/fr/developer/api.rst | 4 +++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/en/developer/api.rst b/docs/en/developer/api.rst index 3de8ba05..9594f9af 100644 --- a/docs/en/developer/api.rst +++ b/docs/en/developer/api.rst @@ -261,6 +261,8 @@ Have a look on the listing here: http://localhost:8000/api/doc to know each meth Third resources --------------- -Some applications use our API. Here is a non-exhaustive list of them: +Some applications or libraries use our API. Here is a non-exhaustive list of them: +- `Java wrapper for the wallabag API `_ by Strubbl. +- `.NET library for the wallabag v2 API `_ by Julian Oster. - `Python API for wallabag `_ by FoxMaSk, for his project `Trigger Happy `_. diff --git a/docs/fr/developer/api.rst b/docs/fr/developer/api.rst index 458df4a9..af38d3ec 100644 --- a/docs/fr/developer/api.rst +++ b/docs/fr/developer/api.rst @@ -261,6 +261,8 @@ Jetez un œil à la liste complète ici http://localhost:8000/api/doc pour conna Ressources tierces ------------------ -Certaines applications utilisent notre API. En voici une liste non exhaustive : +Certaines applications ou bibliothèques utilisent notre API. En voici une liste non exhaustive : +- `Java wrapper for the wallabag API `_ par Strubbl. +- `.NET library for the wallabag v2 API `_ par Julian Oster. - `Python API for wallabag `_ par FoxMaSk, pour son projet `Trigger Happy `_. -- cgit v1.2.3 From 8b563fc04ee5ab6adc8370bdaf7f8a5b50f14f95 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Wed, 4 May 2016 11:40:13 +0200 Subject: Fix lighttpd documentation --- docs/en/user/installation.rst | 21 ++++++++++----------- docs/fr/user/installation.rst | 21 ++++++++++----------- 2 files changed, 20 insertions(+), 22 deletions(-) diff --git a/docs/en/user/installation.rst b/docs/en/user/installation.rst index 3872ad3a..d22f8549 100644 --- a/docs/en/user/installation.rst +++ b/docs/en/user/installation.rst @@ -192,20 +192,20 @@ After reloading or restarting nginx, you should now be able to access wallabag a When you want to import large file into wallabag, you need to add this line in your nginx configuration ``client_max_body_size XM; # allows file uploads up to X megabytes``. -Configuration on LigHTTPd +Configuration on lighttpd ~~~~~~~~~~~~~~~~~~~~~~~~~ -Edit your ``lighttpd.conf`` file and paste this configuration into it: +Assuming you install wallabag in the /var/www/wallabag folder, here's the recipe for wallabag (edit your ``lighttpd.conf`` file and paste this configuration into it): :: server.modules = ( - "mod_fastcgi", - "mod_access", - "mod_alias", - "mod_compress", - "mod_redirect", - "mod_rewrite", + "mod_fastcgi", + "mod_access", + "mod_alias", + "mod_compress", + "mod_redirect", + "mod_rewrite", ) server.document-root = "/var/www/wallabag/web" server.upload-dirs = ( "/var/cache/lighttpd/uploads" ) @@ -226,9 +226,8 @@ Edit your ``lighttpd.conf`` file and paste this configuration into it: dir-listing.activate = "disable" url.rewrite-if-not-file = ( - "^/([^?])(?:\?(.))?" => "/app.php?$1&$2", - "^/([^?]*)" => "/app.php?=$1", - "^/wiki$" => "/app.php", + "^/([^?])(?:\?(.))?" => "/app.php?$1&$2", + "^/([^?]*)" => "/app.php?=$1", ) Rights access to the folders of the project diff --git a/docs/fr/user/installation.rst b/docs/fr/user/installation.rst index 9039d608..8f2ae25d 100644 --- a/docs/fr/user/installation.rst +++ b/docs/fr/user/installation.rst @@ -189,20 +189,20 @@ Après que vous ayez rechargé/redémarré Nginx, vous devriez pouvoir avoir acc Si vous voulez importer un fichier important dans wallabag, vous devez ajouter cette ligne dans votre configuration nginx ``client_max_body_size XM; # allows file uploads up to X megabytes``. -Configuration avec LigHTTPd +Configuration avec lighttpd ~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Éditez votre fichier ``lighttpd.conf`` collez-y cette configuration : +En imaginant que vous vouliez installer wallabag dans le dossier ``/var/www/wallabag``, voici un fichier de configuration pour wallabag (éditez votre fichier ``lighttpd.conf`` collez-y cette configuration) : :: server.modules = ( - "mod_fastcgi", - "mod_access", - "mod_alias", - "mod_compress", - "mod_redirect", - "mod_rewrite", + "mod_fastcgi", + "mod_access", + "mod_alias", + "mod_compress", + "mod_redirect", + "mod_rewrite", ) server.document-root = "/var/www/wallabag/web" server.upload-dirs = ( "/var/cache/lighttpd/uploads" ) @@ -223,9 +223,8 @@ Configuration avec LigHTTPd dir-listing.activate = "disable" url.rewrite-if-not-file = ( - "^/([^?])(?:\?(.))?" => "/app.php?$1&$2", - "^/([^?]*)" => "/app.php?=$1", - "^/wiki$" => "/app.php", + "^/([^?])(?:\?(.))?" => "/app.php?$1&$2", + "^/([^?]*)" => "/app.php?=$1", ) Droits d'accès aux dossiers du projet -- cgit v1.2.3 From 7c1f64c967e98432faaed5d6f11eddf055010066 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Wed, 4 May 2016 14:42:14 +0200 Subject: Add documentation to know how to contribute to the documentation :trollface: --- docs/en/developer/documentation.rst | 12 ++++++++++++ docs/en/index.rst | 1 + docs/fr/developer/documentation.rst | 12 ++++++++++++ docs/fr/index.rst | 1 + 4 files changed, 26 insertions(+) create mode 100644 docs/en/developer/documentation.rst create mode 100644 docs/fr/developer/documentation.rst diff --git a/docs/en/developer/documentation.rst b/docs/en/developer/documentation.rst new file mode 100644 index 00000000..ab206479 --- /dev/null +++ b/docs/en/developer/documentation.rst @@ -0,0 +1,12 @@ +Contribute to this documentation +================================ + +Sources of our documentation are here https://github.com/wallabag/wallabag/tree/master/docs + +We use `ReadTheDocs +`__ to generate it. + +Pages are written in `Restructured Text +`__ format. You can use online tools like http://rst.aaroniles.net/ or http://rst.ninjs.org/ to preview your articles. + +If you create a new page, don't forget to edit the `index.rst `__ file to add a link in the sidebar. \ No newline at end of file diff --git a/docs/en/index.rst b/docs/en/index.rst index 6d2ce8f3..74e09f1a 100644 --- a/docs/en/index.rst +++ b/docs/en/index.rst @@ -46,5 +46,6 @@ The main documentation for this application is organized into a couple sections: developer/api developer/docker + developer/documentation developer/translate developer/maintenance diff --git a/docs/fr/developer/documentation.rst b/docs/fr/developer/documentation.rst new file mode 100644 index 00000000..0fbe5626 --- /dev/null +++ b/docs/fr/developer/documentation.rst @@ -0,0 +1,12 @@ +Contribuer à cette documentation +================================ + +Les sources de notre documentation sont ici https://github.com/wallabag/wallabag/tree/master/docs + +Nous utilisons `ReadTheDocs +`__ pour la générer. + +Les pages sont écrites au format `Restructured Text +`__. Vous pouvez utiliser des outils en ligne comme http://rst.aaroniles.net/ ou http://rst.ninjs.org/ pour prévisualiser vos articles. + +Si vous créez une nouvelle page, n'oubliez pas d'éditer le fichier `index.rst `__ pour ajouter un lien dans la barre latérale. \ No newline at end of file diff --git a/docs/fr/index.rst b/docs/fr/index.rst index afbacea0..1e72dae7 100644 --- a/docs/fr/index.rst +++ b/docs/fr/index.rst @@ -47,5 +47,6 @@ La documentation principale de cette application est découpée en plusieurs sec developer/api developer/docker + developer/documentation developer/translate developer/maintenance -- cgit v1.2.3 From e0f4f25fd6fba6f41532e9bf5cb6fa4c515c7a46 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Thu, 5 May 2016 13:55:39 +0200 Subject: Change documentation about Pocket import Fix wallabag/docker#8 --- docs/en/user/import.rst | 2 +- docs/fr/user/import.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/en/user/import.rst b/docs/en/user/import.rst index 84f07be2..63210484 100644 --- a/docs/en/user/import.rst +++ b/docs/en/user/import.rst @@ -16,7 +16,7 @@ a new application on their developer website to continue. and submit your new application Pocket will give you a **Consumer Key** (for example, `49961-985e4b92fe21fe4c78d682c1`). -You need to configure the ``pocket_consumer_key`` into the ``app/config/parameters.yml`` file in wallabag. +You need to configure the ``pocket_consumer_key`` into the ``Import`` section in the ``Internal settings`` menu. Now, all is fine to migrate from Pocket. diff --git a/docs/fr/user/import.rst b/docs/fr/user/import.rst index f0f2b57e..e6c2fa02 100644 --- a/docs/fr/user/import.rst +++ b/docs/fr/user/import.rst @@ -16,7 +16,7 @@ Vous devez créer une nouvelle application sur leur site dédié aux développeu termes d'utilisation du service et soumettez votre application Pocket vous fournira une **Consumer Key** (par exemple, `49961-985e4b92fe21fe4c78d682c1`). -Vous devez configurer la ``pocket_consumer_key`` dans le fichier ``app/config/parameters.yml``. +Vous devez configurer la ``pocket_consumer_key`` dans la section ``Import`` du menu ``Configuration interne``. Maintenant, tout est bien configuré pour migrer depuis Pocket. -- cgit v1.2.3