Updated formatting of CMless README for use with `discount`.
[cmless] / README.md
... / ...
CommitLineData
1CMless - Because words should be weighed, not counted.
2======================================================
3
4Description
5-----------
6
7CMless is a file based CMS intended for easy integration with version controlled,
8format agnostic content.
9
10Status
11------
12
13CMless is not yet functional. The stages required to reach basic functionality are:
14
151. ~~Figure out deployment scheme~~
162. ~~Interpret URL and locate/serve appropriate page~~
173. ~~Feed pages through a document processor~~
184. ~~Feed pages through a template engine~~
195. ~~Generate menu based on directory structure~~
206. Write documentation, including a sample site.
21
22Installation Example - Debian Linux
23-----------------------------------
24
25Enable CGI scripts:
26
27 a2enmod cgi
28
29Create and enable an Apache vhost.
30
31 vi /etc/apache2/sites-available/cmless.subgeniuskitty.com
32
33 <VirtualHost *:80>
34 DocumentRoot "/mnt/data/apache_vhosts/cmless.subgeniuskitty.com"
35 ServerName cmless.subgeniuskitty.com
36 ServerAdmin webmaster@subgeniuskitty.com
37 ErrorLog /var/log/apache2/error_log.cmless.subgeniuskitty.com
38 CustomLog /var/log/apache2/access_log.cmless.subgeniuskitty.com combined
39 AddHandler cgi-script .py
40 <Directory "/mnt/data/apache_vhosts/cmless.subgeniuskitty.com">
41 Options -ExecCGI -Indexes
42 AllowOverride None
43 Order allow,deny
44 Allow from all
45 </Directory>
46 <Directory "/mnt/data/apache_vhosts/cmless.subgeniuskitty.com/bin">
47 Options ExecCGI
48 AllowOverride None
49 Order allow,deny
50 Allow from all
51 </Directory>
52 RewriteEngine On
53 RewriteRule (.*) /mnt/data/apache_vhosts/cmless.subgeniuskitty.com/site/$1
54 RewriteCond %{REQUEST_FILENAME} !-f
55 RewriteRule .* /mnt/data/apache_vhosts/cmless.subgeniuskitty.com/bin/cmless.py
56 </VirtualHost>
57
58 a2ensite cmless.subgeniuskitty.com
59 service apache2 reload
60
61Clone the CMless git repository into the Apache vhost directory.
62
63 cd /mnt/data/apache_vhosts
64 git clone https://github.com/subgeniuskitty/cmless.git cmless.subgeniuskitty.com
65 chown -R www-data:www-data ./cmless.subgeniuskitty.com
66
67Clone your content into the `site/` folder. If you with to use a different
68folder, edit the configuration options in `bin/config.py` accordingly. If this
69is your first CMless site, see the `site_sample/` folder for an example site
70using Markdown.
71
72 cd /mnt/data/apache_vhosts/cmless.subgeniuskitty.com
73 git clone your_site_content_repo site
74 chown -R www-data:www-data ./site
75
76Install an appropriate document processor for your content and set the
77`markup_processor` configuration option in `bin/config.py` accordingly. Your
78markup engine should accept text via `stdin` and output HTML on `stdout`.
79
80 apt-get install discount
81
82Edit `bin/config.py` and set all configuration options according to the steps
83taken during installation. Each option is commented inside the file.