diff options
Diffstat (limited to 'docs/en')
-rw-r--r-- | docs/en/index.rst | 1 | ||||
-rw-r--r-- | docs/en/user/installation.rst | 27 | ||||
-rw-r--r-- | docs/en/user/migration.rst | 2 | ||||
-rw-r--r-- | docs/en/user/upgrade.rst | 24 |
4 files changed, 53 insertions, 1 deletions
diff --git a/docs/en/index.rst b/docs/en/index.rst index 34ec7999..590c234a 100644 --- a/docs/en/index.rst +++ b/docs/en/index.rst | |||
@@ -26,6 +26,7 @@ The main documentation for this application is organized into a couple sections: | |||
26 | user/faq | 26 | user/faq |
27 | user/installation | 27 | user/installation |
28 | user/migration | 28 | user/migration |
29 | user/upgrade | ||
29 | user/create_account | 30 | user/create_account |
30 | user/login | 31 | user/login |
31 | user/configuration | 32 | user/configuration |
diff --git a/docs/en/user/installation.rst b/docs/en/user/installation.rst index 8250d2d7..c2174a53 100644 --- a/docs/en/user/installation.rst +++ b/docs/en/user/installation.rst | |||
@@ -154,3 +154,30 @@ After reloading or restarting nginx, you should now be able to access wallabag a | |||
154 | .. note:: | 154 | .. note:: |
155 | 155 | ||
156 | 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``. | 156 | 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``. |
157 | |||
158 | |||
159 | Rights access to the folders of the project | ||
160 | ------------------------------------------- | ||
161 | |||
162 | |||
163 | Test Environment | ||
164 | ~~~~~~~~~~~~~~~~ | ||
165 | |||
166 | 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. | ||
167 | |||
168 | |||
169 | Production Environment | ||
170 | ~~~~~~~~~~~~~~~~~~~~~~ | ||
171 | |||
172 | 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. | ||
173 | |||
174 | 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). | ||
175 | |||
176 | 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. | ||
177 | |||
178 | 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: | ||
179 | |||
180 | .. code-block:: bash | ||
181 | |||
182 | chown -R www-data:www-data /var/www/wallabag/var | ||
183 | |||
diff --git a/docs/en/user/migration.rst b/docs/en/user/migration.rst index e1fee961..e97c6315 100644 --- a/docs/en/user/migration.rst +++ b/docs/en/user/migration.rst | |||
@@ -16,7 +16,7 @@ If you were using wallabag v1.x, you need to export your data before migrating t | |||
16 | .. note:: | 16 | .. note:: |
17 | If you encounter issues during the export or the import, don't hesitate to `ask for support <https://www.wallabag.org/pages/support.html>`__. | 17 | If you encounter issues during the export or the import, don't hesitate to `ask for support <https://www.wallabag.org/pages/support.html>`__. |
18 | 18 | ||
19 | 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/v2/user/installation.html>`__. | 19 | 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>`__. |
20 | 20 | ||
21 | After creating an user account on your new wallabag v2 instance, you must head over to the `Import` section and select `Import from wallabag v1`. Select your json file and upload it. | 21 | After creating an user account on your new wallabag v2 instance, you must head over to the `Import` section and select `Import from wallabag v1`. Select your json file and upload it. |
22 | 22 | ||
diff --git a/docs/en/user/upgrade.rst b/docs/en/user/upgrade.rst new file mode 100644 index 00000000..e4735631 --- /dev/null +++ b/docs/en/user/upgrade.rst | |||
@@ -0,0 +1,24 @@ | |||
1 | Upgrade wallabag | ||
2 | ================ | ||
3 | |||
4 | Upgrade on a dedicated web server | ||
5 | --------------------------------- | ||
6 | |||
7 | 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.3`` by the last release number): | ||
8 | :: | ||
9 | |||
10 | git fetch origin | ||
11 | git fetch --tags | ||
12 | git checkout 2.0.3 | ||
13 | SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist | ||
14 | php bin/console cache:clear --env=prod | ||
15 | |||
16 | |||
17 | Upgrade on a shared hosting | ||
18 | --------------------------- | ||
19 | |||
20 | Backup your ``app/config/parameters.yml`` file. Extract the archive in your wallabag folder and replace ``app/config/parameters.yml`` with yours. | ||
21 | |||
22 | If you use SQLite, you must also copy your ``data/`` folder inside the new installation. | ||
23 | |||
24 | Empty ``var/cache`` folder. | ||