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