moonmoon [![Build Status](https://travis-ci.org/moonmoon/moonmoon.svg?branch=master)](https://travis-ci.org/moonmoon/moonmoon)
========

[http://moonmoon.org/](http://moonmoon.org/)

Moonmoon is a web based aggregator similar to planetplanet.
It can be used to blend articles from different blogs with same interests into a single page.

Moonmoon is stupidly simple: it only aggregates feeds and spits them out in one single page.
It does not archive articles, it does not do comments nor votes.

Requirements
------------
You will need a web hosting with at least PHP 5.6 (PHP 7 is also supported).

If you are installing Moonmoon on a Linux private server (VPS, dedicated host), please not that you 
will need to install the package `php-xml`.

Installing
----------

#### On a shared hosting

* Fetch a copy of the sources:
  - The last version, by downloading https://github.com/moonmoon/moonmoon/archive/master.zip (warning, it may be instable!);
  - The last release, by going on https://github.com/moonmoon/moonmoon/releases and downloading the last stable one.
* Extract the zip file on your computer
* Upload the extracted files your shared hosting server using your FTP client. If your hosting provider offers FTP and SFTP, prefer the last one, as the connection will be established over a secure channel.
* Go to `http(s)://yourdomain.tld/install.php` with your browser
* Profit!

#### On a dedicated server (where a web server is already installed)

* Download composer: `wget https://getcomposer.org/composer.phar`
* Fetch a copy of the sources:
  - The last version, by downloading a copy of `master`: `wget https://github.com/moonmoon/moonmoon/archive/master.zip` (warning, it may be instable!);
  - The last release, by going on https://github.com/moonmoon/moonmoon/releases and downloading the last stable one.
* Extract the files by running: `unzip <thefile.zip>`
* Inside the extracted repository, run ` php composer.phar install --no-dev`
* Go to `http(s)://yourserver.tld/install.php` with your browser
* Profit!

License
-------
Moonmoon is free software and is released under BSD license.


Configuration options
---------------------
After installation, configuration is kept in a YAML formatted `custom/config.yml`:

```%yaml
url: http://planet.example.net  # your planet base URL
name: My Planet                 # your planet front page name
locale: en                      # front page locale
items: 10                       # how many items to show
refresh: 240                    # feeds cache timeout (in seconds)
cache: 10                       # front page cache timeout (in seconds)
cachedir: ./cache               # where is cache stored
postmaxlength: 0                # deprecated
shuffle: 0                      # deprecated
nohtml: 0                       # deprecated
categories:                     # only list posts that have one
                                # of these (tag or category)
debug: false                    # debug mode (dangerous in production!)
```

---