summaryrefslogtreecommitdiffstats
path: root/README.markdown
blob: 29d3fe6481f557ef3f0557a4970fad71928754c0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
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
------------
Web hosting with at least PHP5.4 (PHP4 & 5.2, 5.3 will not work).

Installing
----------
* Upload all the files to your server (with FTP or other)
OR
* Use `composer create-project mauricesvay/moonmoon moonmoon`
* Run `wget https://getcomposer.org/composer.phar && php composer.phar install` 
* Open install.php with your browser
* Follow the instructions

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)
```

---