diff options
Diffstat (limited to 'docs/en')
-rw-r--r-- | docs/en/conf.py | 4 | ||||
-rw-r--r-- | docs/en/developer/console_commands.rst | 30 | ||||
-rw-r--r-- | docs/en/developer/front_end.rst | 33 | ||||
-rw-r--r-- | docs/en/user/articles.rst | 7 | ||||
-rw-r--r-- | docs/en/user/configuration.rst | 27 | ||||
-rw-r--r-- | docs/en/user/import.rst | 19 | ||||
-rw-r--r-- | docs/en/user/installation.rst | 24 | ||||
-rw-r--r-- | docs/en/user/upgrade.rst | 2 |
8 files changed, 112 insertions, 34 deletions
diff --git a/docs/en/conf.py b/docs/en/conf.py index 717b35f1..5926f8c9 100644 --- a/docs/en/conf.py +++ b/docs/en/conf.py | |||
@@ -11,8 +11,8 @@ templates_path = ['_templates'] | |||
11 | source_suffix = '.rst' | 11 | source_suffix = '.rst' |
12 | master_doc = 'index' | 12 | master_doc = 'index' |
13 | project = u'wallabag' | 13 | project = u'wallabag' |
14 | copyright = u'2013-2016, Nicolas Lœuillet - MIT Licence' | 14 | copyright = u'2013-2017, Nicolas Lœuillet - MIT Licence' |
15 | version = '2.1.0' | 15 | version = '2.3.0' |
16 | release = version | 16 | release = version |
17 | exclude_patterns = ['_build'] | 17 | exclude_patterns = ['_build'] |
18 | pygments_style = 'sphinx' | 18 | pygments_style = 'sphinx' |
diff --git a/docs/en/developer/console_commands.rst b/docs/en/developer/console_commands.rst new file mode 100644 index 00000000..85a8a092 --- /dev/null +++ b/docs/en/developer/console_commands.rst | |||
@@ -0,0 +1,30 @@ | |||
1 | Console Commands | ||
2 | ================ | ||
3 | |||
4 | wallabag has a number of CLI commands to manage a number of tasks. You can list all the commands by executing `bin/console` in the wallabag folder. | ||
5 | |||
6 | Each command has a help accessible through `bin/console help %command%`. | ||
7 | |||
8 | .. note:: | ||
9 | |||
10 | If you're in a production environment, remember to add `-e prod` to each command. | ||
11 | |||
12 | Notable commands | ||
13 | ---------------- | ||
14 | |||
15 | * `assets:install`: May be helpful if assets are missing. | ||
16 | * `cache:clear`: should be run after each update (included in `make update`). | ||
17 | * `doctrine:migrations:status`: Output the status of your database migrations. | ||
18 | * `fos:user:activate`: Manually activate an user. | ||
19 | * `fos:user:change-password`: Change a password for an user. | ||
20 | * `fos:user:create`: Create an user. | ||
21 | * `fos:user:deactivate`: Deactivate an user (not deleted). | ||
22 | * `fos:user:demote`: Removes a role from an user, typically admin rights. | ||
23 | * `fos:user:promote`: Adds a role to an user, typically admin rights. | ||
24 | * `rabbitmq:*`: May be useful if you're using RabbitMQ. | ||
25 | * `wallabag:clean-duplicates`: Removes all entry duplicates for one user or all users | ||
26 | * `wallabag:export`: Exports all entries for an user. You can choose the output path of the file. | ||
27 | * `wallabag:import`: Import entries to different formats to an user account. | ||
28 | * `wallabag:import:redis-worker`: Useful if you use Redis. | ||
29 | * `wallabag:install`: (re)Install wallabag | ||
30 | * `wallabag:tag:all`: Tag all entries for an user using his/her tagging rules. | ||
diff --git a/docs/en/developer/front_end.rst b/docs/en/developer/front_end.rst new file mode 100644 index 00000000..40f18a42 --- /dev/null +++ b/docs/en/developer/front_end.rst | |||
@@ -0,0 +1,33 @@ | |||
1 | Tips for front-end developers | ||
2 | ============================= | ||
3 | |||
4 | Starting from version 2.3, wallabag uses webpack to bundle its assets. | ||
5 | |||
6 | Dev mode | ||
7 | -------- | ||
8 | |||
9 | If the server runs in dev mode, you need to run ``yarn run build:dev`` to generate the outputted javascript files for each theme. These are named ``%theme%.dev.js`` and are ignored by git. You need to relaunch ``yarn run build:dev`` for each change made to one of the assets files (js, css, pictures, fonts,...). | ||
10 | |||
11 | Live reload | ||
12 | ----------- | ||
13 | |||
14 | Webpack brings support for live reload, which means you don't need to regenerate the assets file for each change neither reload the page manually. Changes are applied automatically in the web page. Just set the ``use_webpack_dev_server`` setting to ``true`` in ``app/config/config.yml`` and run ``yarn run watch`` and you're good to go. | ||
15 | |||
16 | .. note:: | ||
17 | |||
18 | Don't forget to put back ``use_webpack_dev_server`` to ``false`` when not using the live reload feature. | ||
19 | |||
20 | Production builds | ||
21 | ----------------- | ||
22 | |||
23 | When you want to commit your changes, build them in production environment by using ``yarn run build:prod``. This will build all the assets needed for wallabag. To test that it properly works, you'll need to have a server in production mode, for instance with ``bin/console server:run -e=prod``. | ||
24 | |||
25 | .. note:: | ||
26 | |||
27 | Don't forget to generate production builds before committing ! | ||
28 | |||
29 | |||
30 | Code style | ||
31 | ---------- | ||
32 | |||
33 | Code style is checked by two tools : stylelint for (S)CSS and eslint for JS. ESlint config is based on the Airbnb base preset. | ||
diff --git a/docs/en/user/articles.rst b/docs/en/user/articles.rst index 16b3b0d2..862bba3e 100644 --- a/docs/en/user/articles.rst +++ b/docs/en/user/articles.rst | |||
@@ -34,20 +34,20 @@ By using a browser add-on | |||
34 | Firefox | 34 | Firefox |
35 | """"""" | 35 | """"""" |
36 | 36 | ||
37 | You can download the `Firefox addon here <https://addons.mozilla.org/firefox/addon/wallabag-v2/>`_. | 37 | You can download the `Firefox addon here <https://addons.mozilla.org/firefox/addon/wallabagger/>`_. |
38 | 38 | ||
39 | Chrome | 39 | Chrome |
40 | """""" | 40 | """""" |
41 | 41 | ||
42 | You can download the `Chrome addon here <https://chrome.google.com/webstore/detail/wallabagger/gbmgphmejlcoihgedabhgjdkcahacjlj?hl=fr>`_. | 42 | You can download the `Chrome addon here <https://chrome.google.com/webstore/detail/wallabagger/gbmgphmejlcoihgedabhgjdkcahacjlj?hl=fr>`_. |
43 | 43 | ||
44 | By using your smarphone application | 44 | By using your smartphone application |
45 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | 45 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
46 | 46 | ||
47 | Android | 47 | Android |
48 | """"""" | 48 | """"""" |
49 | 49 | ||
50 | You can download the `Android application here <https://play.google.com/store/apps/details?id=fr.gaulupeau.apps.InThePoche>`_. | 50 | You can download the `Android application here <https://play.google.com/store/apps/details?id=fr.gaulupeau.apps.InThePoche>`_ or on `F-Droid <https://f-droid.org/repository/browse/?fdid=fr.gaulupeau.apps.InThePoche>`_. |
51 | 51 | ||
52 | Windows Phone | 52 | Windows Phone |
53 | """"""""""""" | 53 | """"""""""""" |
@@ -86,6 +86,7 @@ Now, you can share the article: | |||
86 | - with a public URL (you'll have a light view of the article) | 86 | - with a public URL (you'll have a light view of the article) |
87 | - with a tweet | 87 | - with a tweet |
88 | - into your Shaarli | 88 | - into your Shaarli |
89 | - into your Scuttle | ||
89 | - with a post in Diaspora* | 90 | - with a post in Diaspora* |
90 | - to Carrot | 91 | - to Carrot |
91 | - with an email | 92 | - with an email |
diff --git a/docs/en/user/configuration.rst b/docs/en/user/configuration.rst index bba12cb9..0f3ac38f 100644 --- a/docs/en/user/configuration.rst +++ b/docs/en/user/configuration.rst | |||
@@ -116,16 +116,17 @@ Which variables and operators can I use to write rules? | |||
116 | 116 | ||
117 | 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"``): | 117 | 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"``): |
118 | 118 | ||
119 | =========== ============================================== ======== ========== | 119 | =========== ============================================== ========== ========== |
120 | Variable Meaning Operator Meaning | 120 | Variable Meaning Operator Meaning |
121 | ----------- ---------------------------------------------- -------- ---------- | 121 | ----------- ---------------------------------------------- ---------- ---------- |
122 | title Title of the entry <= Less than… | 122 | title Title of the entry <= Less than… |
123 | url URL of the entry < Strictly less than… | 123 | url URL of the entry < Strictly less than… |
124 | isArchived Whether the entry is archived or not => Greater than… | 124 | isArchived Whether the entry is archived or not => Greater than… |
125 | isStarred Whether the entry is starred or not > Strictly greater than… | 125 | isStarred Whether the entry is starred or not > Strictly greater than… |
126 | content The entry's content = Equal to… | 126 | content The entry's content = Equal to… |
127 | language The entry's language != Not equal to… | 127 | language The entry's language != Not equal to… |
128 | mimetype The entry's mime-type OR One rule or another | 128 | mimetype The entry's mime-type OR One rule or another |
129 | readingTime The estimated entry's reading time, in minutes AND One rule and another | 129 | readingTime The estimated entry's reading time, in minutes AND One rule and another |
130 | domainName The domain name of the entry matches Tests that a subject is matches a search (case-insensitive). Example: title matches "football" | 130 | domainName The domain name of the entry matches Tests that a subject is matches a search (case-insensitive). Example: title matches "football" |
131 | =========== ============================================== ======== ========== | 131 | notmatches Tests that a subject is not matches a search (case-insensitive). Example: title notmatches "football" |
132 | =========== ============================================== ========== ========== | ||
diff --git a/docs/en/user/import.rst b/docs/en/user/import.rst index f420a131..f6aaa373 100644 --- a/docs/en/user/import.rst +++ b/docs/en/user/import.rst | |||
@@ -77,7 +77,7 @@ From Instapaper | |||
77 | --------------- | 77 | --------------- |
78 | 78 | ||
79 | Export your Instapaper data | 79 | Export your Instapaper data |
80 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 80 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
81 | 81 | ||
82 | 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``). | 82 | 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``). |
83 | 83 | ||
@@ -102,7 +102,7 @@ If you were using wallabag v1.x, you need to export your data before migrating t | |||
102 | If you have multiple accounts on the same instance of wallabag, each user must export from v1 and import into v2 its data. | 102 | If you have multiple accounts on the same instance of wallabag, each user must export from v1 and import into v2 its data. |
103 | 103 | ||
104 | .. note:: | 104 | .. note:: |
105 | If you encounter issues during the export or the import, don't hesitate to `ask for support <https://www.wallabag.org/pages/support.html>`__. | 105 | If you encounter issues during the export or the import, don't hesitate to `ask for support <https://gitter.im/wallabag/wallabag>`__. |
106 | 106 | ||
107 | When you have retrieved the json file containing your entries, you can install wallabag v2 if needed by following `the standard procedure <http://doc.wallabag.org/en/master/user/installation.html>`__. | 107 | When you have retrieved the json file containing your entries, you can install wallabag v2 if needed by following `the standard procedure <http://doc.wallabag.org/en/master/user/installation.html>`__. |
108 | 108 | ||
@@ -124,7 +124,7 @@ From the previous wallabag instance on which you were before, go to `All article | |||
124 | From your new wallabag instance, create your user account and click on the link in the menu to proceed to import. Choose import from wallabag v2 and select your json file to upload it. | 124 | From your new wallabag instance, create your user account and click on the link in the menu to proceed to import. Choose import from wallabag v2 and select your json file to upload it. |
125 | 125 | ||
126 | .. note:: | 126 | .. note:: |
127 | If you encounter issues during the export or the import, don't hesitate to `ask for support <https://www.wallabag.org/pages/support.html>`__. | 127 | If you encounter issues during the export or the import, don't hesitate to `ask for support <https://gitter.im/wallabag/wallabag>`__. |
128 | 128 | ||
129 | Import via command-line interface (CLI) | 129 | Import via command-line interface (CLI) |
130 | --------------------------------------- | 130 | --------------------------------------- |
@@ -133,16 +133,21 @@ If you have a CLI access on your web server, you can execute this command to imp | |||
133 | 133 | ||
134 | :: | 134 | :: |
135 | 135 | ||
136 | bin/console wallabag:import 1 ~/Downloads/wallabag-export-1-2016-04-05.json --env=prod | 136 | bin/console wallabag:import username ~/Downloads/wallabag-export-1-2016-04-05.json --env=prod |
137 | 137 | ||
138 | Please replace values: | 138 | Please replace values: |
139 | 139 | ||
140 | * ``1`` is the user identifier in database (The ID of the first user created on wallabag is 1) | 140 | * ``username`` is the user's username |
141 | * ``~/Downloads/wallabag-export-1-2016-04-05.json`` is the path of your wallabag v1 export | 141 | * ``~/Downloads/wallabag-export-1-2016-04-05.json`` is the path of your wallabag v1 export |
142 | 142 | ||
143 | If you want to mark all these entries as read, you can add the ``--markAsRead`` option. | 143 | .. note:: |
144 | If you want to mark all these entries as read, you can add the ``--markAsRead`` option. | ||
144 | 145 | ||
145 | To import a wallabag v2 file, you need to add the option ``--importer=v2``. | 146 | .. note:: |
147 | To import a wallabag v2 file, you need to add the option ``--importer=v2``. | ||
148 | |||
149 | .. note:: | ||
150 | If you want to pass the user id of the user instead of it's username, add the option ``--useUserId=true``. | ||
146 | 151 | ||
147 | You'll have this in return: | 152 | You'll have this in return: |
148 | 153 | ||
diff --git a/docs/en/user/installation.rst b/docs/en/user/installation.rst index 2b730b83..f1146b49 100644 --- a/docs/en/user/installation.rst +++ b/docs/en/user/installation.rst | |||
@@ -4,7 +4,7 @@ Install wallabag | |||
4 | Requirements | 4 | Requirements |
5 | ------------ | 5 | ------------ |
6 | 6 | ||
7 | wallabag is compatible with PHP >= 5.5, including PHP 7. | 7 | wallabag is compatible with **PHP >= 5.6**, including PHP 7. |
8 | 8 | ||
9 | .. note:: | 9 | .. note:: |
10 | 10 | ||
@@ -87,7 +87,7 @@ Execute this command to download and extract the latest package: | |||
87 | 87 | ||
88 | wget https://wllbg.org/latest-v2-package && tar xvf latest-v2-package | 88 | wget https://wllbg.org/latest-v2-package && tar xvf latest-v2-package |
89 | 89 | ||
90 | You will find the `md5 hash of the latest package on our website <https://www.wallabag.org/pages/download-wallabag.html>`_. | 90 | You will find the `md5 hash of the latest package on our website <https://static.wallabag.org/releases/>`_. |
91 | 91 | ||
92 | Now, read the following documentation to create your virtual host, then access your wallabag. | 92 | Now, read the following documentation to create your virtual host, then access your wallabag. |
93 | 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 | 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``. |
@@ -104,6 +104,14 @@ Command to launch container | |||
104 | 104 | ||
105 | docker pull wallabag/wallabag | 105 | docker pull wallabag/wallabag |
106 | 106 | ||
107 | Installation on Cloudron | ||
108 | ~~~~~~~~~~~~~~~~~~~~~~~~ | ||
109 | |||
110 | Cloudron provides an easy way to install webapps on your server with a focus on sysadmin automation and keeping apps updated. | ||
111 | wallabag is packaged as a Cloudron app and available to install directly from the store. | ||
112 | |||
113 | `Install wallabag on your Cloudron <https://cloudron.io/store/org.wallabag.cloudronapp.html>`__ | ||
114 | |||
107 | Virtual hosts | 115 | Virtual hosts |
108 | ------------- | 116 | ------------- |
109 | 117 | ||
@@ -155,9 +163,9 @@ Assuming you install wallabag in the ``/var/www/wallabag`` folder and that you w | |||
155 | ErrorLog /var/log/apache2/wallabag_error.log | 163 | ErrorLog /var/log/apache2/wallabag_error.log |
156 | CustomLog /var/log/apache2/wallabag_access.log combined | 164 | CustomLog /var/log/apache2/wallabag_access.log combined |
157 | </VirtualHost> | 165 | </VirtualHost> |
158 | 166 | ||
159 | 167 | ||
160 | .. tip:: Note for Apache 2.4, in the section `<Directory /var/www/wallabag/web>` you have to replace the directives : | 168 | .. tip:: Note for Apache 2.4, in the section `<Directory /var/www/wallabag/web>` you have to replace the directives : |
161 | 169 | ||
162 | :: | 170 | :: |
163 | 171 | ||
@@ -166,12 +174,12 @@ Assuming you install wallabag in the ``/var/www/wallabag`` folder and that you w | |||
166 | Allow from All | 174 | Allow from All |
167 | 175 | ||
168 | 176 | ||
169 | by | 177 | by |
170 | 178 | ||
171 | :: | 179 | :: |
172 | 180 | ||
173 | Require All granted | 181 | Require All granted |
174 | 182 | ||
175 | 183 | ||
176 | After reloading or restarting Apache, you should now be able to access wallabag at http://domain.tld. | 184 | After reloading or restarting Apache, you should now be able to access wallabag at http://domain.tld. |
177 | 185 | ||
diff --git a/docs/en/user/upgrade.rst b/docs/en/user/upgrade.rst index 46b490c3..3157684c 100644 --- a/docs/en/user/upgrade.rst +++ b/docs/en/user/upgrade.rst | |||
@@ -67,7 +67,7 @@ Download the last release of wallabag: | |||
67 | 67 | ||
68 | wget https://wllbg.org/latest-v2-package && tar xvf latest-v2-package | 68 | wget https://wllbg.org/latest-v2-package && tar xvf latest-v2-package |
69 | 69 | ||
70 | You will find the `md5 hash of the latest package on our website <https://www.wallabag.org/pages/download-wallabag.html>`_. | 70 | You will find the `md5 hash of the latest package on our website <https://static.wallabag.org/releases/>`_. |
71 | 71 | ||
72 | Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours. | 72 | Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours. |
73 | 73 | ||