From 7eff4736a1309ad71a75fa74dc1081a3b2303169 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Sat, 8 Oct 2016 15:10:56 +0200 Subject: Cleaned up documentation for installation process --- docs/en/user/android.rst | 10 +++++----- docs/en/user/installation.rst | 32 +++++++++++++++----------------- 2 files changed, 20 insertions(+), 22 deletions(-) (limited to 'docs/en/user') diff --git a/docs/en/user/android.rst b/docs/en/user/android.rst index 4271f037..eec130f6 100644 --- a/docs/en/user/android.rst +++ b/docs/en/user/android.rst @@ -29,13 +29,13 @@ Fill in your wallabag data. You need to enter your wallabag address. It is impor :alt: Filled in settings :align: center -After you have filled in your data, push the button Connection test and wait for the test to finish. +After you have filled in your data, push the button Connection test and wait for the test to finish. .. image:: ../../img/user/android_configuration_connection_test.en.png :alt: Connection test with your wallabag data :align: center -The connection test shall finish with success. If not, you need to fix this first until you proceed. +The connection test shall finish with success. If not, you need to fix this first until you proceed. .. image:: ../../img/user/android_configuration_connection_test_success.en.png :alt: Connection test successful @@ -65,7 +65,7 @@ After hitting the save button, you get the following screen. The app proposes to :alt: Settings saved the first time :align: center -Finally after the syncronisation finished successfully, you are presented the list of unread articles. +Finally after the syncronisation finished successfully, you are presented the list of unread articles. .. image:: ../../img/user/android_unread_feed_synced.en.png :alt: Filled article list cause feeds successfully syncronized @@ -74,7 +74,7 @@ Finally after the syncronisation finished successfully, you are presented the li Known limitations ----- +----------------- 2FA ~~~ @@ -85,7 +85,7 @@ Currently the does not support two-factor authentication. You should disable tha Limited amount of articles with wallabag v2 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -In your wallabag web instance you can configure how many items are part of the RSS feed. This option did not exist in wallabag v1, where all articles were part of the feed. So if you set the amount of articles being displayed greater than the number of items being content of your RSS feed, you will only see the number of items in your RSS feed. +In your wallabag web instance you can configure how many items are part of the RSS feed. This option did not exist in wallabag v1, where all articles were part of the feed. So if you set the amount of articles being displayed greater than the number of items being content of your RSS feed, you will only see the number of items in your RSS feed. SSL/TLS encryption diff --git a/docs/en/user/installation.rst b/docs/en/user/installation.rst index 4aaabd82..a2f0d07b 100644 --- a/docs/en/user/installation.rst +++ b/docs/en/user/installation.rst @@ -6,7 +6,17 @@ Requirements wallabag is compatible with PHP >= 5.5, including PHP 7. -You'll need the following extensions for wallabag to work. Some of these may already activated in your version of PHP, so you may not have to install all corresponding packages. +wallabag uses a large number of PHP libraries in order to function. These libraries must be installed with a tool called Composer. You need to install it if you have not already done so and be sure to use the 1.2 version (if you already have Composer, run a ``composer selfupdate``). + +Install Composer: + +:: + + curl -s http://getcomposer.org/installer | php + +You can find specific instructions `here `__. + +You'll also need the following extensions for wallabag to work. Some of these may already activated in your version of PHP, so you may not have to install all corresponding packages. - php-session - php-ctype @@ -38,25 +48,13 @@ Installation On a dedicated web server (recommended way) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -wallabag uses a large number of PHP libraries in order to function. These libraries must be installed with a tool called Composer. You need to install it if you have not already done so and be sure to use the 1.2 version (if you already have Composer, run a ``composer selfupdate``). - -Install Composer: - -:: - - curl -s http://getcomposer.org/installer | php - -You can find specific instructions `here `__. - To install wallabag itself, you must run the following commands: :: git clone https://github.com/wallabag/wallabag.git cd wallabag - git checkout 2.1.1 --force - SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist - php bin/console wallabag:install --env=prod + ./install.sh To start PHP's build-in server and test if everything did install correctly, you can do: @@ -86,18 +84,18 @@ Execute this command to download and extract the latest package: wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package -(md5 hash of the 2.1.1 package: ``9584a3b60a2b2a4de87f536548caac93``) +You will find the `md5 hash of the latest package on our website `_. Now, read the following documentation to create your virtual host, then access 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. Command to launch container -~~~~~~~~~~~~~~~~~~~~~~~~~~~ +^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code-block:: bash -- cgit v1.2.3 From 84e3c36e02e4ffb4611f6e1eca37c97a0ffb4660 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Mon, 10 Oct 2016 09:15:53 +0200 Subject: Added documentation about testsuite Fix #2415 --- docs/en/user/installation.rst | 3 +++ 1 file changed, 3 insertions(+) (limited to 'docs/en/user') diff --git a/docs/en/user/installation.rst b/docs/en/user/installation.rst index a2f0d07b..0920b976 100644 --- a/docs/en/user/installation.rst +++ b/docs/en/user/installation.rst @@ -6,6 +6,9 @@ Requirements wallabag is compatible with PHP >= 5.5, including PHP 7. +.. note:: +To install wallabag easily, we create a ``Makefile``, so you need to have the ``make`` tool. + wallabag uses a large number of PHP libraries in order to function. These libraries must be installed with a tool called Composer. You need to install it if you have not already done so and be sure to use the 1.2 version (if you already have Composer, run a ``composer selfupdate``). Install Composer: -- cgit v1.2.3 From 7c1225347db8b516cc268709939f6b359bc283c1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Mon, 10 Oct 2016 10:20:32 +0200 Subject: Update documentation --- docs/en/user/installation.rst | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) (limited to 'docs/en/user') diff --git a/docs/en/user/installation.rst b/docs/en/user/installation.rst index 0920b976..e08e0306 100644 --- a/docs/en/user/installation.rst +++ b/docs/en/user/installation.rst @@ -56,14 +56,13 @@ To install wallabag itself, you must run the following commands: :: git clone https://github.com/wallabag/wallabag.git - cd wallabag - ./install.sh + cd wallabag && make install To start PHP's build-in server and test if everything did install correctly, you can do: :: - php bin/console server:run --env=prod + make run And access wallabag at http://yourserverip:8000 @@ -240,12 +239,12 @@ Rights access to the folders of the project 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. +When we just want to test wallabag, we just run the command ``make run`` 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 ~~~~~~~~~~~~~~~~~~~~~~ -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. +As soon as we use Apache or Nginx to access to our wallabag instance, and not from the command ``make run`` 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. To do so, the folder name, known as ``DocumentRoot`` (for apache) or ``root`` (for Nginx), has to be absolutely accessible by the Apache/Nginx user. Its name is generally ``www-data``, ``apache`` or ``nobody`` (depending on linux system used). -- cgit v1.2.3 From 7c1ce28342c85abb21dc79b9d22be35c0c09891b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Mon, 10 Oct 2016 11:21:20 +0200 Subject: Update upgrade documentation --- docs/en/user/upgrade-2.0.x-2.0.y.rst | 35 ------------------- docs/en/user/upgrade-2.0.x-2.1.1.rst | 55 ++++++++++++++++++++++++++++++ docs/en/user/upgrade-2.0.x-2.1.y.rst | 65 ------------------------------------ docs/en/user/upgrade-2.1.x-2.1.y.rst | 35 +++++++++++++++++++ 4 files changed, 90 insertions(+), 100 deletions(-) delete mode 100644 docs/en/user/upgrade-2.0.x-2.0.y.rst create mode 100644 docs/en/user/upgrade-2.0.x-2.1.1.rst delete mode 100644 docs/en/user/upgrade-2.0.x-2.1.y.rst create mode 100644 docs/en/user/upgrade-2.1.x-2.1.y.rst (limited to 'docs/en/user') diff --git a/docs/en/user/upgrade-2.0.x-2.0.y.rst b/docs/en/user/upgrade-2.0.x-2.0.y.rst deleted file mode 100644 index 3391c2cd..00000000 --- a/docs/en/user/upgrade-2.0.x-2.0.y.rst +++ /dev/null @@ -1,35 +0,0 @@ -Upgrade from 2.0.x to 2.0.y -=========================== - -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.8`` by the last release number): - -:: - - rm -rf var/cache/* - git fetch origin - git fetch --tags - git checkout 2.0.8 - 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. - -Download the last release of wallabag: - -.. code-block:: bash - - wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package - -(md5 hash of the 2.0.8 package: ``4f84c725d1d6e3345eae0a406115e5ff``) - -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. - -Empty ``var/cache`` folder. diff --git a/docs/en/user/upgrade-2.0.x-2.1.1.rst b/docs/en/user/upgrade-2.0.x-2.1.1.rst new file mode 100644 index 00000000..898b4ccc --- /dev/null +++ b/docs/en/user/upgrade-2.0.x-2.1.1.rst @@ -0,0 +1,55 @@ +Upgrade from 2.0.x to 2.1.1 +=========================== + +.. warning:: +Before this migration, if you configured the Pocket import by adding your consumer key in Internal settings, please do a backup of it: you'll have to add it into the Config page after the upgrade. + +Upgrade on a dedicated web server +--------------------------------- + +:: + + rm -rf var/cache/* + git fetch origin + git fetch --tags + git checkout 2.1.1 --force + 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. + +Download the last release of wallabag: + +.. code-block:: bash + + wget http://framabag.org/wallabag-release-2.1.1.tar.gz && tar xvf wallabag-release-2.0.8.tar.gz + +(md5 hash of the 2.1.1 package: ``9584a3b60a2b2a4de87f536548caac93``) + +Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours. + +Please check that your ``app/config/parameters.yml`` contains all the required parameters. Here is a default ``parameters.yml`` file. If you don't know which parameter you need to set, please leave the default one. + +.. code-block:: yml + + + + +If you use SQLite, you must also copy your ``data/`` folder inside the new installation. + +Empty ``var/cache`` folder. + +You must run some SQL queries to upgrade your database. We assume that the table prefix is ``wallabag_`` and the database server is a MySQL one: + +.. code-block:: sql + + ALTER TABLE `wallabag_entry` ADD `uuid` LONGTEXT DEFAULT NULL; + INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('share_public', '1', 'entry'); + ALTER TABLE `wallabag_oauth2_clients` ADD name longtext COLLATE 'utf8_unicode_ci' DEFAULT NULL; + INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_redis', '0', 'import'); + INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_rabbitmq', '0', 'import'); + ALTER TABLE `wallabag_config` ADD `pocket_consumer_key` VARCHAR(255) DEFAULT NULL; + DELETE FROM `wallabag_craue_config_setting` WHERE `name` = 'pocket_consumer_key'; diff --git a/docs/en/user/upgrade-2.0.x-2.1.y.rst b/docs/en/user/upgrade-2.0.x-2.1.y.rst deleted file mode 100644 index ec353a18..00000000 --- a/docs/en/user/upgrade-2.0.x-2.1.y.rst +++ /dev/null @@ -1,65 +0,0 @@ -Upgrading from 2.0.x to 2.1.y -============================= - -.. warning:: -Before this migration, if you configured the Pocket import by adding your consumer key in Internal settings, please do a backup of it: you'll have to add it into the Config page after the upgrade. - -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.1.1`` by the last release number): - -:: - - rm -rf var/cache/* - git fetch origin - git fetch --tags - git checkout 2.1.1 --force - SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist - php bin/console doctrine:migrations:migrate --env=prod - php bin/console cache:clear --env=prod - -Upgrade on a shared hosting ---------------------------- - -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 - -(md5 hash of the 2.1.1 package: ``9584a3b60a2b2a4de87f536548caac93``) - -Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours. - -Please note that we added new parameters in this version. You have to edit ``app/config/parameters.yml`` by adding these lines (replace with your configuration) : - -.. code-block:: bash - - # RabbitMQ processing - rabbitmq_host: localhost - rabbitmq_port: 5672 - rabbitmq_user: guest - rabbitmq_password: guest - - # Redis processing - redis_host: localhost - redis_port: 6379 - -If you use SQLite, you must also copy your ``data/`` folder inside the new installation. - -Empty ``var/cache`` folder. - -You must run some SQL queries to upgrade your database. We assume that the table prefix is ``wallabag_`` and the database server is a MySQL one: - -.. code-block:: sql - - ALTER TABLE `wallabag_entry` ADD `uuid` LONGTEXT DEFAULT NULL; - INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('share_public', '1', 'entry'); - ALTER TABLE `wallabag_oauth2_clients` ADD name longtext COLLATE 'utf8_unicode_ci' DEFAULT NULL; - INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_redis', '0', 'import'); - INSERT INTO `wallabag_craue_config_setting` (`name`, `value`, `section`) VALUES ('import_with_rabbitmq', '0', 'import'); - ALTER TABLE `wallabag_config` ADD `pocket_consumer_key` VARCHAR(255) DEFAULT NULL; - DELETE FROM `wallabag_craue_config_setting` WHERE `name` = 'pocket_consumer_key'; diff --git a/docs/en/user/upgrade-2.1.x-2.1.y.rst b/docs/en/user/upgrade-2.1.x-2.1.y.rst new file mode 100644 index 00000000..575f4ba9 --- /dev/null +++ b/docs/en/user/upgrade-2.1.x-2.1.y.rst @@ -0,0 +1,35 @@ +Upgrading from 2.1.x to 2.1.y +============================= + +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.1.2`` by the last release number): + +:: + + rm -rf var/cache/* + git fetch origin + git fetch --tags + git checkout 2.1.2 --force + 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. + +Download the last release of wallabag: + +.. code-block:: bash + + wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package + +(md5 hash of the 2.1.1 package: ``9584a3b60a2b2a4de87f536548caac93``) + +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. + +Empty ``var/cache`` folder. -- cgit v1.2.3 From eb54d338e8d013ed9323f619c960fa57369bd9a4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Mon, 10 Oct 2016 11:35:32 +0200 Subject: Typos in upgrade doc --- docs/en/user/upgrade-2.0.x-2.1.1.rst | 32 +++++++++++++++++++++++++++++--- 1 file changed, 29 insertions(+), 3 deletions(-) (limited to 'docs/en/user') diff --git a/docs/en/user/upgrade-2.0.x-2.1.1.rst b/docs/en/user/upgrade-2.0.x-2.1.1.rst index 898b4ccc..2f08b7bd 100644 --- a/docs/en/user/upgrade-2.0.x-2.1.1.rst +++ b/docs/en/user/upgrade-2.0.x-2.1.1.rst @@ -14,6 +14,7 @@ Upgrade on a dedicated web server git fetch --tags git checkout 2.1.1 --force SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist + php bin/console doctrine:migrations:migrate --env=prod php bin/console cache:clear --env=prod Upgrade on a shared hosting @@ -25,7 +26,7 @@ Download the last release of wallabag: .. code-block:: bash - wget http://framabag.org/wallabag-release-2.1.1.tar.gz && tar xvf wallabag-release-2.0.8.tar.gz + wget http://framabag.org/wallabag-release-2.1.1.tar.gz && tar xvf wallabag-release-2.1.1.tar.gz (md5 hash of the 2.1.1 package: ``9584a3b60a2b2a4de87f536548caac93``) @@ -35,8 +36,33 @@ Please check that your ``app/config/parameters.yml`` contains all the required p .. code-block:: yml - - + parameters: + database_driver: pdo_sqlite + database_host: 127.0.0.1 + database_port: null + database_name: symfony + database_user: root + database_password: null + database_path: '%kernel.root_dir%/../data/db/wallabag.sqlite' + database_table_prefix: wallabag_ + mailer_transport: smtp + mailer_host: 127.0.0.1 + mailer_user: null + mailer_password: null + locale: en + secret: ovmpmAWXRCabNlMgzlzFXDYmCFfzGv + twofactor_auth: true + twofactor_sender: no-reply@wallabag.org + fosuser_registration: true + fosuser_confirmation: true + from_email: no-reply@wallabag.org + rss_limit: 50 + rabbitmq_host: localhost + rabbitmq_port: 5672 + rabbitmq_user: guest + rabbitmq_password: guest + redis_host: localhost + redis_port: 6379 If you use SQLite, you must also copy your ``data/`` folder inside the new installation. -- cgit v1.2.3 From ed11d7f7319dbc3ad9ea8265179f0f32d7d9ef6c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Mon, 10 Oct 2016 13:01:14 +0200 Subject: Added page about parameters.yml --- docs/en/user/android.rst | 6 +++--- docs/en/user/parameters.rst | 48 +++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 51 insertions(+), 3 deletions(-) create mode 100644 docs/en/user/parameters.rst (limited to 'docs/en/user') diff --git a/docs/en/user/android.rst b/docs/en/user/android.rst index eec130f6..ccbad264 100644 --- a/docs/en/user/android.rst +++ b/docs/en/user/android.rst @@ -35,7 +35,7 @@ After you have filled in your data, push the button Connection test and wait for :alt: Connection test with your wallabag data :align: center -The connection test shall finish with success. If not, you need to fix this first until you proceed. +The connection test should finish with success. If not, you need to fix this first until you proceed. .. image:: ../../img/user/android_configuration_connection_test_success.en.png :alt: Connection test successful @@ -65,10 +65,10 @@ After hitting the save button, you get the following screen. The app proposes to :alt: Settings saved the first time :align: center -Finally after the syncronisation finished successfully, you are presented the list of unread articles. +Finally after the synchronisation finished successfully, you are presented to the list of unread articles. .. image:: ../../img/user/android_unread_feed_synced.en.png - :alt: Filled article list cause feeds successfully syncronized + :alt: Filled article list cause feeds successfully synchronized :align: center diff --git a/docs/en/user/parameters.rst b/docs/en/user/parameters.rst new file mode 100644 index 00000000..94eff689 --- /dev/null +++ b/docs/en/user/parameters.rst @@ -0,0 +1,48 @@ +What is the meaning of the parameters? +====================================== + +.. code-block:: yml + + # Database parameters + database_driver: pdo_sqlite or pdo_mysql or pdo_pgsql + database_host: 127.0.0.1 + database_port: ~ + database_name: symfony + database_user: root + database_password: ~ + database_path: "%kernel.root_dir%/../data/db/wallabag.sqlite" or empty (when using mysql or postgresql) + database_table_prefix: wallabag_ + database_socket: null + + # Configuration to send emails from wallabag + mailer_transport: smtp + mailer_host: 127.0.0.1 + mailer_user: ~ + mailer_password: ~ + + locale: en # Default language of your wallabag instance + + secret: ovmpmAWXRCabNlMgzlzFXDYmCFfzGv # A random string used for security + + twofactor_auth: true # true to enable Two factor authentication + twofactor_sender: no-reply@wallabag.org + + fosuser_registration: true # true to enable public registration + fosuser_confirmation: true # true to send a confirmation by email for each registration + + from_email: no-reply@wallabag.org # email address used in From: field in each email + + rss_limit: 50 # limit for RSS feeds + + # RabbitMQ configuration + rabbitmq_host: localhost + rabbitmq_port: 5672 + rabbitmq_user: guest + rabbitmq_password: guest + + # Redis configuration + redis_scheme: tcp + redis_host: localhost + redis_port: 6379 + redis_path: null + -- cgit v1.2.3 From 035513b0257ca5147759432e463e81bc9000221e Mon Sep 17 00:00:00 2001 From: Jeremy Benoist Date: Mon, 10 Oct 2016 13:42:50 +0200 Subject: Use table for parameters.yml --- docs/en/user/parameters.rst | 94 +++++++++++++++++++++++---------------------- 1 file changed, 48 insertions(+), 46 deletions(-) (limited to 'docs/en/user') diff --git a/docs/en/user/parameters.rst b/docs/en/user/parameters.rst index 94eff689..79c50871 100644 --- a/docs/en/user/parameters.rst +++ b/docs/en/user/parameters.rst @@ -1,48 +1,50 @@ What is the meaning of the parameters? ====================================== - -.. code-block:: yml - - # Database parameters - database_driver: pdo_sqlite or pdo_mysql or pdo_pgsql - database_host: 127.0.0.1 - database_port: ~ - database_name: symfony - database_user: root - database_password: ~ - database_path: "%kernel.root_dir%/../data/db/wallabag.sqlite" or empty (when using mysql or postgresql) - database_table_prefix: wallabag_ - database_socket: null - - # Configuration to send emails from wallabag - mailer_transport: smtp - mailer_host: 127.0.0.1 - mailer_user: ~ - mailer_password: ~ - - locale: en # Default language of your wallabag instance - - secret: ovmpmAWXRCabNlMgzlzFXDYmCFfzGv # A random string used for security - - twofactor_auth: true # true to enable Two factor authentication - twofactor_sender: no-reply@wallabag.org - - fosuser_registration: true # true to enable public registration - fosuser_confirmation: true # true to send a confirmation by email for each registration - - from_email: no-reply@wallabag.org # email address used in From: field in each email - - rss_limit: 50 # limit for RSS feeds - - # RabbitMQ configuration - rabbitmq_host: localhost - rabbitmq_port: 5672 - rabbitmq_user: guest - rabbitmq_password: guest - - # Redis configuration - redis_scheme: tcp - redis_host: localhost - redis_port: 6379 - redis_path: null - +.. csv-table:: Database parameters + :header: "name", "default", "description" + + "database_driver", "pdo_sqlite", "Should be pdo_sqlite or pdo_mysql or pdo_pgsql" + "database_host", "127.0.0.1", "host of your database (usually localhost or 127.0.0.1)" + "database_port", "~", "port of your database (you can leave ``~`` to use the default one)" + "database_name", "symfony", "name of your database" + "database_user", "root", "user that can write to this database" + "database_password", "~", "password of that user" + "database_path", "``""%kernel.root_dir%/../data/db/wallabag.sqlite""``", "only for SQLite, define where to put the database file. Leave it for other database" + "database_table_prefix", "wallabag_", "all wallabag's tables will be prefixed with that string. You can include a ``_`` for clarity" + "database_socket", "null", "If your database is using a socket instead of tcp, put the path of the socket (other connection parameters will then be ignored" + +.. csv-table:: Configuration to send emails from wallabag + :header: "name", "default", "description" + + "mailer_transport", "smtp", "The exact transport method to use to deliver emails. Valid values are: smtp, gmail, mail, sendmail, null (which will disable the mailer)" + "mailer_host", "127.0.0.1", "The host to connect to when using smtp as the transport." + "mailer_user", "~", "The username when using smtp as the transport." + "mailer_password", "~", "The password when using smtp as the transport." + +.. csv-table:: Other wallabag's option + :header: "name", "default", "description" + + "locale", "en", "Default language of your wallabag instance (like en, fr, es, etc.)" + "secret", "ovmpmAWXRCabNlMgzlzFXDYmCFfzGv", "This is a string that should be unique to your application and it's commonly used to add more entropy to security related operations." + "twofactor_auth", "true", "true to enable Two factor authentication" + "twofactor_sender", "no-reply@wallabag.org", "email of the email sender to receive the two factor code" + "fosuser_registration", "true", "true to enable public registration" + "fosuser_confirmation", "true", "true to send a confirmation by email for each registration" + "from_email", "no-reply@wallabag.org", "email address used in From: field in each email" + "rss_limit", "50", "limit for RSS feeds" + +.. csv-table:: RabbitMQ configuration + :header: "name", "default", "description" + + "rabbitmq_host", "localhost", "Host of your RabbitMQ" + "rabbitmq_port", "5672", "Port of your RabbitMQ" + "rabbitmq_user", "guest", "Usee that can read queues" + "rabbitmq_password", "guest", "Password of that user" + +.. csv-table:: Redis configuration + :header: "name", "default", "description" + + "redis_scheme", "tcp", "Specifies the protocol used to communicate with an instance of Redis. Valid values are: tcp, unix, http" + "redis_host", "localhost", "IP or hostname of the target server (ignored for unix scheme)" + "redis_port", "6379", "TCP/IP port of the target server (ignored for unix scheme)" + "redis_path", "null", "Path of the UNIX domain socket file used when connecting to Redis using UNIX domain sockets" -- cgit v1.2.3 From c15f083896768ff7eb38be35003b7668bfaa7252 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Mon, 10 Oct 2016 15:38:42 +0200 Subject: Fixed links on import page --- docs/en/user/import.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/en/user') diff --git a/docs/en/user/import.rst b/docs/en/user/import.rst index 758e3816..70f0187d 100644 --- a/docs/en/user/import.rst +++ b/docs/en/user/import.rst @@ -35,7 +35,7 @@ From Readability Export your Readability data ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -On the tools (`https://www.readability.com/tools/`_) page, click on "Export your data" in the "Data Export" section. You will received an email to download a json (which does not end with .json in fact). +On the tools (`https://www.readability.com/tools/ `_) page, click on "Export your data" in the "Data Export" section. You will received an email to download a json (which does not end with .json in fact). Import your data into wallabag 2.x ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -51,7 +51,7 @@ From Instapaper Export your Instapaper data ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -On the settings (`https://www.instapaper.com/user`_) page, click on "Download .CSV file" in the "Export" section. A CSV file will be downloaded (like ``instapaper-export.csv``). +On the settings (`https://www.instapaper.com/user `_) page, click on "Download .CSV file" in the "Export" section. A CSV file will be downloaded (like ``instapaper-export.csv``). Import your data into wallabag 2.x ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -- cgit v1.2.3 From 36ef9e2730cad290861cca6813370bc87b8f16c9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Mon, 10 Oct 2016 18:51:20 +0200 Subject: Fixed display for note in installation page --- docs/en/user/installation.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'docs/en/user') diff --git a/docs/en/user/installation.rst b/docs/en/user/installation.rst index e08e0306..248c1995 100644 --- a/docs/en/user/installation.rst +++ b/docs/en/user/installation.rst @@ -7,7 +7,8 @@ Requirements wallabag is compatible with PHP >= 5.5, including PHP 7. .. note:: -To install wallabag easily, we create a ``Makefile``, so you need to have the ``make`` tool. + + To install wallabag easily, we create a ``Makefile``, so you need to have the ``make`` tool. wallabag uses a large number of PHP libraries in order to function. These libraries must be installed with a tool called Composer. You need to install it if you have not already done so and be sure to use the 1.2 version (if you already have Composer, run a ``composer selfupdate``). -- cgit v1.2.3