From 5ecdfcd041767c9e3244a92bb0a6cc3c3f80fea3 Mon Sep 17 00:00:00 2001 From: Thomas Citharel Date: Tue, 8 Mar 2016 17:02:34 +0100 Subject: manage assets through npm first draft remote assetic totally work nearly there use at least nodejs > 0.12 use proper version of grunt bump nodejs version for travis update npm workaround for materialize install node 5.0 add grunt-cli baggy theme & cache node modules cache bower & npm make travis build assets on php7 only exclude installing node & npm if not needed & use bash clean & try to make icomoon work on baggy ready config for travis rebase make travis work more travis work impove travis & update deps add missing pixrem deps add module through oddly lost ui updates install latest nodejs add install_dev.sh, link local binaries for npm/bower/grunt ui improvements (mostly baggy) fix travis build no need to install on travis Add unread filter to entries pages Add the ability to filter for unread pages in the filters menu. Add unread filter test to EntryControllerTest Add a new test to the EntryControllerTest collection which checks that only entries which have not been archived (and are treated as "unread") are retrieved. Improve English translation Update FAQ -Fix grammar -Add notes about MTA, firewall, and SELinux Update installation instructions -Fix grammar -Add SELinux section add screenshots of android docu in English Fix the deletion of Tags/Entries relation when delete an entry Fix #2121 Move fixtures to the right place Display a message when saving an entry failed When saving an entry fail because of database error we previously just returned `false`. Now we got an error in the log and the displayed notice to the user is updated too. Change ManyToMany between entry & tag Following https://gist.github.com/Ocramius/3121916 Be sure to remove the related entity when removing an entity. Let say you have Entry -> EntryTag -> Tag. If you remove the entry: - before that commit, the EntryTag will stay (at least using SQLite). - with that commit, the related entity is removed Prepare wallabag 2.0.5 enforce older materialize version --- docs/en/user/android.rst | 20 ++++++------- docs/en/user/faq.rst | 29 +++++++++++++----- docs/en/user/installation.rst | 70 +++++++++++++++++++++++++++++++++++-------- 3 files changed, 89 insertions(+), 30 deletions(-) (limited to 'docs/en') diff --git a/docs/en/user/android.rst b/docs/en/user/android.rst index c13cf031..4271f037 100644 --- a/docs/en/user/android.rst +++ b/docs/en/user/android.rst @@ -13,61 +13,61 @@ Steps to configure your app When you first start the app, you see the welcome screen, where you are adviced to configure the app for your wallabag instance at first. -.. image:: ../../img/user/android_welcome_screen.de.png +.. image:: ../../img/user/android_welcome_screen.en.png :alt: Welcome screen :align: center Just confirm that message and you get redirected to the settings screen. -.. image:: ../../img/user/android_configuration_screen.de.png +.. image:: ../../img/user/android_configuration_screen.en.png :alt: Settings screen :align: center Fill in your wallabag data. You need to enter your wallabag address. It is important that this URL does not end with a slash. Also add your wallabag credentials to the user name and password field. -.. image:: ../../img/user/android_configuration_filled_in.de.png +.. image:: ../../img/user/android_configuration_filled_in.en.png :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. -.. image:: ../../img/user/android_configuration_connection_test.de.png +.. 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. -.. image:: ../../img/user/android_configuration_connection_test_success.de.png +.. image:: ../../img/user/android_configuration_connection_test_success.en.png :alt: Connection test successful :align: center After the connection test was successful, you can push the button to get your feed credentials. The app now tries to login to your wallabag instance and get the user id and the corresponding token for the feeds. -.. image:: ../../img/user/android_configuration_get_feed_credentials.de.png +.. image:: ../../img/user/android_configuration_get_feed_credentials.en.png :alt: Getting the feed credentials :align: center When the process of getting your feed credentials finishes with success you see a toast message that the user id and the token were automatically filled in to the form. -.. image:: ../../img/user/android_configuration_feed_credentials_automatically_filled_in.de.png +.. image:: ../../img/user/android_configuration_feed_credentials_automatically_filled_in.en.png :alt: Getting feed credentials successful :align: center Now you need to scroll to the bottom of the settings menu. Of course you can adjust the given settings to your needs. Finish the configuration of your app with pushing the save button. -.. image:: ../../img/user/android_configuration_scroll_bottom.de.png +.. image:: ../../img/user/android_configuration_scroll_bottom.en.png :alt: Bottom of the settings screen :align: center After hitting the save button, you get the following screen. The app proposes to initiate a syncronisation process to update your feeds of articles. It is recommended to acknowledge this action and press Yes. -.. image:: ../../img/user/android_configuration_saved_feed_update.de.png +.. image:: ../../img/user/android_configuration_saved_feed_update.en.png :alt: Settings saved the first time :align: center Finally after the syncronisation finished successfully, you are presented the list of unread articles. -.. image:: ../../img/user/android_unread_feed_synced.de.png +.. image:: ../../img/user/android_unread_feed_synced.en.png :alt: Filled article list cause feeds successfully syncronized :align: center diff --git a/docs/en/user/faq.rst b/docs/en/user/faq.rst index 1e36dc26..61303604 100644 --- a/docs/en/user/faq.rst +++ b/docs/en/user/faq.rst @@ -1,26 +1,39 @@ Frequently Asked Questions ========================== -During the installation, I've got this error ``Error Output: sh: 1: @post-cmd: not found`` ------------------------------------------------------------------------------------------- +During the installation, I got the error ``Error Output: sh: 1: @post-cmd: not found`` +-------------------------------------------------------------------------------------- It seems you have a problem with your ``composer`` installation. Try to uninstall and reinstall it. `Read the documentation about composer to know how to install it `__. -I can't valid the registration form ------------------------------------ +I can't validate the registration form +-------------------------------------- -Make sure that all fields are well filled: +Ensure that all fields are properly filled: * valid email address * same passwords in two fields -I don't receive my activation email ------------------------------------ +I'm not receiving my activation email +------------------------------------- -Are you sure your email address was correct? Did you check your spams folder? +Are you sure your email address was correct? Did you check your spam folder? + +If you still don't see the activation email, please ensure that you have +installed and properly configured a mail transfer agent. Be sure to include a +firewall rule for SMTP. E.g., if using firewalld: + +:: + + firewall-cmd --permanent --add-service=smtp + firewall-cmd --reload + +Lastly, if you have SELinux enabled, set the following rule: + +``setsebool -P httpd_can_sendmail 1`` When I click on the activation link, I've got this message: ``The user with confirmation token "DtrOPfbQeVkWf6N" does not exist``. ---------------------------------------------------------------------------------------------------------------------------------- diff --git a/docs/en/user/installation.rst b/docs/en/user/installation.rst index 6d804304..2c6a2f5f 100644 --- a/docs/en/user/installation.rst +++ b/docs/en/user/installation.rst @@ -23,13 +23,13 @@ You'll need the following extensions for wallabag to work. Some of these may alr - php-gettext - php-tokenizer -wallabag uses PDO to connect to database, so you'll need one of: +wallabag uses PDO to connect to the database, so you'll need one of the following: - pdo_mysql - pdo_sqlite - pdo_pgsql -and it's corresponding database server. +and its corresponding database server. Installation ------------ @@ -37,7 +37,7 @@ Installation On a dedicated web server (recommended way) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -wallabag uses a big number of libraries in order to function. These libraries must be installed with a tool called Composer. You need to install it if you don't already have. +wallabag uses a large number of 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. Install Composer: @@ -47,13 +47,13 @@ Install Composer: You can find specific instructions `here `__: -To install wallabag itself, you must run these two commands: +To install wallabag itself, you must run the following commands: :: git clone https://github.com/wallabag/wallabag.git cd wallabag - git checkout 2.0.4 + git checkout 2.0.5 SYMFONY_ENV=prod composer install --no-dev -o --prefer-dist php bin/console wallabag:install --env=prod @@ -67,17 +67,17 @@ And access wallabag at http://yourserverip:8000 .. tip:: - To define parameters with environment variables, you have to set these variables with ``SYMFONY__`` prefix. For example, ``SYMFONY__DATABASE_DRIVER``. You can have a look to the `Symfony documentation `__. + To define parameters with environment variables, you have to set these variables with ``SYMFONY__`` prefix. For example, ``SYMFONY__DATABASE_DRIVER``. You can have a look at `Symfony documentation `__. On a shared hosting ~~~~~~~~~~~~~~~~~~~ -We provide you a package with all dependancies inside. +We provide a package with all dependencies inside. The default configuration uses SQLite for the database. If you want to change these settings, please edit ``app/config/parameters.yml``. We already created a user: login and password are ``wallabag``. -.. caution:: With this package, wallabag don't check mandatory extensions used in the application (theses checks are made during ``composer install`` when you have a dedicated web server, see above). +.. caution:: With this package, wallabag doesn't check for mandatory extensions used in the application (theses checks are made during ``composer install`` when you have a dedicated web server, see above). Execute this command to download and extract the latest package: @@ -85,7 +85,7 @@ Execute this command to download and extract the latest package: wget http://wllbg.org/latest-v2-package && tar xvf latest-v2-package -Now, read the following documentation to create your virtual host, then access to your wallabag. +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 @@ -151,7 +151,7 @@ After reloading or restarting Apache, you should now be able to access wallabag Configuration on Nginx ~~~~~~~~~~~~~~~~~~~~~~ -Assuming you install wallabag in the ``/var/www/wallabag`` folder, here's the recipe for wallabag : +Assuming you installed wallabag in the ``/var/www/wallabag`` folder, here's the recipe for wallabag : :: @@ -258,7 +258,7 @@ It has to be the same for the following folders * /var/www/wallabag/bin/ * /var/www/wallabag/app/config/ * /var/www/wallabag/vendor/ -* /var/www/wallabag/data/ +* /var/www/wallabag/data/ by entering @@ -269,10 +269,56 @@ by entering chown -R www-data:www-data /var/www/wallabag/vendor chown -R www-data:www-data /var/www/wallabag/data/ -otherwise, sooner or later you will meet this error messages +otherwise, sooner or later you will see these error messages: .. code-block:: bash Unable to write to the "bin" directory. file_put_contents(app/config/parameters.yml): failed to open stream: Permission denied file_put_contents(/.../wallabag/vendor/autoload.php): failed to open stream: Permission denied + +Additional rules for SELinux +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +If SELinux is enabled on your system, you will need to configure additional contexts in order for wallabag to function properly. To check if SELinux is enabled, simply enter the following: + +``getenforce`` + +This will return ``Enforcing`` if SELinux is enabled. Creating a new context involves the following syntax: + +``semanage fcontext -a -t `` + +For example: + +``semanage fcontext -a -t httpd_sys_content_t "/var/www/wallabag(/.*)?"`` + +This will recursively apply the httpd_sys_content_t context to the wallabag directory and all underlying files and folders. The following rules are needed: + ++-----------------------------------+----------------------------+ +| Full path | Context | ++===================================+============================+ +| /var/www/wallabag(/.*)? | ``httpd_sys_content_t`` | ++-----------------------------------+----------------------------+ +| /var/www/wallabag/data(/.*)? | ``httpd_sys_rw_content_t`` | ++-----------------------------------+----------------------------+ +| /var/www/wallabag/var/logs(/.*)? | ``httpd_log_t`` | ++-----------------------------------+----------------------------+ +| /var/www/wallabag/var/cache(/.*)? | ``httpd_cache_t`` | ++-----------------------------------+----------------------------+ + +After creating these contexts, enter the following in order to apply your rules: + +``restorecon -R -v /var/www/wallabag`` + +You can check contexts in a directory by typing ``ls -lZ`` and you can see all of your current rules with ``semanage fcontext -l -C``. + +If you're installing the preconfigured latest-v2-package, then an additional rule is needed during the initial setup: + +``semanage fcontext -a -t httpd_sys_rw_content_t "/var/www/wallabag/var"`` + +After you successfully access your wallabag and complete the initial setup, this context can be removed: + +:: + + semanage fcontext -d -t httpd_sys_rw_content_t "/var/www/wallabag/var" + retorecon -R -v /var/www/wallabag/var -- cgit v1.2.3