diff options
author | Nicolas LÅ“uillet <nicolas@loeuillet.org> | 2016-10-08 15:10:56 +0200 |
---|---|---|
committer | Nicolas LÅ“uillet <nicolas@loeuillet.org> | 2016-10-08 15:10:56 +0200 |
commit | 7eff4736a1309ad71a75fa74dc1081a3b2303169 (patch) | |
tree | f9cad7366b9d8fb394b4927a754b0acfefef7062 /docs/en/user | |
parent | 32d103f702968b494309adcba77bc6226043c6ce (diff) | |
download | wallabag-7eff4736a1309ad71a75fa74dc1081a3b2303169.tar.gz wallabag-7eff4736a1309ad71a75fa74dc1081a3b2303169.tar.zst wallabag-7eff4736a1309ad71a75fa74dc1081a3b2303169.zip |
Cleaned up documentation for installation process
Diffstat (limited to 'docs/en/user')
-rw-r--r-- | docs/en/user/android.rst | 10 | ||||
-rw-r--r-- | docs/en/user/installation.rst | 32 |
2 files changed, 20 insertions, 22 deletions
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 | ||
32 | After you have filled in your data, push the button Connection test and wait for the test to finish. | 32 | After 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 | ||
38 | The connection test shall finish with success. If not, you need to fix this first until you proceed. | 38 | The 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 | ||
68 | Finally after the syncronisation finished successfully, you are presented the list of unread articles. | 68 | Finally 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 | ||
76 | Known limitations | 76 | Known limitations |
77 | ---- | 77 | ----------------- |
78 | 78 | ||
79 | 2FA | 79 | 2FA |
80 | ~~~ | 80 | ~~~ |
@@ -85,7 +85,7 @@ Currently the does not support two-factor authentication. You should disable tha | |||
85 | Limited amount of articles with wallabag v2 | 85 | Limited amount of articles with wallabag v2 |
86 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 86 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
87 | 87 | ||
88 | 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. | 88 | 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. |
89 | 89 | ||
90 | 90 | ||
91 | SSL/TLS encryption | 91 | SSL/TLS encryption |
diff --git a/docs/en/user/installation.rst b/docs/en/user/installation.rst index 4aaabd82..a2f0d07b 100644 --- a/docs/en/user/installation.rst +++ b/docs/en/user/installation.rst | |||
@@ -6,7 +6,17 @@ Requirements | |||
6 | 6 | ||
7 | wallabag is compatible with PHP >= 5.5, including PHP 7. | 7 | wallabag is compatible with PHP >= 5.5, including PHP 7. |
8 | 8 | ||
9 | 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. | 9 | 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``). |
10 | |||
11 | Install Composer: | ||
12 | |||
13 | :: | ||
14 | |||
15 | curl -s http://getcomposer.org/installer | php | ||
16 | |||
17 | You can find specific instructions `here <https://getcomposer.org/doc/00-intro.md>`__. | ||
18 | |||
19 | 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. | ||
10 | 20 | ||
11 | - php-session | 21 | - php-session |
12 | - php-ctype | 22 | - php-ctype |
@@ -38,25 +48,13 @@ Installation | |||
38 | On a dedicated web server (recommended way) | 48 | On a dedicated web server (recommended way) |
39 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 49 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
40 | 50 | ||
41 | 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``). | ||
42 | |||
43 | Install Composer: | ||
44 | |||
45 | :: | ||
46 | |||
47 | curl -s http://getcomposer.org/installer | php | ||
48 | |||
49 | You can find specific instructions `here <https://getcomposer.org/doc/00-intro.md>`__. | ||
50 | |||
51 | To install wallabag itself, you must run the following commands: | 51 | To 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 | ||
61 | To start PHP's build-in server and test if everything did install correctly, you can do: | 59 | To 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``) | 87 | You will find the `md5 hash of the latest package on our website <https://www.wallabag.org/pages/download-wallabag.html>`_. |
90 | 88 | ||
91 | Now, read the following documentation to create your virtual host, then access your wallabag. | 89 | Now, read the following documentation to create your virtual host, then access your wallabag. |
92 | 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``. | 90 | 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``. |
93 | 91 | ||
94 | Installation with Docker | 92 | Installation with Docker |
95 | ------------------------ | 93 | ~~~~~~~~~~~~~~~~~~~~~~~~ |
96 | 94 | ||
97 | 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. | 95 | 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. |
98 | 96 | ||
99 | Command to launch container | 97 | Command to launch container |
100 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 98 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
101 | 99 | ||
102 | .. code-block:: bash | 100 | .. code-block:: bash |
103 | 101 | ||