+:warning: If your issue is about an error during fetching a link, please read: http://doc.wallabag.org/en/master/user/errors_during_fetching.html#how-can-i-help-to-fix-that
+
### Issue details
Please provide issue details here.
--- /dev/null
+TMP_FOLDER=/tmp
+RELEASE_FOLDER=wllbg-release
+
+ifndef ENV
+ ENV=prod
+endif
+
+help: ## Display this help menu
+ @grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
+
+clean: ## Clear the application cache
+ @rm -rf var/cache/*
+
+install: ## Install wallabag with the latest version
+ @sh scripts/install.sh $(ENV)
+
+update: ## Update the wallabag installation to the latest version
+ @sh scripts/update.sh $(ENV)
+
+run: ## Run the wallabag built-in server
+ @php bin/console server:run --env=$(ENV)
+
+build: ## Run grunt
+ @grunt
+
+test: ## Launch wallabag testsuite
+ @if [ ! -d "vendor/phpunit" ]; then composer install; fi
+ @ant prepare && vendor/phpunit/phpunit/phpunit -v
+
+release: ## Create a package. Need a VERSION parameter (eg: `make release VERSION=master`).
+ifndef VERSION
+ $(error VERSION is not set)
+endif
+ @sh scripts/release.sh $(VERSION) $(TMP_FOLDER) $(RELEASE_FOLDER) $(ENV)
+
+travis: ## Make some stuff for Travis-CI
+
+deploy: ## Deploy wallabag
+ @bundle exec cap staging deploy
+
+.PHONY: help clean install update build test release travis deploy
+
+.DEFAULT_GOAL := install
wallabag is a self hostable application allowing you to not miss any content anymore.
Click, save and read it when you can. It extracts content so that you can read it when you have time.
-More informations on our website: [wallabag.org](https://wallabag.org)
+More information on our website: [wallabag.org](https://wallabag.org).
+
+
# Install wallabag
+Please read [the documentation to see the wallabag requirements](http://doc.wallabag.org/en/master/user/installation.html#requirements).
-If you don't have it yet, please [install composer](https://getcomposer.org/download/) or be sure to use Composer 1.2 (`composer selfupdate` can help you about that). Read [our documentation](http://doc.wallabag.org) to have more information about installation.
Then you can install wallabag by executing the following commands:
```
- git clone https://github.com/wallabag/wallabag.git
- cd wallabag
- git checkout 2.1.1
- SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist
- php bin/console wallabag:install --env=prod
- php bin/console server:run --env=prod
+git clone https://github.com/wallabag/wallabag.git
+cd wallabag && make install
+make run
```
-## License
+# License
Copyright © 2013-2016 Nicolas Lœuillet <nicolas@loeuillet.org>
This work is free. You can redistribute it and/or modify it under the
terms of the MIT License. See the COPYING file for more details.
## Definition
A release is mostly a git tag of http://github.com/wallabag/wallabag, following [semantic versioning](http://semver.org).
-The last release at the time of writing is 2.0.0-alpha.2, from the v2 branch.
### Steps to release
-During this documentation, we assume the release is `release-2.0.0-beta.1`.
+During this documentation, we assume the release is `$LAST_WALLABAG_RELEASE`.
#### Files to edit
- `app/config/config.yml` (`wallabag_core.version`)
-- `README.md` (`composer create-project` command)
-- `docs/en/user/installation.rst` and its translations (`composer create-project` command)
-- `CHANGELOG.md` (by using this command `github_changelog_generator --no-compare-link --future-release "2.x.x"`. [github-changelog-generator is available here](https://github.com/skywinder/github-changelog-generator))
+- `CHANGELOG.md` (by using this command `github_changelog_generator --no-compare-link`. [github-changelog-generator is available here](https://github.com/skywinder/github-changelog-generator))
#### Create release on GitHub
- Run these commands to create the tag:
```
- git checkout v2
- git pull origin v2
- git checkout -b release-2.0.0-beta.1
- SYMFONY_ENV=prod composer up --no-dev
- git add --force composer.lock
- git add README.md
- git commit -m "Release wallabag 2.0.0-beta.1"
- git push origin release-2.0.0-beta.1
+git checkout master
+git pull origin master
+git checkout -b release-$LAST_WALLABAG_RELEASE
+SYMFONY_ENV=prod composer up --no-dev
+git add --force composer.lock
+git commit -m "Release wallabag $LAST_WALLABAG_RELEASE"
+git push origin release-$LAST_WALLABAG_RELEASE
```
-- Create a new pull request with this title `DON'T MERGE Release wallabag 2.0.0-beta.1`. This pull request is used to launch builds on Travis-CI.
-- Run these commands to create the package:
+- Create a new pull request with this title `DON'T MERGE Release wallabag $LAST_WALLABAG_RELEASE`. This pull request is used to launch builds on Travis-CI.
+- Run these command to create the package:
```
- git clone git@github.com:wallabag/wallabag.git -b release-2.0.0-beta.1 release-2.0.0-beta.1
- SYMFONY_ENV=prod composer up -d=release-2.0.0-beta.1 --no-dev
- tar czf wallabag-release-2.0.0-beta.1.tar.gz --exclude="var/*" --exclude=".git" release-2.0.0-beta.1
+make release master /tmp wllbg-release prod
```
- [Create the new release on GitHub](https://github.com/wallabag/wallabag/releases/new). You have to upload on this page the package.
-- Delete the `release-2.0.0-beta.1` branch and close the pull request (**DO NOT MERGE IT**).
+- Delete the `release-$LAST_WALLABAG_RELEASE` branch and close the pull request (**DO NOT MERGE IT**).
- Update the URL shortener (used on `wllbg.org` to generate links like `http://wllbg.org/latest-v2-package` or `http://wllbg.org/latest-v2`)
- Update [the downloads page](https://github.com/wallabag/wallabag.org/blob/master/content/pages/download.md) on the website (MD5 sum, release date)
-- Drink a beer!
+- Update Dockerfile https://github.com/wallabag/docker (and create a new tag)
+- Update wallabag.org website (downloads, releases and new blog post)
+- Put the next patch version suffixed with `-dev` in `app/config/config.yml` (`wallabag_core.version`)
+- Drink a :beer:!
### `composer.lock`
A release tag must contain a `composer.lock` file. It sets which dependencies were available at the time a release was done,
assets: ~
wallabag_core:
- version: 2.1.1
+ version: 2.1.2-dev
paypal_url: "https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=9UBA65LG3FX9Y&lc=gb"
languages:
en: 'English'
"liip/theme-bundle": "~1.1",
"lexik/form-filter-bundle": "~5.0",
"j0k3r/graby": "~1.0",
- "friendsofsymfony/user-bundle": "~2.0@dev",
+ "friendsofsymfony/user-bundle": "dev-master#e168ed64629d034cb9cbbffb9d4350f62ef04fab as 2.0.x-dev",
"friendsofsymfony/oauth-server-bundle": "^1.5",
- "stof/doctrine-extensions-bundle": "^1.2@dev",
+ "stof/doctrine-extensions-bundle": "^1.2",
"scheb/two-factor-bundle": "~2.0",
"grandt/phpepub": "~4.0",
"wallabag/php-mobi": "~1.0.0",
rabbitmq_user: guest
rabbitmq_password: guest
+Enable RabbitMQ in wallabag
+---------------------------
+
+In internal settings, in the **Import** section, enable RabbitMQ (with the value 1).
Starte den RabbitMQ Consumer
----------------------------
redis_host: localhost
redis_port: 6379
+Enable Redis in wallabag
+------------------------
+
+In internal settings, in the **Import** section, enable Redis (with the value 1).
Starte den Redis Consumer
-------------------------
--- /dev/null
+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``.
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.0.x-2.1.1
user/migration
user/import
user/create_account
user/filters
user/tags
user/android
+ user/parameters
.. _dev-docs:
Welche Variablen und Operatoren kann ich zum Regeln schreiben nutzen?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Die folgenden Variabel und Operatoren können genutzt werden, um Tagging-Regeln zu erstellen:
+Die folgenden Variablen und Operatoren können genutzt werden, um Tagging-Regeln zu erstellen (sei vorsichtig, denn bei einigen Werten musst du Anführungszeichen hinzufügen, z.B. ``language = "de"``):
=========== ============================================== ======== ==========
Variable Bedeutung Operator Bedeutung
wallabag ist kompatibel mit PHP >= 5.5, inkl. PHP 7.
+.. note::
+
+ To install wallabag easily, we create a ``Makefile``, so you need to have the ``make`` tool.
+
+wallabag nutzt eine große Anzahl an Bibliotheken, um zu funktionieren. Diese Bibliotheken müssen mit einem Tool namens Composer installiert werden. Du musst es installieren sofern du es bisher noch nicht gemacht hast.
+
+Composer installieren:
+
+::
+
+ curl -s http://getcomposer.org/installer | php
+
+Du kannst eine spezifische Anleitung `hier <https://getcomposer.org/doc/00-intro.md>`__ finden.
+
Du benötigst die folgenden Extensions damit wallabag funktioniert. Einige von diesen sind vielleicht schon in deiner Version von PHP aktiviert, somit musst du eventuell
nicht alle folgenden Pakete installieren.
Auf einem dedizierten Webserver (empfohlener Weg)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-wallabag nutzt eine große Anzahl an Bibliotheken, um zu funktionieren. Diese Bibliotheken müssen mit einem Tool namens Composer installiert werden. Du musst es installieren sofern du es bisher noch nicht gemacht hast.
-
-Composer installieren:
-
-::
-
- curl -s http://getcomposer.org/installer | php
-
-Du kannst eine spezifische Anleitung `hier <https://getcomposer.org/doc/00-intro.md>`__ finden.
-
Um wallabag selbst zu installieren, musst du die folgenden Kommandos ausführen:
::
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
Um PHPs eingebauten Server zu starten und zu testen, ob alles korrekt installiert wurde, kannst du folgendes Kommando ausführen:
::
- php bin/console server:run --env=prod
+ make run
-Und wallabag unter http://deineserverip:8000 erreichen
+und wallabag unter http://deineserverip:8000 erreichen.
.. tip::
wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package
-(md5 hash: ``6c33520e29cc754b687f9cee0398dede``)
+Du findest die `md5 Hashsumme des neuesten Pakets auf unserer Website <https://www.wallabag.org/pages/download-wallabag.html>`_.
-Jetzt lese die Dokumentation, um einen Virtualhost zu erstellen, dann greife auf dein wallabag zu.
+Jetzt lies die Dokumentation, um einen Virtualhost zu erstellen, dann greife auf dein wallabag zu.
Wenn du die Datenbankkonfiguration eingestellt hast, MySQL oder PostgreSQL zu nutzen, musst du einen Nutzer über das folgende Kommando erstellen ``php bin/console wallabag:install --env=prod``.
Installation mit Docker
-------------------------
+~~~~~~~~~~~~~~~~~~~~~~~
Wir stellen ein Docker Image zu Verfügung, um wallabag einfach zu installieren. Schaue in unser Repository in unserem `Docker Hub <https://hub.docker.com/r/wallabag/wallabag/>`__, um mehr Informationen zu erhalten.
Kommando, um den Container zu starten
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code-block:: bash
------------
Konfiguration von Apache
-~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~
Angenommen du willst wallabag in das Verzeichnis ``/var/www/wallabag`` installieren und du willst PHP als Apache Modul nutzen, dann ist hier ein vhost für wallabag:
access_log /var/log/nginx/wallabag_access.log;
}
-Nach dem neuladen oder neustarten von nginx, solltest du nun wallabag unter http://domain.tld erreichen.
+Nach dem Neuladen oder Neustarten von nginx solltest du nun wallabag unter http://domain.tld erreichen.
.. 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``.
Wenn du eine große Datei in wallabag importieren willst, solltest du diese Zeile zu deiner nginx Konfiguration hinzufügen ``client_max_body_size XM; # allows file uploads up to X megabytes``.
Konfiguration von lighttpd
-~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~
Angenommen du willst wallabag in das Verzeichnis ``/var/www/wallabag`` installieren, dann ist hier ein Rezept für wallabag (bearbeite deine ``lighttpd.conf`` und füge die Konfiguration dort ein):
--- /dev/null
+Was bedeuten die Parameter?
+===========================
+.. csv-table:: Datenbankparameter
+ :header: "Name", "Standardwert", "Beschreibung"
+
+ "database_driver", "pdo_sqlite", "Sollte pdo_sqlite oder pdo_mysql oder pdo_pgsql sein"
+ "database_host", "127.0.0.1", "Hostadresse deiner Datenbank (normalerweise localhost oder 127.0.0.1)"
+ "database_port", "~", "Port deiner Datenbank (Du kannst ``~`` stehen lassen, um den Standardport zu nutzen)"
+ "database_name", "symfony", "Benenne deine Datenbank"
+ "database_user", "root", "Benutzer, der Schreibrecht in der Datenbank hat"
+ "database_password", "~", "Passwort des Benutzers"
+ "database_path", "``""%kernel.root_dir%/../data/db/wallabag.sqlite""``", "nur für SQLite, definiere, wo die Datenbankdatei abgelegt werden soll. Lass den Parameter leer für andere Datenbanktypen."
+ "database_table_prefix", "wallabag_", "alle wallabag Tabellen erhalten diesen Präfix im Namen. Du kannst einen ``_`` dafür im Präfix nutzen, um das zu verdeutlichen."
+ "database_socket", "null", "Wenn deine Datenbank einen Socket statt TCP nutzt, schreibe hier den Pfad zum Socket hin (andere Verbindungsparameter werden dann ignoriert."
+
+.. csv-table:: Konfiguration, um mit wallabag E-Mails senden zu können
+ :header: "Name", "Standardwert", "Beschreibung"
+
+ "mailer_transport", "smtp", "Die exakte Transportmethode, um E-Mails zuzustellen. Gültige Werte sind: smtp, gmail, mail, sendmail, null (was das Mailen deaktivert)"
+ "mailer_host", "127.0.0.1", "Der Host, zu dem sich verbunden wird, wenn SMTP als Transport genutzt wird."
+ "mailer_user", "~", "Der Benutzername, wenn SMTP als Transport genutzt wird."
+ "mailer_password", "~", "Das Passwort, wenn SMTP als Transport genutzt wird."
+
+.. csv-table:: Andere wallabag Optionen
+ :header: "Name", "Standardwert", "Beschreibung"
+
+ "locale", "en", "Standardsprache deiner wallabag Instanz (wie z.B. en, fr, es, etc.)"
+ "secret", "ovmpmAWXRCabNlMgzlzFXDYmCFfzGv", "Dieser String sollte einzigartig für deine Applikation sein und er wird genutzt, um sicherheitsrelevanten Operationen mehr Entropie hinzuzufügen."
+ "twofactor_auth", "true", "true, um Zwei-Faktor-Authentifizierung zu aktivieren"
+ "twofactor_sender", "no-reply@wallabag.org", "E-Mail-Adresse des Senders der Mails mit dem Code für die Zwei-Faktor-Authentifizierung"
+ "fosuser_registration", "true", "true, um die Registrierung für jedermann zu aktivieren"
+ "fosuser_confirmation", "true", "true, um eine Bestätigungsmail für jede Registrierung zu senden"
+ "from_email", "no-reply@wallabag.org", "E-Mail-Adresse, die im Absenderfeld jeder Mail genutzt wird"
+ "rss_limit", "50", "Artikellimit für RSS Feeds"
+
+.. csv-table:: RabbitMQ Konfiguration
+ :header: "Name", "Standardwert", "Beschreibung"
+
+ "rabbitmq_host", "localhost", "Host deines RabbitMQ"
+ "rabbitmq_port", "5672", "Port deines RabbitMQ"
+ "rabbitmq_user", "guest", "Benutzer, der die Queue lesen kann"
+ "rabbitmq_password", "guest", "Passwort dieses Benutzers"
+
+.. csv-table:: Redis Konfiguration
+ :header: "Name", "Standardwert", "Beschreibung"
+
+ "redis_scheme", "tcp", "Bestimmt das Protokoll, dass genutzt wird, um mit Redis zu kommunizieren. Gültige Werte sind: tcp, unix, http"
+ "redis_host", "localhost", "IP oder Hostname des Zielservers (ignoriert bei Unix Schema)"
+ "redis_port", "6379", "TCP/IP Port des Zielservers (ignoriert bei Unix Schema)"
+ "redis_path", "null", "Pfad zur Unix Domain Socket Datei, wenn Redis Unix Domain Sockets nutzt"
-Wallabag updaten
-================
+Wallabag von 2.0.x auf 2.1.1 updaten
+====================================
.. warning::
Wenn du den Import von Pocket durch das Hinzufügen des Consumer Key in den internen Einstellungen konfiguriert hast, fertige bitte ein Backup deines Keys an, bevor du auf das neue Release migrierst: Du wirst den Key nach dem Update in der Konfiguration erneut eintragen müssen.
wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package
-(2.1.1 md5 hash: ``9584a3b60a2b2a4de87f536548caac93``)
+(2.1.1 md5 Hashsumme: ``9584a3b60a2b2a4de87f536548caac93``)
Entpacke das Archiv in deinen wallabag-Ordner und ersetze ``app/config/parameters.yml`` mit deiner Datei.
Bitte beachte, dass wir in dieser Version neue Parameter hinzugefügt haben. Du musst die Datei ``app/config/parameters.yml`` bearbeiten und die folgenden Zeilen hinzufügen (ersetze die Werte mit deiner Konfiguration):
-.. 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
+.. 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
+
+Du kannst `hier eine Dokumentation über die Parameter finden <http://doc.wallabag.org/en/master/user/parameters.html>`_.
Wenn du SQLite nutzt, musst auch das ``data/`` Verzeichnis in die neue Installation kopieren.
-Wallabag updaten 2.0.x -> 2.1.x
-===============================
+Wallabag von 2.1.x auf 2.1.y updaten
+====================================
Update auf einem dedizierten Webserver
--------------------------------------
-Das neueste Release ist auf https://www.wallabag.org/pages/download-wallabag.html veröffentlicht. Um deine wallabag Installation auf die neueste Version upzudaten, führe die folgenden Kommandos in deinem wallabag Ordner aus (ersetze ``2.0.8`` mit der neuesten Releasenummer):
+Das neueste Release ist auf https://www.wallabag.org/pages/download-wallabag.html veröffentlicht. Um deine wallabag Installation auf die neueste Version upzudaten, führe die folgenden Kommandos in deinem wallabag Ordner aus (ersetze ``2.1.2`` mit der neuesten Releasenummer):
::
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
wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package
-(md5 hash: ``4f84c725d1d6e3345eae0a406115e5ff``)
+(md5 Hashsumme von 2.1.1: ``9584a3b60a2b2a4de87f536548caac93``)
Entpacke das Archiv in deinen wallabag Ordner und ersetze ``app/config/parameters.yml`` mit deiner Datei.
* wallabag freshly (or not) installed on http://localhost:8000
* ``httpie`` installed on your computer (`see project website <https://github.com/jkbrzt/httpie>`__). Note that you can also adapt the commands using curl or wget.
-* all the API methods are documented here http://localhost:8000/api/doc
+* all the API methods are documented here http://localhost:8000/api/doc (on your instance) and `on our example instance <http://v2.wallabag.org/api/doc>`_
Creating a new API client
-------------------------
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
------------------------
redis_host: localhost
redis_port: 6379
+Enable Redis in wallabag
+------------------------
+
+In internal settings, in the **Import** section, enable Redis (with the value 1).
Launch Redis consumer
---------------------
--- /dev/null
+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``.
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
user/filters
user/tags
user/android
+ user/parameters
.. _dev-docs:
: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
: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
~~~
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
Which variables and operators can I use to write rules?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-The following variables and operators can be used to create tagging rules:
+The following variables and operators can be used to create tagging rules (be careful, for some values, you need to add quotes, for example ``language = "en"``):
=========== ============================================== ======== ==========
Variable Meaning Operator Meaning
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
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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 provide 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
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
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.
+We provide you a Docker image to install wallabag easily. Have a look at our repository on `Docker Hub <https://hub.docker.com/r/wallabag/wallabag/>`__ for more information.
Command to launch container
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code-block:: bash
.. 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``.
+ When you want to import large files 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
~~~~~~~~~~~~~~~~~~~~~~~~~
-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):
+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):
::
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).
-So the folder ``/var/www/wallabag/web`` has to be accessible by this last one. But this could be not enough if we just care about this folder, because we could meet a blank page or get an error 500 when trying to access to the homepage of the project.
+So the folder ``/var/www/wallabag/web`` has to be accessible by this last one. But this may not be enough if we just care about this folder, because we could meet a blank page or get an error 500 when trying to access to the homepage of the project.
This is due to the fact that we will need to grant the same rights access on the folder ``/var/www/wallabag/var`` like those we gave on the folder ``/var/www/wallabag/web``. Thus, we fix this problem with the following command:
--- /dev/null
+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 empty 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", "User 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"
-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.
+
+ 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/*
.. 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) :
-
-.. 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
+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
+
+ 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
+
+You can find `here a documentation about parameters <http://doc.wallabag.org/en/master/user/parameters.html>`_.
If you use SQLite, you must also copy your ``data/`` folder inside the new installation.
-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
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.
rabbitmq_user: guest
rabbitmq_password: guest
+Activer RabbitMQ dans wallabag
+------------------------------
+
+Dans les paramètres internes, section **Import**, activez RabbitMQ (avec la valeur 1).
Démarrer les clients RabbitMQ
-----------------------------
redis_host: localhost
redis_port: 6379
+Activer Redis dans wallabag
+---------------------------
+
+Dans les paramètres internes, section **Import**, activez Redis (avec la valeur 1).
Démarrer les clients Redis
--------------------------
--- /dev/null
+Suite de tests
+==============
+
+Pour assurer la qualité du développement de wallabag, nous avons écrit des tests avec `PHPUnit <https://phpunit.de>`_.
+
+Si vous contribuez au projet (en traduisant l'application, en corrigeant des bugs ou en ajoutant une nouvelle fonctionnalité), merci d'écrire vos propres tests.
+
+Pour lancer la suite de tests de wallabag, vous devez installer `ant <http://ant.apache.org>`_.
+
+Ensuite, exécutez la commande ``make test``.
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.0.x-2.1.1
user/migration
user/import
user/create_account
user/share
user/filters
user/tags
+ user/parameters
.. _dev-docs:
Quels variables et opérateurs puis-je utiliser pour écrire mes règles ?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Les variables et opérateurs suivants peuvent être utilisés lors de la création de vos règles :
+Les variables et opérateurs suivants peuvent être utilisés lors de la création de vos règles (attention, pour certaines valeurs, vous devez ajouter des guillemets, par exemple ``language = "en"``) :
=========== ============================================== ========== ==========
Variable Sens Opérateur Sens
Exportez vos données de Readability
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Sur la page des outils (`https://www.readability.com/tools/<https://www.readability.com/tools/>`_), cliquez sur "Export your data" dans la section "Data Export". Vous allez recevoir un email avec un lien pour télécharger le json.
+Sur la page des outils (`https://www.readability.com/tools/ <https://www.readability.com/tools/>`_), cliquez sur "Export your data" dans la section "Data Export". Vous allez recevoir un email avec un lien pour télécharger le json.
Importez vos données dans wallabag 2.x
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Exportez vos données de Instapaper
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Sur la page des paramètres (`https://www.instapaper.com/user<https://www.instapaper.com/user>`_), cliquez sur "Download .CSV file" dans la section "Export". Un fichier CSV se téléchargera (``instapaper-export.csv``).
+Sur la page des paramètres (`https://www.instapaper.com/user <https://www.instapaper.com/user>`_), cliquez sur "Download .CSV file" dans la section "Export". Un fichier CSV se téléchargera (``instapaper-export.csv``).
Importez vos données dans wallabag 2.x
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
wallabag est compatible avec PHP >= 5.5, PHP 7 inclus.
+.. note::
+
+ Pour installer wallabag facilement, nous avons créé un ``Makefile``, vous avez donc besoin d'avoir installé l'outil ``make``.
+
+wallabag utilise un grand nombre de bibliothèques PHP 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 et vous assurer que vous utilisez bien la version 1.2 (si vous avez déjà Composer, faite un ``composer selfupdate``).
+
+Installation de Composer :
+
+::
+
+ curl -s http://getcomposer.org/installer | php
+
+Vous pouvez trouver des instructions spécifiques `ici (en anglais) <https://getcomposer.org/doc/00-intro.md>`__.
+
Vous aurez besoin des extensions suivantes pour que wallabag fonctionne. Il est possible que certaines de ces extensions soient déjà activées dans votre version de PHP, donc vous n'avez pas forcément besoin d'installer tous les paquets correspondants.
- php-session
Sur un serveur dédié (méthode conseillée)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-wallabag utilise un grand nombre de bibliothèques PHP 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 et vous assurer que vous utilisez bien la version 1.2 (si vous avez déjà Composer, faite un ``composer selfupdate``).
-
-Installation de Composer :
-
-::
-
- curl -s http://getcomposer.org/installer | php
-
-Vous pouvez trouver des instructions spécifiques `ici (en anglais) <https://getcomposer.org/doc/00-intro.md>`__.
-
Pour installer wallabag, vous devez exécuter ces commandes :
::
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
Pour démarrer le serveur interne à php et vérifier que tout s'est installé correctement, vous pouvez exécuter :
::
- php bin/console server:run --env=prod
+ make run
Et accéder wallabag à l'adresse http://lipdevotreserveur:8000
.. 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 <http://symfony.com/doc/current/cookbook/configuration/external_parameters.html>`__ pour en savoir plus.
+ 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 la `documentation Symfony <http://symfony.com/doc/current/cookbook/configuration/external_parameters.html>`__ pour en savoir plus.
Sur un serveur mutualisé
~~~~~~~~~~~~~~~~~~~~~~~~
wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package
-(hash md5 de l'archive 2.1.1 : ``9584a3b60a2b2a4de87f536548caac93``)
+Vous trouverez `le hash md5 du dernier package sur notre site <https://www.wallabag.org/pages/download-wallabag.html>`_.
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
-------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~
Nous vous proposons une image Docker pour installer wallabag facilement. Allez voir du côté de `Docker Hub <https://hub.docker.com/r/wallabag/wallabag/>`__ pour plus d'informations.
Commande pour démarrer le containeur
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code-block:: bash
--- /dev/null
+À quoi servent les paramètres ?
+===============================
+.. csv-table:: Paramètres de base de données
+ :header: "name", "default", "description"
+
+ "database_driver", "pdo_sqlite", "Doit être pdo_sqlite ou pdo_mysql ou pdo_pgsql"
+ "database_host", "127.0.0.1", "Hôte de votre base de données (généralement localhost ou 127.0.0.1)"
+ "database_port", "~", "Port de votre base de données (vous pouvez laisser ``~`` pour utiliser celui par défaut)"
+ "database_name", "symfony", "Nom de votre base de données"
+ "database_user", "root", "Utilisateur de votre base de données"
+ "database_password", "~", "Mot de passe de cet utilisateur"
+ "database_path", "``""%kernel.root_dir%/../data/db/wallabag.sqlite""``", "Uniquement pour SQLite. Chemin du fichier de base de données. Laissez vide pour les autres bases de données."
+ "database_table_prefix", "wallabag_", "Toutes les tables de wallabag seront préfixées par cette chaine. Vous pouvez ajouter un ``_`` pour plus de clarté"
+ "database_socket", "null", "Si votre base de données utilise un socket plutôt que tcp, spécifiez le chemin du socket (les autres paramètres de connexion seront alors ignorés)"
+
+.. csv-table:: Configuration pour envoyer des emails depuis wallabag
+ :header: "name", "default", "description"
+
+ "mailer_transport", "smtp", "Méthode de transport exacte utilisée pour envoyer des emails. Les valeurs correctes sont : smtp, gmail, mail, sendmail, null (ce qui désactivera l'envoi des emails)"
+ "mailer_host", "127.0.0.1", "Hôte sur lequel se connecter quand on utilise smtp comme transport."
+ "mailer_user", "~", "Utilisateur smtp."
+ "mailer_password", "~", "Mot de passe de cet utilisateur."
+
+.. csv-table:: Autres options de wallabag
+ :header: "name", "default", "description"
+
+ "locale", "en", "Langue par défaut de votre instance wallabag (comme en, fr, es, etc.)"
+ "secret", "ovmpmAWXRCabNlMgzlzFXDYmCFfzGv", "C'est une chaine qui doit être unique à votre application et qui est couramment utilisée pour ajouter plus d'entropie aux opérations relatives à la sécurité."
+ "twofactor_auth", "true", "true pour activer l'authentification à deux facteurs"
+ "twofactor_sender", "no-reply@wallabag.org", "Email de l'expéditeur du code de l'authentification à deux facteurs"
+ "fosuser_registration", "true", "true pour activer l'inscription publique"
+ "fosuser_confirmation", "true", "true pour envoyer un email de confirmation pour chaque création de compte"
+ "from_email", "no-reply@wallabag.org", "Email de l'expéditeur pour chaque email envoyé"
+ "rss_limit", "50", "Limite pour les flux RSS"
+
+.. csv-table:: Configuration RabbitMQ
+ :header: "name", "default", "description"
+
+ "rabbitmq_host", "localhost", "Hôte de votre instance RabbitMQ"
+ "rabbitmq_port", "5672", "Port de votre instance RabbitMQ"
+ "rabbitmq_user", "guest", "Utilisateur de votre instance RabbitMQ"
+ "rabbitmq_password", "guest", "Mot de passe de cet utilisateur"
+
+.. csv-table:: Configuration Redis
+ :header: "name", "default", "description"
+
+ "redis_scheme", "tcp", "Définit le protocole utilisé pour commuiquer avec l'instance Redis. Les valeurs correctes sont : tcp, unix, http"
+ "redis_host", "localhost", "IP ou hôte du serveur cible (ignoré pour un schéma unix)"
+ "redis_port", "6379", "Port TCP/IP du serveur cible (ignoré pour un schéma unix)"
+ "redis_path", "null", "Chemin du fichier de socket du domaine UNIX utilisé quand on se connecte à Redis en utilisant les sockets du domaine UNIX"
-Mettre à jour de la 2.0.x à la 2.1.y
+Mettre à jour de la 2.0.x à la 2.1.1
====================================
.. warning::
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.1.1`` par le numéro de la dernière version) :
-
::
rm -rf var/cache/*
.. 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
(hash md5 de l'archive 2.1.1 : ``9584a3b60a2b2a4de87f536548caac93``)
Décompressez l'archive dans votre répertoire d'installation et remplacez le fichier ``app/config/parameters.yml`` avec le votre.
-Nous avons ajouté de nouveaux paramètres dans cette nouvelle version. Vous devez donc éditer le fichier ``app/config/parameters.yml`` en ajoutant ces lignes (et en remplaçant par votre 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
+Vérifiez que votre fichier ``app/config/parameters.yml`` contient tous les paramètres requis. Voici un fichier ``parameters.yml`` par défaut. Si vous ne savez pas quelle valeur mettre à un paramètre, laissez la valeur par défaut.
+
+.. 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
+
+Vous trouverez `ici une documentation détaillée concernant les paramètres <http://doc.wallabag.org/fr/master/user/parameters.html>`_.
Si vous utilisez SQLite, vous devez également conserver le contenu du répertoire ``data/``.
-Mettre à jour de la 2.0.x à la 2.0.y
+Mettre à jour de la 2.1.x à la 2.1.y
====================================
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.8`` par le numéro de la dernière version) :
+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.1.2`` par le numéro de la dernière version) :
::
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
wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package
-(hash md5 de l'archive 2.0.8 : ``4f84c725d1d6e3345eae0a406115e5ff``)
+(hash md5 de l'archive 2.1.1 : ``9584a3b60a2b2a4de87f536548caac93``)
Décompressez l'archive dans votre répertoire d'installation et remplacez le fichier ``app/config/parameters.yml`` avec le votre.
--- /dev/null
+#! /usr/bin/env bash
+# You can execute this file to install wallabag
+# eg: `sh install.sh prod`
+
+ENV=$1
+TAG=$(git describe --tags $(git rev-list --tags --max-count=1))
+
+git checkout $TAG
+SYMFONY_ENV=$ENV composer install --no-dev -o --prefer-dist
+php bin/console wallabag:install --env=$ENV
--- /dev/null
+#! /usr/bin/env bash
+# You can execute this file to create a new package for wallabag
+# eg: `sh release.sh master /tmp wllbg-release prod`
+
+VERSION=$1
+TMP_FOLDER=$2
+RELEASE_FOLDER=$3
+ENV=$4
+
+rm -rf $TMP_FOLDER/$RELEASE_FOLDER
+mkdir $TMP_FOLDER/$RELEASE_FOLDER
+git clone git@github.com:wallabag/wallabag.git -b $VERSION $TMP_FOLDER/$RELEASE_FOLDER/$VERSION
+cd $TMP_FOLDER/$RELEASE_FOLDER/$VERSION && SYMFONY_ENV=$ENV composer up -n --no-dev
+cd $TMP_FOLDER/$RELEASE_FOLDER/$VERSION && php bin/console wallabag:install --env=$ENV
+cd $TMP_FOLDER/$RELEASE_FOLDER && tar czf wallabag-$VERSION.tar.gz --exclude="var/cache/*" --exclude="var/logs/*" --exclude="var/sessions/*" --exclude=".git" $VERSION
+echo "MD5 checksum of the package for wallabag $VERSION"
+md5 $TMP_FOLDER/$RELEASE_FOLDER/wallabag-$VERSION.tar.gz
+scp $TMP_FOLDER/$RELEASE_FOLDER/wallabag-$VERSION.tar.gz framasoft_bag@78.46.248.87:/var/www/framabag.org/web
+rm -rf $TMP_FOLDER/$RELEASE_FOLDER
--- /dev/null
+#! /usr/bin/env bash
+# You can execute this file to update wallabag
+# eg: `sh update.sh prod`
+
+ENV=$1
+TAG=$(git describe --tags $(git rev-list --tags --max-count=1))
+
+rm -rf var/cache/*
+git fetch origin
+git fetch --tags
+git checkout $TAG --force
+SYMFONY_ENV=$ENV composer install --no-dev -o --prefer-dist
+php bin/console cache:clear --env=$ENV
protected $id;
/**
- * @ORM\ManyToOne(targetEntity="Client")
+ * @ORM\ManyToOne(targetEntity="Client", inversedBy="accessTokens")
* @ORM\JoinColumn(nullable=false)
*/
protected $client;
protected $id;
/**
- * @ORM\ManyToOne(targetEntity="Client")
+ * @ORM\ManyToOne(targetEntity="Client", inversedBy="refreshTokens")
* @ORM\JoinColumn(nullable=false)
*/
protected $client;
use Symfony\Component\Console\Input\ArrayInput;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
-use Symfony\Component\Console\Output\NullOutput;
+use Symfony\Component\Console\Output\BufferedOutput;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Question\ConfirmationQuestion;
use Symfony\Component\Console\Question\Question;
try {
$this->getContainer()->get('doctrine')->getManager()->getConnection()->connect();
} catch (\Exception $e) {
- if (false === strpos($e->getMessage(), 'Unknown database')) {
+ if (false === strpos($e->getMessage(), 'Unknown database')
+ && false === strpos($e->getMessage(), 'database "'.$this->getContainer()->getParameter('database_name').'" does not exist')) {
$fulfilled = false;
$status = '<error>ERROR!</error>';
$help = 'Can\'t connect to the database: '.$e->getMessage();
}
$this->getApplication()->setAutoExit(false);
- $exitCode = $this->getApplication()->run(new ArrayInput($parameters), new NullOutput());
+
+ $output = new BufferedOutput();
+ $exitCode = $this->getApplication()->run(new ArrayInput($parameters), $output);
if (0 !== $exitCode) {
$this->getApplication()->setAutoExit(true);
- $errorMessage = sprintf('The command "%s" terminated with an error code: %u.', $command, $exitCode);
- $this->defaultOutput->writeln("<error>$errorMessage</error>");
- $exception = new \Exception($errorMessage, $exitCode);
+ $this->defaultOutput->writeln('');
+ $this->defaultOutput->writeln('<error>The command "'.$command.'" generates some errors: </error>');
+ $this->defaultOutput->writeln($output->fetch());
- throw $exception;
+ die();
}
// PDO does not always close the connection after Doctrine commands.
<meta property="og:title" content="{{ entry.title | raw }}" />
<meta property="og:type" content="article" />
<meta property="og:url" content="{{ app.request.uri }}" />
+ {% set picturePath = app.request.schemeAndHttpHost ~ asset('bundles/wallabagcore/themes/_global/img/logo-other_themes.png') %}
{% if entry.previewPicture is not null %}
- <meta property="og:image" content="{{ entry.previewPicture }}" />
- {% else %}
- <meta property="og:image" content="{{ app.request.schemeAndHttpHost }}{{ asset('bundles/wallabagcore/themes/_global/img/logo-other_themes.png') }}" />
+ {% set picturePath = entry.previewPicture %}
{% endif %}
+ <meta property="og:image" content="{{ picturePath }}" />
+ <meta name="twitter:card" content="summary" />
+ <meta name="twitter:image" content="{{ picturePath }}" />
+ <meta name="twitter:site" content="@wallabagapp" />
+ <meta name="twitter:title" content="{{ entry.title | raw }}" />
+ <meta name="twitter:description" content="{{ entry.title | raw }}" />
</head>
<body>
<header>
-<a id="bookmarklet" ondragend="this.click();" href="javascript:var url=location.href||url;var wllbg=window.open('{{ url('bookmarklet') }}?url=' + encodeURI(url),'_blank');wllbg.close();void(0);">bag it!</a>
+<a id="bookmarklet" ondragend="this.click();" href="javascript:(function(){var url=location.href||url;var wllbg=window.open('{{ url('bookmarklet') }}?url=' + encodeURI(url),'_blank');})();">bag it!</a>
try {
$this->client->getContainer()->get('wallabag_core.redis.client')->connect();
} catch (\Exception $e) {
- $this->markTestSkipped(
- 'Redis is not installed/activated'
- );
+ $this->markTestSkipped('Redis is not installed/activated');
}
}
}
public function testImportChromeWithRedisEnabled()
{
+ $this->checkRedis();
$this->logInAs('admin');
$client = $this->getClient();
$client->getContainer()->get('craue_config')->set('import_with_redis', 1);
public function testImportFirefoxWithRedisEnabled()
{
+ $this->checkRedis();
$this->logInAs('admin');
$client = $this->getClient();
$client->getContainer()->get('craue_config')->set('import_with_redis', 1);
projects / github / wallabag / wallabag.git / commitdiff
