moonmoon is a simple feed aggregator (planet like)
PHP CSS Shell
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.github
admin
app
bin
custom
docs @ 6730c05
tests
.gitignore
.gitmodules
.travis.yml
CONTRIBUTING.md
LICENSE
README.md
VERSION
atom.php
composer.json
composer.lock
cron.php
index.php
install.php
phpunit.xml
postload.php

README.md

moonmoon Build Status

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 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 note that you will need to install the package php-xml.

Installing

Installation steps (shared hosting or virtual / dedicated server) can be found in the wiki.

Docker images are also available in moonmoon/docker-images. Theses images are probably not production-ready but should work for manual testing.

Contributing

You want to contribute to moonmoon? Perfect! We wrote some guidelines to help you craft the best Issue / Pull Request possible, don't hesitate to take a look at it :-)

License

Moonmoon is free software and is released under the BSD license. Third-party code differently licensed is included in this project, in which case mention is always made of the applicable license.

The logo was designed by @rakujira.

Configuration options

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

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!)
checkcerts: true                # check feeds certificates