aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/en/Administrator
diff options
context:
space:
mode:
authorNicolas Lœuillet <nicolas.loeuillet@smile.fr>2015-10-21 14:14:51 +0200
committerNicolas Lœuillet <nicolas.loeuillet@smile.fr>2015-10-21 14:14:51 +0200
commit59e91bc8931a386974a3817e9849aad1ca7fc186 (patch)
tree4bd4f99cff41e32c3820f1770d5500c96630c32f /docs/en/Administrator
parenta4e1ddf2d64bba7c7e28459ccc6738a9a9e23e71 (diff)
downloadwallabag-59e91bc8931a386974a3817e9849aad1ca7fc186.tar.gz
wallabag-59e91bc8931a386974a3817e9849aad1ca7fc186.tar.zst
wallabag-59e91bc8931a386974a3817e9849aad1ca7fc186.zip
add docs
Diffstat (limited to 'docs/en/Administrator')
-rw-r--r--docs/en/Administrator/hidden_options.rst85
-rw-r--r--docs/en/Administrator/install.rst200
-rw-r--r--docs/en/Administrator/multiusers.rst47
-rw-r--r--docs/en/Administrator/sessions.rst26
-rw-r--r--docs/en/Administrator/update.rst30
5 files changed, 388 insertions, 0 deletions
diff --git a/docs/en/Administrator/hidden_options.rst b/docs/en/Administrator/hidden_options.rst
new file mode 100644
index 00000000..5cf0b22e
--- /dev/null
+++ b/docs/en/Administrator/hidden_options.rst
@@ -0,0 +1,85 @@
1Hidden options
2==============
3
4Caution
5-------
6
7**Be careful**, this section is destined to advanced users. We are going
8to modify an important wallabag configuration file,
9``inc/poche/config.inc.php``. It is therefore advised to do a backup of
10this file before you proceed. **Any error occuring during the
11modification of a wallabag file could lead to malfunctions**.
12
13This file is created when you install wallabag. Install wallabag, do a
14backup copy of the file, then open it in your favorite text editor.
15
16In this file, there are some options that are not, as of now, available
17in the **config** page of wallabag.
18
19Modification of advanced options
20--------------------------------
21
22Each option is defined this way:
23
24::
25
26 @define ('OPTION_NAME', 'Value');
27
28For each line, you can only modify the ``Value`` field.
29
30Here is the list of each option you can change:
31
32- ``HTTP_PORT`` (default: ``80``) : the HTTP port of your web server.
33 You may need to change it if your server is behind a proxy. Accepted
34 values: number
35- ``SSL_PORT`` (default: ``443``) : the HTTP port of your web server.
36 You may need to change it if your server use SSLH. Accepted values:
37 number
38- ``MODE_DEMO`` (default : ``FALSE)``: If you ever wanted to set up a
39 demonstration server… Accepted values: ``TRUE`` or ``FALSE``.
40- ``DEBUG_POCHE`` (default: ``FALSE``) : if you encounter some problems
41 with wallabag, we may ask you to active Debug mode. Accepted values:
42 ``TRUE`` or ``FALSE``. Check the logs in cache/log.txt after
43 activating that.
44- ``ERROR_REPORTING`` (default : ``E_ALL & ~E_NOTICE``) : Set to
45 ``E_ALL`` if needed to look for eventual PHP errors.
46- ``DOWNLOAD_PICTURES`` (default: ``FALSE``) : Allows wallabag to fetch
47 images from the articles you save on your server, instead of fetching
48 only the text. We prefer to let you activate this option yourself.
49 Accepted values: ``TRUE`` or ``FALSE``.
50- ``REGENERATE_PICTURES_QUALITY`` (default : ``75``) : In order to
51 avoid security problems, pictures are regenerated if you activate the
52 download of pictures. This is the percentage of quality at which they
53 are saved. Increase that numbler if you want better quality, lower if
54 you need better performances.
55- ``SHARE_TWITTER`` (default: ``TRUE``) : enables Twitter sharing.
56 Accepted values: ``TRUE`` or ``FALSE``.
57- ``SHARE_MAIL`` (default: ``TRUE``) : enables mail sharing. Accepted
58 values: ``TRUE`` or ``FALSE``.
59- ``SHARE_EVERNOTE``\ (default : ``FALSE``) : enables sharing with your
60 Evernote account. Accepted values: ``TRUE`` or ``FALSE``.
61- ``SHARE_DIASPORA`` (default : ``FALSE``) : enables to share an
62 article on your Diaspora account.
63- ``DIASPORA_URL`` (default : ``http://diasporapod.com``) : The URL of
64 your Diaspora\* pod
65- ``CARROT`` (default : ``FALSE``) : Like Flattr, it’s a service to
66 give small amounts of money to a web page. See http://carrot.org/
67- ``SHARE_SHAARLI`` (default: ``FALSE``) : enables sharing via your
68 Shaarli installation (Shaarli is an open-source bookmark manager).
69 Accepted values: ``TRUE`` or ``FALSE``.
70- ``SHAARLI_URL`` (default: ``'http://myshaarliurl.com'``) : defines
71 your Shaarli installation URL. Accepted values: an URL.
72- ``FLATTR`` (default: ``TRUE``) : enables the possibility to Flattr an
73 article (`Flattr is a microdonation platform`_). If an article is
74 Flattr-able, an icon will be displayed, allowing you to send a
75 microdonation to the author. Accepted values: ``TRUE`` or ``FALSE``.
76- ``SHOW_PRINTLINK`` (default: ``'1'``) : enables the Print button for
77 articles. Accepted values: ``'1'`` to enable or ``'0'`` to disable.
78- ``SHOW_READPERCENT`` (default: ``'1'``) : enables the reading
79 progress on articles (working on the ``default``, ``dark``,
80 ``dmagenta``, ``solarized``, ``solarized-dark`` themes). Accepted
81 values: ``'1'`` to enable or ``'0'`` to disable.
82- ``PAGINATION`` (default: ``'12'``) : defines the number of articles
83 that are displayed on a list. Accepted values: number.
84
85.. _Flattr is a microdonation platform: http://en.wikipedia.org/wiki/Flattr
diff --git a/docs/en/Administrator/install.rst b/docs/en/Administrator/install.rst
new file mode 100644
index 00000000..006d8708
--- /dev/null
+++ b/docs/en/Administrator/install.rst
@@ -0,0 +1,200 @@
1Download and install wallabag
2=============================
3
4I don’t want to install wallabag
5--------------------------------
6
7If you can’t or don’t want to install Wallabag on your server, we
8suggest you create a free account on `Framabag`_ which uses our
9software (see :ref:`Framabag account creation`).
10
11I want to install wallabag
12--------------------------
13
14I want to download wallabag manually
15~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
16
17`Download the latest wallabag version`_ and unpack it:
18
19::
20
21 wget http://wllbg.org/latest
22 unzip latest
23 mv wallabag-version-number wallabag
24
25Copy the files on your web server. For Ubuntu/Debian, it is the
26directory /var/www/html/ :
27
28::
29
30 sudo mv wallabag /var/www/html/
31
32Then, jump off to next section.
33
34I want to download wallabag via composer
35~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
36
37You need to install composer:
38
39::
40
41 curl -s http://getcomposer.org/installer | php
42
43Next, on your web server, run this command:
44
45::
46
47 composer create-project wallabag/wallabag . dev-master
48
49All is downloaded into the current folder.
50
51Prerequisites for your web server
52^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
53
54Wallabag requires that several components to be installed on your web
55server. To make sure your server has all the prerequisites, open in your
56browser the page ``http://monserveur.com/wallabag/install/index.php``.
57
58The components are:
59
60- `PHP 5.3.3 or above`_ **with `PDO`_ support**
61- `XML for PHP`_
62- `PCRE`_
63- `ZLib`_ (otherwise, the processing of compressed pages will be
64 affected)
65- `mbstring`_ anb/or `iconv`_ (otherwise some pages will not be read -
66 even in English)
67- The `DOM/XML`_ extension
68- `Data filtering`_
69- `GD`_ (otherwise, pictures will not be saved)
70- `Tidy for PHP`_ (otherwise, you may encounter problems with some
71 pages)
72- `cURL`_ with ``Parallel URL fetching`` (optionnal)
73- `Parse ini file`_
74- `allow\_url\_fopen`_ (optionnal if cURL is installed)
75- `gettext`_ (required for multi-language support)
76
77Install the missing components before to proceed. For example, to
78install Tidy on Ubuntu/Debian:
79
80::
81
82 sudo apt-get install php5-tidy
83 sudo service apache2 reload
84
85Note : if you’re using IIS as a webserver, you have to disable
86*Anonymous Authentication* and `enable *Basic Authentication*`_ in order
87to be able to login.
88
89Twig installation
90^^^^^^^^^^^^^^^^^
91
92wallabag is build with Twig, a template library. You have to download it
93for wallabag to work. If you cannot install ``composer`` (for example in
94the case of shared hosting), we offer you to download a file which
95includes ``Twig``. This file can be downloaed from the page
96``http://myservur.com/wallabag/install/index.php`` (section TWIG
97INSTALLATION) or directly at http://wllbg.org/vendor. Uncompress it in
98your wallabag directory.
99
100Otherwise, you can use Composer to install ``Twig`` by launching
101``composer`` from your wallabag directory (in the case of Ubuntu/Debian
102too: /var/www/html/wallabag/) by following the commands written on
103screen:
104
105::
106
107 curl -s http://getcomposer.org/installer | php
108 php composer.phar install
109
110Creation of the database.
111^^^^^^^^^^^^^^^^^^^^^^^^^
112
113Wallabag can be installed on different types of databases:
114
115- `SQLite`_. The easiest system of all. No extra configuration needed.
116- `MySQL`_. A well known database system, which is in most cases more
117 efficient than SQLite.
118- `PostgreSQL`_. Some people found it better than MySQL.
119
120We advice you to use MySQL because it is more efficient. In this case,
121you should create a new database (for example ``wallabag``), a new user
122(for example ``wallabag``) and a password (here ``YourPassWord``). To do
123this, you can use ``phpMyAdmin``, or launch the following commands:
124
125::
126
127 mysql -p -u root
128 mysql> CREATE DATABASE wallabag;
129 mysql> GRANT ALL PRIVILEGES ON `wallabag`.* TO 'wallabag'@'localhost' IDENTIFIED BY 'VotreMotdePasse';
130 mysql> exit
131
132*Note:* If you’re using MySQL or Postgresql, you have to **fill all the
133fields**, otherwise the installation will not work and an error message
134will tell you what’s wrong. You must create the database that you will
135use for wallabag manually with a tool like PHPMyAdmin or the console.
136
137Permissions
138~~~~~~~~~~~
139
140Your web server needs a writing access to the ``assets``, ``cache`` and
141``db`` directories. Otherwise, a message will report that the
142installation is impossible:
143
144::
145
146 sudo chown -R www-data:www-data /var/www/html/wallabag
147
148Installation of wallabag. At last.
149~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
150
151Access to wallabag from your web browser:
152``http://votreserveur.com/wallabag``. If your server is correctly
153configured, you directly reach the setup screen.
154
155Select the type of database (``sqlite``, ``mysql`` or ``postgresql``)
156and fill the information about your database. In the case of the databse
157MySQL created before, the standard configuration will be:
158
159::
160
161 Database engine: MySQL
162 Server: localhost
163 Database: wallabag
164 Username: wallabag
165 Password: YourPassWord
166
167Finally, Create your first user and his/her password (different from the
168database user).
169
170Wallabag is now installed.
171
172Login
173-----
174
175From your web browser, you reach the login screen: fill your username
176and your password to connect to your account.
177
178Enjoy!
179
180.. _SQLite: http://php.net/manual/fr/book.sqlite.php
181.. _MySQL: http://php.net/manual/fr/book.mysql.php
182.. _PostgreSQL: http://php.net/manual/fr/book.pgsql.php
183.. _Framabag: https://framabag.org/
184.. _Download the latest wallabag version: http://wllbg.org/latest
185.. _PHP 5.3.3 or above: http://php.net/manual/fr/install.php
186.. _PDO: http://php.net/manual/en/book.pdo.php
187.. _XML for PHP: http://php.net/fr/xml
188.. _PCRE: http://php.net/fr/pcre
189.. _ZLib: http://php.net/en/zlib
190.. _mbstring: http://php.net/en/mbstring
191.. _iconv: http://php.net/en/iconv
192.. _DOM/XML: http://php.net/manual/en/book.dom.php
193.. _Data filtering: http://php.net/manual/fr/book.filter.php
194.. _GD: http://php.net/manual/en/book.image.php
195.. _Tidy for PHP: http://php.net/fr/tidy
196.. _cURL: http://php.net/fr/curl
197.. _Parse ini file: http://uk.php.net/manual/en/function.parse-ini-file.php
198.. _allow\_url\_fopen: http://www.php.net/manual/fr/filesystem.configuration.php#ini.allow-url-fopen
199.. _gettext: http://php.net/manual/fr/book.gettext.php
200.. _enable *Basic Authentication*: https://technet.microsoft.com/en-us/library/cc772009%28v=ws.10%29.aspx
diff --git a/docs/en/Administrator/multiusers.rst b/docs/en/Administrator/multiusers.rst
new file mode 100644
index 00000000..a4053aae
--- /dev/null
+++ b/docs/en/Administrator/multiusers.rst
@@ -0,0 +1,47 @@
1.. _`Multi users`:
2
3Multi users
4===========
5
6Create a new account
7--------------------
8
9Administrator mode
10------------------
11
12If you want to use wallabag with several persons, you can create new
13accounts from the configuration page.
14
15At the bottom of this page there is a form where you should input a user
16name and a password.
17
18It is now possible to login to this account from the login page of
19wallabag.
20
21No information are shared among the accounts.
22
23Open registration mode
24----------------------
25
26Starting from version 1.9, the administrator can let users register by
27themselves. This is done by changing the following lines in the
28configuration file:
29
30::
31
32 // registration
33 @define ('ALLOW_REGISTER', FALSE);
34 @define ('SEND_CONFIRMATION_EMAIL', FALSE);
35
36Then, a user will be able to enter his/her user name and password to
37create his/her own account. Depending on the configuration, a
38confimation email can be sent to users who gave an email address.
39
40Remove an account
41-----------------
42
43It is possible to remove your own account from the configuration page.
44You simply have to enter your password and to ask for the removal.
45
46Of course, when there is only one account, it is impossible to remove
47it.
diff --git a/docs/en/Administrator/sessions.rst b/docs/en/Administrator/sessions.rst
new file mode 100644
index 00000000..7dbae257
--- /dev/null
+++ b/docs/en/Administrator/sessions.rst
@@ -0,0 +1,26 @@
1Session issues
2==============
3
4If you end up disconnected even while checking the *Stay signed in
5checkbox*, please run the following commands as root (or with sudo) :
6
7::
8
9 mkdir /var/lib/wallabag-sessions
10 chown www-data:www-data /var/lib/wallabag-sessions
11
12*NOTE : The www-data user and group may not exist, you may use
13``chown http:http /var/lib/wallabag-sessions`` instead*
14
15Then, using apache add:
16``php_admin_value session.save_path /var/lib/wallabag-sessions`` to your
17apache vhost, for instance ``wallabag-apache.conf`` Finally, restart
18apache, for instance like this : ``/etc/init.d/apache2 restart``
19
20If you’re using nginx, add
21``php_admin_value[session.save_path] = /var/lib/wallabag-sessions`` in
22your nginx configuration file. Then, restart nginx :
23``/etc/init.d/nginx restart``
24
25*NOTE : If you’re using systemd, you should do
26``systemctl restart apache2`` (or nginx).*
diff --git a/docs/en/Administrator/update.rst b/docs/en/Administrator/update.rst
new file mode 100644
index 00000000..7b799bb3
--- /dev/null
+++ b/docs/en/Administrator/update.rst
@@ -0,0 +1,30 @@
1Update wallabag
2===============
3
4Update an existing wallabag installation
5----------------------------------------
6
7In order to update your installation, download and unzip the archive
8into your installation folder. For example on Ubuntu/Debian:
9
10::
11
12 wget http://wllbg.org/latest
13 unzip latest
14 rsync -ur wallabag-version-number/* /var/www/html/wallabag/ # could be another location such as /srv/html, /usr/share/nginx/html
15
16After that, just access wallabag in your browser and follow the
17instructions to finish the update.
18
19You can verify at the bottom of the configuration page that you’re
20running the last version.
21
22**If it fails**, just delete the ``install`` folder and clear the cache:
23
24::
25
26 cd /var/www/html/wallabag/
27 rm -r cache/* install/
28
29Clearing the cache is also possible in the configuration page, clicking
30on the link ``Delete Cache``.