aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/de/user/installation.rst34
-rw-r--r--docs/en/user/android.rst10
-rw-r--r--docs/en/user/installation.rst32
-rw-r--r--docs/fr/user/installation.rst30
4 files changed, 50 insertions, 56 deletions
diff --git a/docs/de/user/installation.rst b/docs/de/user/installation.rst
index 3578dca9..263d53c0 100644
--- a/docs/de/user/installation.rst
+++ b/docs/de/user/installation.rst
@@ -6,6 +6,16 @@ Voraussetzungen
6 6
7wallabag ist kompatibel mit PHP >= 5.5, inkl. PHP 7. 7wallabag ist kompatibel mit PHP >= 5.5, inkl. PHP 7.
8 8
9wallabag 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.
10
11Composer installieren:
12
13::
14
15 curl -s http://getcomposer.org/installer | php
16
17Du kannst eine spezifische Anleitung `hier <https://getcomposer.org/doc/00-intro.md>`__ finden.
18
9Du benötigst die folgenden Extensions damit wallabag funktioniert. Einige von diesen sind vielleicht schon in deiner Version von PHP aktiviert, somit musst du eventuell 19Du benötigst die folgenden Extensions damit wallabag funktioniert. Einige von diesen sind vielleicht schon in deiner Version von PHP aktiviert, somit musst du eventuell
10nicht alle folgenden Pakete installieren. 20nicht alle folgenden Pakete installieren.
11 21
@@ -39,25 +49,13 @@ Installation
39Auf einem dedizierten Webserver (empfohlener Weg) 49Auf einem dedizierten Webserver (empfohlener Weg)
40~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 50~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
41 51
42wallabag 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.
43
44Composer installieren:
45
46::
47
48 curl -s http://getcomposer.org/installer | php
49
50Du kannst eine spezifische Anleitung `hier <https://getcomposer.org/doc/00-intro.md>`__ finden.
51
52Um wallabag selbst zu installieren, musst du die folgenden Kommandos ausführen: 52Um wallabag selbst zu installieren, musst du die folgenden Kommandos ausführen:
53 53
54:: 54::
55 55
56 git clone https://github.com/wallabag/wallabag.git 56 git clone https://github.com/wallabag/wallabag.git
57 cd wallabag 57 cd wallabag
58 git checkout 2.1.1 --force 58 ./install.sh
59 SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist
60 php bin/console wallabag:install --env=prod
61 59
62Um PHPs eingebauten Server zu starten und zu testen, ob alles korrekt installiert wurde, kannst du folgendes Kommando ausführen: 60Um PHPs eingebauten Server zu starten und zu testen, ob alles korrekt installiert wurde, kannst du folgendes Kommando ausführen:
63 61
@@ -87,18 +85,18 @@ Führe dieses Kommando aus, um das neueste Paket herunterzuladen und zu entpacke
87 85
88 wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package 86 wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package
89 87
90(md5 hash: ``6c33520e29cc754b687f9cee0398dede``) 88You will find the `md5 hash of the latest package on our website <https://www.wallabag.org/pages/download-wallabag.html>`_.
91 89
92Jetzt lese die Dokumentation, um einen Virtualhost zu erstellen, dann greife auf dein wallabag zu. 90Jetzt lese die Dokumentation, um einen Virtualhost zu erstellen, dann greife auf dein wallabag zu.
93Wenn 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``. 91Wenn 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``.
94 92
95Installation mit Docker 93Installation mit Docker
96------------------------ 94~~~~~~~~~~~~~~~~~~~~~~
97 95
98Wir 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. 96Wir 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.
99 97
100Kommando, um den Container zu starten 98Kommando, um den Container zu starten
101~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 99^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
102 100
103.. code-block:: bash 101.. code-block:: bash
104 102
@@ -108,7 +106,7 @@ Virtualhosts
108------------ 106------------
109 107
110Konfiguration von Apache 108Konfiguration von Apache
111~~~~~~~~~~~~~~~~~~~~~~~ 109~~~~~~~~~~~~~~~~~~~~~~~~
112 110
113Angenommen 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: 111Angenommen 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:
114 112
@@ -198,7 +196,7 @@ Nach dem neuladen oder neustarten von nginx, solltest du nun wallabag unter http
198 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``. 196 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``.
199 197
200Konfiguration von lighttpd 198Konfiguration von lighttpd
201~~~~~~~~~~~~~~~~~~~~~~~~~ 199~~~~~~~~~~~~~~~~~~~~~~~~~~
202 200
203Angenommen 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): 201Angenommen 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):
204 202
diff --git a/docs/en/user/android.rst b/docs/en/user/android.rst
index 4271f037..eec130f6 100644
--- a/docs/en/user/android.rst
+++ b/docs/en/user/android.rst
@@ -29,13 +29,13 @@ Fill in your wallabag data. You need to enter your wallabag address. It is impor
29 :alt: Filled in settings 29 :alt: Filled in settings
30 :align: center 30 :align: center
31 31
32After you have filled in your data, push the button Connection test and wait for the test to finish. 32After you have filled in your data, push the button Connection test and wait for the test to finish.
33 33
34.. image:: ../../img/user/android_configuration_connection_test.en.png 34.. image:: ../../img/user/android_configuration_connection_test.en.png
35 :alt: Connection test with your wallabag data 35 :alt: Connection test with your wallabag data
36 :align: center 36 :align: center
37 37
38The connection test shall finish with success. If not, you need to fix this first until you proceed. 38The connection test shall finish with success. If not, you need to fix this first until you proceed.
39 39
40.. image:: ../../img/user/android_configuration_connection_test_success.en.png 40.. image:: ../../img/user/android_configuration_connection_test_success.en.png
41 :alt: Connection test successful 41 :alt: Connection test successful
@@ -65,7 +65,7 @@ After hitting the save button, you get the following screen. The app proposes to
65 :alt: Settings saved the first time 65 :alt: Settings saved the first time
66 :align: center 66 :align: center
67 67
68Finally after the syncronisation finished successfully, you are presented the list of unread articles. 68Finally after the syncronisation finished successfully, you are presented the list of unread articles.
69 69
70.. image:: ../../img/user/android_unread_feed_synced.en.png 70.. image:: ../../img/user/android_unread_feed_synced.en.png
71 :alt: Filled article list cause feeds successfully syncronized 71 :alt: Filled article list cause feeds successfully syncronized
@@ -74,7 +74,7 @@ Finally after the syncronisation finished successfully, you are presented the li
74 74
75 75
76Known limitations 76Known limitations
77---- 77-----------------
78 78
792FA 792FA
80~~~ 80~~~
@@ -85,7 +85,7 @@ Currently the does not support two-factor authentication. You should disable tha
85Limited amount of articles with wallabag v2 85Limited amount of articles with wallabag v2
86~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 86~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
87 87
88In 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. 88In 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.
89 89
90 90
91SSL/TLS encryption 91SSL/TLS encryption
diff --git a/docs/en/user/installation.rst b/docs/en/user/installation.rst
index 4aaabd82..a2f0d07b 100644
--- a/docs/en/user/installation.rst
+++ b/docs/en/user/installation.rst
@@ -6,7 +6,17 @@ Requirements
6 6
7wallabag is compatible with PHP >= 5.5, including PHP 7. 7wallabag is compatible with PHP >= 5.5, including PHP 7.
8 8
9You'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. 9wallabag 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``).
10
11Install Composer:
12
13::
14
15 curl -s http://getcomposer.org/installer | php
16
17You can find specific instructions `here <https://getcomposer.org/doc/00-intro.md>`__.
18
19You'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.
10 20
11- php-session 21- php-session
12- php-ctype 22- php-ctype
@@ -38,25 +48,13 @@ Installation
38On a dedicated web server (recommended way) 48On a dedicated web server (recommended way)
39~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 49~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
40 50
41wallabag 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``).
42
43Install Composer:
44
45::
46
47 curl -s http://getcomposer.org/installer | php
48
49You can find specific instructions `here <https://getcomposer.org/doc/00-intro.md>`__.
50
51To install wallabag itself, you must run the following commands: 51To install wallabag itself, you must run the following commands:
52 52
53:: 53::
54 54
55 git clone https://github.com/wallabag/wallabag.git 55 git clone https://github.com/wallabag/wallabag.git
56 cd wallabag 56 cd wallabag
57 git checkout 2.1.1 --force 57 ./install.sh
58 SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist
59 php bin/console wallabag:install --env=prod
60 58
61To start PHP's build-in server and test if everything did install correctly, you can do: 59To start PHP's build-in server and test if everything did install correctly, you can do:
62 60
@@ -86,18 +84,18 @@ Execute this command to download and extract the latest package:
86 84
87 wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package 85 wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package
88 86
89(md5 hash of the 2.1.1 package: ``9584a3b60a2b2a4de87f536548caac93``) 87You will find the `md5 hash of the latest package on our website <https://www.wallabag.org/pages/download-wallabag.html>`_.
90 88
91Now, read the following documentation to create your virtual host, then access your wallabag. 89Now, read the following documentation to create your virtual host, then access your wallabag.
92If 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``. 90If 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``.
93 91
94Installation with Docker 92Installation with Docker
95------------------------ 93~~~~~~~~~~~~~~~~~~~~~~~~
96 94
97We 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. 95We 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.
98 96
99Command to launch container 97Command to launch container
100~~~~~~~~~~~~~~~~~~~~~~~~~~~ 98^^^^^^^^^^^^^^^^^^^^^^^^^^^
101 99
102.. code-block:: bash 100.. code-block:: bash
103 101
diff --git a/docs/fr/user/installation.rst b/docs/fr/user/installation.rst
index 9dd39af7..b47813be 100644
--- a/docs/fr/user/installation.rst
+++ b/docs/fr/user/installation.rst
@@ -6,6 +6,16 @@ Pré-requis
6 6
7wallabag est compatible avec PHP >= 5.5, PHP 7 inclus. 7wallabag est compatible avec PHP >= 5.5, PHP 7 inclus.
8 8
9wallabag 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``).
10
11Installation de Composer :
12
13::
14
15 curl -s http://getcomposer.org/installer | php
16
17Vous pouvez trouver des instructions spécifiques `ici (en anglais) <https://getcomposer.org/doc/00-intro.md>`__.
18
9Vous 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. 19Vous 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.
10 20
11- php-session 21- php-session
@@ -36,25 +46,13 @@ Installation
36Sur un serveur dédié (méthode conseillée) 46Sur un serveur dédié (méthode conseillée)
37~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 47~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
38 48
39wallabag 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``).
40
41Installation de Composer :
42
43::
44
45 curl -s http://getcomposer.org/installer | php
46
47Vous pouvez trouver des instructions spécifiques `ici (en anglais) <https://getcomposer.org/doc/00-intro.md>`__.
48
49Pour installer wallabag, vous devez exécuter ces commandes : 49Pour installer wallabag, vous devez exécuter ces commandes :
50 50
51:: 51::
52 52
53 git clone https://github.com/wallabag/wallabag.git 53 git clone https://github.com/wallabag/wallabag.git
54 cd wallabag 54 cd wallabag
55 git checkout 2.1.1 --force 55 ./install.sh
56 SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist
57 php bin/console wallabag:install --env=prod
58 56
59Pour démarrer le serveur interne à php et vérifier que tout s'est installé correctement, vous pouvez exécuter : 57Pour démarrer le serveur interne à php et vérifier que tout s'est installé correctement, vous pouvez exécuter :
60 58
@@ -83,18 +81,18 @@ Exécutez cette commande pour télécharger et décompresser l'archive :
83 81
84 wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package 82 wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package
85 83
86(hash md5 de l'archive 2.1.1 : ``9584a3b60a2b2a4de87f536548caac93``) 84Vous trouverez `le hash md5 du dernier package sur notre site <https://www.wallabag.org/pages/download-wallabag.html>`_.
87 85
88Maintenant, lisez la documentation ci-dessous pour crééer un virtual host. Accédez ensuite à votre installation de wallabag. 86Maintenant, lisez la documentation ci-dessous pour crééer un virtual host. Accédez ensuite à votre installation de wallabag.
89Si 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``. 87Si 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``.
90 88
91Installation avec Docker 89Installation avec Docker
92------------------------ 90~~~~~~~~~~~~~~~~~~~~~~~~
93 91
94Nous 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. 92Nous 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.
95 93
96Commande pour démarrer le containeur 94Commande pour démarrer le containeur
97~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 95^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
98 96
99.. code-block:: bash 97.. code-block:: bash
100 98