Added config.py and edited README.md to reflect new installation steps.
[cmless] / README.md
CommitLineData
2670bdf4
AT
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
a58599ba 151. ~~Figure out deployment scheme~~
2670bdf4
AT
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
a58599ba
AT
20
21Installation Example - Debian Linux
22-----------------------------------
23
24Enable CGI scripts:
25
26```
27a2enmod cgi
28```
29
30Create and enable an Apache vhost.
31
32```
33vi /etc/apache2/sites-available/cmless.subgeniuskitty.com
34```
35
36```
37<VirtualHost *:80>
38 DocumentRoot "/mnt/data/apache_vhosts/cmless.subgeniuskitty.com"
39 ServerName cmless.subgeniuskitty.com
40 ServerAdmin webmaster@subgeniuskitty.com
41 ErrorLog /var/log/apache2/error_log.cmless.subgeniuskitty.com
42 CustomLog /var/log/apache2/access_log.cmless.subgeniuskitty.com combined
43 AddHandler cgi-script .py
44 <Directory "/mnt/data/apache_vhosts/cmless.subgeniuskitty.com">
45 Options -ExecCGI -Indexes
46 AllowOverride None
47 Order allow,deny
48 Allow from all
49 </Directory>
50 <Directory "/mnt/data/apache_vhosts/cmless.subgeniuskitty.com/bin">
51 Options ExecCGI
52 AllowOverride None
53 Order allow,deny
54 Allow from all
55 </Directory>
56 RewriteEngine On
57 RewriteRule (.*) /mnt/data/apache_vhosts/cmless.subgeniuskitty.com/site/$1
58 RewriteRule .* /mnt/data/apache_vhosts/cmless.subgeniuskitty.com/bin/cmless.py
59</VirtualHost>
60```
61
62```
63a2ensite cmless.subgeniuskitty.com
64service apache2 reload
65```
66
67Clone the CMless git repository into the Apache vhost directory.
68
69```
70cd /mnt/data/apache_vhosts
71git clone https://github.com/subgeniuskitty/cmless.git cmless.subgeniuskitty.com
72chown -R www-data:www-data ./cmless.subgeniuskitty.com
73```
74
5dc44f45
AT
75Clone your content into the site/ folder. If you with to use a different
76folder, edit the configuration options in bin/config.py accordingly. If this is
77your first CMless site, see the site_sample/ folder for an example site using
78Markdown.
a58599ba
AT
79
80```
81cd /mnt/data/apache_vhosts/cmless.subgeniuskitty.com
82git clone your_site_content_repo site
5dc44f45 83chown -R www-data:www-data ./site
a58599ba 84```
5dc44f45
AT
85
86Install an appropriate document processor for your content and set the
87markup_processor configuration option in bin/config.py accordingly. Your markup
88engine should accept text via stdin and output HTML on stdout.
89
90```
91apt-get install discount
92```
93
94Edit bin/config.py and set all configuration options according to the steps
95taken during installation. Each option is commented inside the file.