mirror of
https://github.com/wallabag/wallabag.git
synced 2025-08-01 17:38:38 +00:00
Merge remote-tracking branch 'origin/master' into 2.2
This commit is contained in:
Jeremy Benoist
commit
e4cf672ccf
74 changed files with 1595 additions and 1519 deletions
|
|
@ -46,6 +46,10 @@ Edit your ``parameters.yml`` file to edit RabbitMQ configuration. The default on
|
|||
rabbitmq_user: guest
|
||||
rabbitmq_password: guest
|
||||
|
||||
Enable RabbitMQ in wallabag
|
||||
---------------------------
|
||||
|
||||
In internal settings, in the **Import** section, enable RabbitMQ (with the value 1).
|
||||
|
||||
Launch RabbitMQ consumer
|
||||
------------------------
|
||||
|
|
|
|||
|
|
@ -35,6 +35,10 @@ Edit your ``parameters.yml`` file to edit Redis configuration. The default one s
|
|||
redis_host: localhost
|
||||
redis_port: 6379
|
||||
|
||||
Enable Redos in wallabag
|
||||
------------------------
|
||||
|
||||
In internal settings, in the **Import** section, enable Redis (with the value 1).
|
||||
|
||||
Launch Redis consumer
|
||||
---------------------
|
||||
|
|
|
|||
10
docs/en/developer/testsuite.rst
Normal file
10
docs/en/developer/testsuite.rst
Normal file
|
|
@ -0,0 +1,10 @@
|
|||
Testsuite
|
||||
=========
|
||||
|
||||
To ensure wallabag development quality, we wrote tests with `PHPUnit <https://phpunit.de>`_.
|
||||
|
||||
If you contribute to the project (by translating the application, by fixing bugs or by adding a new feature), please write your own tests.
|
||||
|
||||
To launch wallabag testsuite, you need to install `ant <http://ant.apache.org>`_.
|
||||
|
||||
Then, execute this command ``make test``.
|
||||
|
|
@ -30,8 +30,8 @@ The documentation is available in other languages:
|
|||
|
||||
user/faq
|
||||
user/installation
|
||||
user/upgrade-2.0.x-2.1.y
|
||||
user/upgrade-2.0.x-2.0.y
|
||||
user/upgrade-2.0.x-2.1.1
|
||||
user/upgrade-2.1.x-2.1.y
|
||||
user/migration
|
||||
user/import
|
||||
user/create_account
|
||||
|
|
|
|||
|
|
@ -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 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,16 +65,16 @@ 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
|
||||
|
||||
|
||||
|
||||
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
|
||||
|
|
|
|||
|
|
@ -35,7 +35,7 @@ From Readability
|
|||
Export your Readability data
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
On the tools (`https://www.readability.com/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/ <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<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 <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
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
|
|
|||
|
|
@ -6,7 +6,21 @@ 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.
|
||||
.. 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:
|
||||
|
||||
::
|
||||
|
||||
curl -s http://getcomposer.org/installer | php
|
||||
|
||||
You can find specific instructions `here <https://getcomposer.org/doc/00-intro.md>`__.
|
||||
|
||||
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,31 +52,18 @@ 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 <https://getcomposer.org/doc/00-intro.md>`__.
|
||||
|
||||
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
|
||||
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
|
||||
|
||||
|
|
@ -86,18 +87,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 <https://www.wallabag.org/pages/download-wallabag.html>`_.
|
||||
|
||||
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 <https://hub.docker.com/r/wallabag/wallabag/>`__ to have more information.
|
||||
|
||||
Command to launch container
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
|
|
@ -239,12 +240,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).
|
||||
|
||||
|
|
|
|||
50
docs/en/user/parameters.rst
Normal file
50
docs/en/user/parameters.rst
Normal file
|
|
@ -0,0 +1,50 @@
|
|||
What is the meaning of the parameters?
|
||||
======================================
|
||||
.. 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"
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
Upgrading from 2.0.x to 2.1.y
|
||||
=============================
|
||||
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.
|
||||
|
|
@ -7,8 +7,6 @@ Before this migration, if you configured the Pocket import by adding your consum
|
|||
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/*
|
||||
|
|
@ -28,25 +26,43 @@ Download the last release of wallabag:
|
|||
|
||||
.. code-block:: bash
|
||||
|
||||
wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package
|
||||
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``)
|
||||
|
||||
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) :
|
||||
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:: bash
|
||||
.. code-block:: yml
|
||||
|
||||
# RabbitMQ processing
|
||||
rabbitmq_host: localhost
|
||||
rabbitmq_port: 5672
|
||||
rabbitmq_user: guest
|
||||
rabbitmq_password: guest
|
||||
|
||||
# Redis processing
|
||||
redis_host: localhost
|
||||
redis_port: 6379
|
||||
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.
|
||||
|
||||
|
|
@ -1,17 +1,17 @@
|
|||
Upgrade from 2.0.x to 2.0.y
|
||||
===========================
|
||||
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.0.8`` by the last release number):
|
||||
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.0.8
|
||||
git checkout 2.1.2 --force
|
||||
SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist
|
||||
php bin/console cache:clear --env=prod
|
||||
|
||||
|
|
@ -26,7 +26,7 @@ Download the last release of wallabag:
|
|||
|
||||
wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package
|
||||
|
||||
(md5 hash of the 2.0.8 package: ``4f84c725d1d6e3345eae0a406115e5ff``)
|
||||
(md5 hash of the 2.1.1 package: ``9584a3b60a2b2a4de87f536548caac93``)
|
||||
|
||||
Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours.
|
||||
|
||||
Loading…
Add table
Add a link
Reference in a new issue