--- /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,
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``.
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):
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 Redos 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``.
: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
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 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
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.
Command to launch container
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code-block:: bash
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).
--- /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 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"
-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.
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
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``.
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
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
+#! /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
projects / github / wallabag / wallabag.git / commitdiff
