diff --git a/README.markdown b/README.markdown index 7222278..f42370d 100644 --- a/README.markdown +++ b/README.markdown @@ -61,14 +61,15 @@ Requirements Documentation ------------- -- [Installation and updates](docs/installation-and-updates.markdown) +- [Installation](docs/installation.markdown) +- [Upgrade to a new version](docs/upgrade.markdown) - [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) -- [API documentation](docs/json-rpc-api.markdown) +- [Json-RPC API](docs/json-rpc-api.markdown) - [Fever API](docs/fever.markdown) - [FAQ](docs/faq.markdown) diff --git a/docs/config.markdown b/docs/config.markdown index af68840..361c942 100644 --- a/docs/config.markdown +++ b/docs/config.markdown @@ -30,7 +30,7 @@ define('ENABLE_MULTIPLE_DB', true); define('DEBUG', true); // DEBUG_FILENAME => default is data/debug.log -define('DEBUG_FILENAME', DATA_DIRECTORY.DIRECTORY_SEPARATOR.'debug.log'); +define('DEBUG_FILENAME', DATA_DIRECTORY.'/debug.log'); // THEME_DIRECTORY => default is themes define('THEME_DIRECTORY', 'themes'); diff --git a/docs/cronjob.markdown b/docs/cronjob.markdown index 236aab3..5440e47 100644 --- a/docs/cronjob.markdown +++ b/docs/cronjob.markdown @@ -1,10 +1,9 @@ -Cronjob (background feeds update) -================================= +Cronjob +======= -How do I update my feeds with a cronjob? ----------------------------------------- +The cronjob is a background task to update your feeds automatically. -You just need to be inside the directory `miniflux` and run the script `cronjob.php`. +Technically, you just need to be inside the directory `miniflux` and run the script `cronjob.php`. Parameters | Type | Value @@ -17,16 +16,18 @@ Parameters | Type | Value Examples: - crontab -e +```bash +crontab -e - # Update all feeds every 4 hours - 0 */4 * * * cd /path/to/miniflux && php cronjob.php >/dev/null 2>&1 +# Update all feeds every 4 hours +0 */4 * * * cd /path/to/miniflux && php cronjob.php >/dev/null 2>&1 - # Update the 10 oldest feeds each time - 0 */4 * * * cd /path/to/miniflux && php cronjob.php --limit=10 >/dev/null 2>&1 +# Update the 10 oldest feeds each time +0 */4 * * * cd /path/to/miniflux && php cronjob.php --limit=10 >/dev/null 2>&1 - # Update all feeds in 60 minutes (updates the 8 oldest feeds each time with a total of 120 feeds). - * */4 * * * cd /path/to/miniflux && php cronjob.php --call-interval=4 --update-interval=60 >/dev/null 2>&1 +# Update all feeds in 60 minutes (updates the 8 oldest feeds each time with a total of 120 feeds). +* */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. diff --git a/docs/faq.markdown b/docs/faq.markdown index be6faa0..45d3d0f 100644 --- a/docs/faq.markdown +++ b/docs/faq.markdown @@ -1,34 +1,40 @@ FAQ === -### How does Miniflux update my feeds from the user interface? +How does Miniflux update my feeds from the user interface? +---------------------------------------------------------- Miniflux uses an Ajax request to refresh each subscription. By default, there is only 5 feeds updated in parallel. -### I have 600 subscriptions, can Miniflux handle that? +I have 600 subscriptions, can Miniflux handle that? +--------------------------------------------------- Probably, but your life is cluttered. -### Why are there no categories? Why is feature X missing? +Why are there no categories? Why is feature X missing? +------------------------------------------------------ Miniflux is a minimalist software. _Less is more_. Sorry, I don't plan to have categories or tags. -### I found a bug, what next? +I found a bug, what next? +------------------------- Report the bug to the [issues tracker](https://github.com/fguillot/miniflux/issues) and I will fix it. You can report feeds that doesn't works properly too. -### What browser is compatible with Miniflux? +What browser is compatible with Miniflux? +----------------------------------------- Miniflux is tested with the latest versions of Mozilla Firefox, Google Chrome and Safari. I don't use Microsoft products, and as such I have no idea if Miniflux works correctly with Internet Explorer. -### How to setup Miniflux on OVH? +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`. diff --git a/docs/full-article-download.markdown b/docs/full-article-download.markdown index 229cac7..6803b2c 100644 --- a/docs/full-article-download.markdown +++ b/docs/full-article-download.markdown @@ -24,26 +24,29 @@ Add a PHP file to the directory `PicoFeed\Rules`, the filename must be the domai Example with the BBC website, `www.bbc.co.uk.php`: - 'http://www.bbc.co.uk/news/world-middle-east-23911833', - 'body' => array( - '//div[@class="story-body"]', - ), - 'strip' => array( - '//script', - '//form', - '//style', - '//*[@class="story-date"]', - '//*[@class="story-header"]', - '//*[@class="story-related"]', - '//*[contains(@class, "byline")]', - '//*[contains(@class, "story-feature")]', - '//*[@id="video-carousel-container"]', - '//*[@id="also-related-links"]', - '//*[contains(@class, "share") or contains(@class, "hidden") or contains(@class, "hyper")]', - ) - ); +```php + 'http://www.bbc.co.uk/news/world-middle-east-23911833', + 'body' => array( + '//div[@class="story-body"]', + ), + 'strip' => array( + '//script', + '//form', + '//style', + '//*[@class="story-date"]', + '//*[@class="story-header"]', + '//*[@class="story-related"]', + '//*[contains(@class, "byline")]', + '//*[contains(@class, "story-feature")]', + '//*[@id="video-carousel-container"]', + '//*[@id="also-related-links"]', + '//*[contains(@class, "share") or contains(@class, "hidden") or contains(@class, "hyper")]', + ) +); +``` Actually, only `body`, `strip` and `test_url` are supported. diff --git a/docs/installation-and-updates.markdown b/docs/installation.markdown similarity index 61% rename from docs/installation-and-updates.markdown rename to docs/installation.markdown index 6581e32..e0caa82 100644 --- a/docs/installation-and-updates.markdown +++ b/docs/installation.markdown @@ -1,5 +1,5 @@ -Installation and Updates -======================== +Installation instructions +========================= Installation ------------ @@ -19,24 +19,6 @@ Installation 1. `git clone https://github.com/fguillot/miniflux.git` 2. Go to the third step just above -Update ------- - -### From the archive: - -1. Close your session (logout) -2. Rename your actual miniflux directory (to keep a backup) -3. Uncompress the new archive and copy your database file `db.sqlite` in the directory `data` -4. Make the directory `data` writeable by the web server user -5. Login and check if everything is ok -6. Remove the old miniflux directory - -### From the repository: - -1. Close your session (logout) -2. `git pull` -3. Login and check if everything is ok - Security -------- diff --git a/docs/themes.markdown b/docs/themes.markdown index c05caba..a96d761 100644 --- a/docs/themes.markdown +++ b/docs/themes.markdown @@ -11,7 +11,9 @@ A theme doesn't change the behaviour of the application but only the page layout The first step is to create a new directory structure for your theme: - mkdir -p themes/mysuperskin/{css,img,fonts} +```bash +mkdir -p themes/mysuperskin/{css,img,fonts} +``` The name of your theme should be only alphanumeric. @@ -43,4 +45,4 @@ Other themes included in the default installation: - NoStyle by Frederic Guillot - Still by Franklin -**PS: Those themes are maintained and tested by their authors.** \ No newline at end of file +**PS: Those themes are maintained and tested by their respective authors.** diff --git a/docs/upgrade.markdown b/docs/upgrade.markdown new file mode 100644 index 0000000..3904609 --- /dev/null +++ b/docs/upgrade.markdown @@ -0,0 +1,19 @@ +Upgrade to a new version +======================== + +### From the archive: + +1. Close your session (logout) +2. Rename your actual miniflux directory (to keep a backup) +3. Uncompress the new archive and copy your database file `db.sqlite` in the directory `data` +4. Make the directory `data` writeable by the web server user +5. Login and check if everything is ok +6. Remove the old miniflux directory + +### From the repository: + +1. Close your session (logout) +2. `git pull` +3. Login and check if everything is ok + +Note: Always do a backup of your database before!