jan/miniflux-legacy
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update documentation

Browse Source
This commit is contained in:
Frederic Guillot 2016-12-26 18:01:46 -05:00
parent 1a85a76c5c
commit 59a721ce18
9 changed files with 85 additions and 67 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.markdown
View File

@ -11,7 +11,6 @@ Features
- Host almost anywhere
- Readability (CSS optimized for readability, responsive design, compatible with mobile and tablet devices)
- Easy setup => **copy and paste the source code and you are done!**
- Use a lightweight Sqlite database instead of Mysql or Postgresql
- Remove Feedburner Ads and analytic trackers (1x1 pixels)
- Open external links inside a new tab with a `rel="noreferrer"` attribute
- Use secure HTTP headers (only external images and Youtube/Vimeo/Dailymotion videos are allowed)
@ -22,7 +21,7 @@ Features
- Full article download for feeds that display only a summary
- Bookmarks
- Groups for categorization of feeds (like folders or tags)
- Send your favorite articles to Pinboard and Instapaper
- Send your favorite articles to Pinboard, Instapaper or Wallabag
- Enclosure support (videos and podcasts)
- Feed updates via a cronjob or with the user interface with one click
- Keeps history of read items
@ -49,7 +48,6 @@ Documentation
- [Cronjob](docs/cronjob.markdown)
- [Advanced configuration](docs/config.markdown)
- [Full article download](docs/full-article-download.markdown)
- [Multiple users](docs/multiple-users.markdown)
- [Translations](docs/translations.markdown)
- [Themes](docs/themes.markdown)
- [Json-RPC API](docs/json-rpc-api.markdown)

1
app/templates/help.php
View File

@ -27,7 +27,6 @@
<li><a href="https://miniflux.net/documentation/cronjob" rel="noreferrer" target="_blank"><?php echo t('Cronjob') ?></a></li>
<li><a href="https://miniflux.net/documentation/config" rel="noreferrer" target="_blank"><?php echo t('Advanced configuration') ?></a></li>
<li><a href="https://miniflux.net/documentation/full-article-download" rel="noreferrer" target="_blank"><?php echo t('Full article download') ?></a></li>
<li><a href="https://miniflux.net/documentation/multiple-users" rel="noreferrer" target="_blank"><?php echo t('Multiple users') ?></a></li>
<li><a href="https://miniflux.net/documentation/themes" rel="noreferrer" target="_blank"><?php echo t('Themes') ?></a></li>
<li><a href="https://miniflux.net/documentation/json-rpc-api" rel="noreferrer" target="_blank"><?php echo t('Json-RPC API') ?></a></li>
<li><a href="https://miniflux.net/documentation/fever" rel="noreferrer" target="_blank"><?php echo t('Fever API') ?></a></li>

63
docs/config.markdown
View File

@ -1,4 +1,4 @@
Configuration parameters
Configuration Parameters
========================
How do I override application variables?
@ -9,11 +9,46 @@ These parameters are defined with PHP constants.
To override them, rename the file `config.default.php` to `config.php`.
Actually, the following constants can be overrided:
Database configuration
----------------------
By default, Miniflux uses Sqlite but Postgres is also supported.
### Sqlite configuration
You could change the default location of the Sqlite file by changing the default values:
```php
<?php
define('DB_DRIVER', 'sqlite');
define('DB_FILENAME', DATA_DIRECTORY.'/db.sqlite');
```
### Postgres configuration
Miniflux will creates the schema automatically but not the database itself:
```sql
CREATE DATABASE miniflux;
```
The `config.php` have to be modified as well:
```php
define('DB_DRIVER', 'postgres');
// Replace these values:
define('DB_HOSTNAME', 'localhost');
define('DB_NAME', 'miniflux');
define('DB_USERNAME', 'my postgres user');
define('DB_PASSWORD', 'my secret password');
```
List of parameters
------------------
Actually, the following constants can be overridden:
```php
// HTTP_TIMEOUT => default value is 20 seconds (Maximum time to fetch a feed)
define('HTTP_TIMEOUT', '20');
@ -21,7 +56,7 @@ define('HTTP_TIMEOUT', '20');
define('HTTP_MAX_RESPONSE_SIZE', 2097152);
// DATA_DIRECTORY => default is data (writable directory)
define('DATA_DIRECTORY', __DIR__.'/data');
define('DATA_DIRECTORY', 'data');
// FAVICON_DIRECTORY => default is favicons (writable directory)
define('FAVICON_DIRECTORY', DATA_DIRECTORY.DIRECTORY_SEPARATOR.'favicons');
@ -29,11 +64,20 @@ define('FAVICON_DIRECTORY', DATA_DIRECTORY.DIRECTORY_SEPARATOR.'favicons');
// FAVICON_URL_PATH => default is data/favicons/
define('FAVICON_URL_PATH', 'data/favicons');
// DB_FILENAME => default value is db.sqlite (default database filename)
define('DB_FILENAME', 'db.sqlite');
// Database driver: "sqlite" or "postgres", default is sqlite
define('DB_DRIVER', 'sqlite');
// ENABLE_MULTIPLE_DB => default value is true (multiple users support)
define('ENABLE_MULTIPLE_DB', true);
// Database connection parameters when Postgres is used
define('DB_HOSTNAME', 'localhost');
define('DB_NAME', 'miniflux');
define('DB_USERNAME', 'postgres');
define('DB_PASSWORD', '');
// DB_FILENAME => database file when Sqlite is used
define('DB_FILENAME', DATA_DIRECTORY.'/db.sqlite');
// Enable/disable debug mode
define('DEBUG_MODE', false);
// DEBUG_FILENAME => default is data/debug.log
define('DEBUG_FILENAME', DATA_DIRECTORY.'/debug.log');
@ -59,4 +103,7 @@ define('PROXY_PASSWORD', '');
// SUBSCRIPTION_CONCURRENT_REQUESTS => number of concurrent feeds to refresh at once
// Reduce this number on systems with limited processing power
define('SUBSCRIPTION_CONCURRENT_REQUESTS', 5);
// Allow the cronjob to be accessible from the browser
define('ENABLE_CRONJOB_HTTP_ACCESS', true);
```

19
docs/cronjob.markdown
View File

@ -1,14 +1,16 @@
Cronjob
=======
Background Job (cronjob)
========================
The cronjob is a background task to update your feeds automatically.
Command line usage
------------------
Technically, you just need to be inside the directory `miniflux` and run the script `cronjob.php`.
Parameters | Type | Value
--------------------|--------------------------------|-----------------------------
--database | optional | Database filename, default is db.sqlite (ex: db2.sqlite)
--limit | optional | number of feeds
--call-interval | optional, excluded by --limit, require --update-interval | time in minutes < update interval time
--update-interval | optional, excluded by --limit, require --call-interval | time in minutes >= call interval time
@ -29,6 +31,13 @@ crontab -e
* */4 * * * cd /path/to/miniflux && php cronjob.php --call-interval=4 --update-interval=60 >/dev/null 2>&1
```
Note: cronjob.php can also be called from the web, in this case specify the options as GET variables.
Web usage
---------
Example: <http://yourpersonalserver/miniflux/cronjob.php?call-interval=4&update-interval=60>
The cronjob script can also be called from the web, in this case specify the options as GET variables.
Example: <http://yourpersonalserver/miniflux/cronjob.php?call-interval=4&update-interval=60&token=XXX>
- The cronjob URL is visible on the page **preferences > about**.
- The access is protected by a private token.
- You can disable the web cronjob by changing the config parameter `ENABLE_CRONJOB_HTTP_ACCESS` to `false`.

30
docs/faq.markdown
View File

@ -1,6 +1,11 @@
Frequently Asked Questions
==========================
Does Miniflux supports other databases than Sqlite?
---------------------------------------------------
Yes, Sqlite and Postgres are supported since the version 1.2.0.
How does Miniflux update my feeds from the user interface?
----------------------------------------------------------
@ -10,7 +15,7 @@ By default, there is only 5 feeds updated in parallel.
I have 600 subscriptions, can Miniflux handle that?
---------------------------------------------------
Probably, but your life is cluttered.
Probably, but your life is too cluttered.
Why is feature X missing?
-------------------------
@ -20,7 +25,7 @@ Miniflux is a minimalist software. _Less is more_.
I found a bug, what next?
-------------------------
Report the bug to the [issues tracker](https://github.com/miniflux/miniflux/issues) and I will fix it.
Report the bug to the [issues tracker](https://github.com/miniflux/miniflux/issues).
You can report feeds that doesn't works properly too.
@ -29,27 +34,10 @@ What browser is compatible with Miniflux?
Miniflux is tested with the latest versions of Mozilla Firefox, Google Chrome and Safari.
Miniflux is also tested on mobile devices Android (Moto G) and Ipad Mini (Retina).
How to setup Miniflux on OVH shared-hosting?
--------------------------------------------
OVH shared web-hosting can use different PHP versions.
To have Miniflux working properly you have to use a custom `.htaccess`, for example:
```
SetEnv PHP_VER 5_4
SetEnv ZEND_OPTIMIZER 1
SetEnv MAGIC_QUOTES 0
<IfModule mod_rewrite.c>
RewriteEngine on
RewriteRule .* - [E=REMOTE_USER:%{HTTP:Authorization},L]
</IfModule>
```
I want to send bookmarks to Pinboard. How do I find my Pinboard API token?
--------------------------------------------------------------------------
You can find your API token by going to [https://api.pinboard.in/v1/user/api_token/](https://api.pinboard.in/v1/user/api_token/).
Miniflux requires you to add your Pinboard username before this, followed by a colon (eg. bobsmith:12FC235692DF53DD1).
The Pinboard token should be formatted like that: `bobsmith:12FC235692DF53DD1`.

10
docs/fever.markdown
View File

@ -2,7 +2,7 @@ Fever API
=========
Miniflux support the [Fever API](http://feedafever.com/api).
That means you can use mobile applications compatible with Fever.
That means you can use any mobile applications that is compatible with Fever.
This feature has been tested with the following apps:
@ -11,7 +11,6 @@ This feature has been tested with the following apps:
- [Reeder 3](http://reederapp.com/) (OS X)
- [ReadKit](http://readkitapp.com/) (OS X)
Configuration
-------------
@ -22,13 +21,6 @@ All information are available from the page **preferences > api**.
- Username: Your username
- Password: random (visible on the settings page)
Multiple databases/users
------------------------
Multiple databases can be used with the Fever API if you have Apache and `mod_rewrite` enabled.
The Fever URL becomes `http://your_miniflux_url/fever/mydatabase.sqlite/`.
Notes
-----

4
docs/installation.markdown
View File

@ -7,7 +7,7 @@ Installation
### From the archive (stable version)
1. You must have a web server with PHP installed (version 5.3.3 minimum) with the Sqlite and XML extensions
2. Download the [latest release](https://github.com/miniflux/miniflux/releases) and copy the directory `miniflux` where you want
2. Download the [latest release](https://miniflux.net/downloads) and copy the directory `miniflux` where you want
3. Check if the directory `data` is writeable (Miniflux stores everything inside a Sqlite database)
4. With your browser go to <http://yourpersonalserver/miniflux>
5. The default login and password is **admin/admin**
@ -19,6 +19,8 @@ Installation
1. `git clone https://github.com/miniflux/miniflux.git`
2. Go to the third step just above
By default, Miniflux uses Sqlite, if you would like to use Postgres instead you will have to modify your `config.php` file.
Security
--------

19
docs/multiple-users.markdown
View File

@ -1,19 +0,0 @@
Multiple users
==============
Since the beginning, Miniflux was a single user software.
However, it is now possible to create multiple databases.
Each user has his own Sqlite database and people can choose which database they want to use before the authentication.
To create a new database:
1. Go to the page **preferences > database**
2. Click on the link "Add a new database"
3. Fill the form (db name, the new username and password) and save
4. If you logout, on the login page you can choose the database you want to use
If you use the cronjob, to select the database, use the parameter `--database` like that:
```bash
php cronjob.php --database=db2.sqlite
```

2
docs/upgrade.markdown
View File

@ -1,6 +1,8 @@
Upgrade to a new version
========================
Before to do anything, **you must backup your data!**
### From the archive (stable version)
1. Close your session (logout)