tCMS

tCMS

A flexible perl CMS which supports multiple data models and content types. Should be readily portable/hostable between any other system that runs tCMS due to being largely self-contained.

tCMS is built to be run by tPSGI.

Simple deployment is currently:

• make -f Installer.mk depend
• make -f Installer.mk install
• Setup tPSGI (supposing this clone is in a subdir tCMS of the tPSGI clone):

.tpsgi.conf :

http_user=www-data
user=INSERT_MY_USERNAME_HERE
domain=INSERT_MY_DOMAIN_NAME_HERE
routers=tCMS/lib/TCMS.pm
indices=
custom_log="/var/log/www/tpsgi.log"
basedir="tCMS"

Then:

• open tmux or screen
• HOME=. bin/tpsgi -p 5001

You won't want to run like this in production, but this is probably how you want to develop your themes or hack on tCMS itself.

Production Deployment

See trog-provisioner & related provisioners repository.

In the latter you will be interested particularly in:

• Provisioner::Recipe::tcms
• Provisioner::Recipe::tpsgi
• Provisioner::Recipe::nginxproxy

Many of the advanced features of tCMS won't work quite right without the configurations encoded therein.

Content Types

Content templates are modular. Add in a template to www/templates/html/components/forms which describe the content and how to edit it. Our post data storage being JSON allows us the flexibility to have any kind of meta associated with posts, so go hog wild.

You describe the type of data provided in a sidecar JSON file alongside the form's template. There's a wizard you can use to build these!

From there you make Series of the content type you want; tag the series with 'topbar' if you want it to show up in the top links.

Currently supported:

• Microblogs
• Blogs
• Files (Video/Audio/Images/Other)
• About Pages
• Presentations Virtualization Data:
• Hypervisors
• Guests

Embedding Posts within other Posts

If you know a Post's ID (see the numbers at the end of it's URI when viewing it's permalink denoted by the chain emoji) You can embed template logic into your posts like so:

<: embed(12345, 'embed') :>

The first parameter is the ID number of the post. The second parameter is the formatting style:

• embed : default, shows the post with a recessed border as an excerpt.
• media : only show media portion of the post, if any.
• inline : show everything about the post, save for the title.

These will be added as classes to the embedded post, so you can theme this appropriately.

Data Models

Posts are normally stored as a file somewhere.

• DUMMY - A JSON blob. Used for testing mostly, but could be handy for very small sites.
• Flat File - Pretty much the tCMS1 data model, but with an SQLite index bolted on.

Data Sources

Sometimes you want to consider something else authoritative that isn't a datamodel under our control.

• Virt - Talk to a libvirt HV to list guests.

Components

Sometimes you re-use a template a lot. Sometimes it also needs special handling. This is when you write a 'component'. Example:

Trog::Component::EmojiPicker -> renders www/templates/html/components/emojis.tx

A component is a module in the Trog::Component namespace with a render(%args) method returning a string. Templates call it by name:

<: component('EmojiPicker') :>
<: component('Gallery', { album => $post.id, cols => 3 }) :>

The optional hash is flattened into the component's render(); nullary components ignore it. Output comes back marked raw, so no | mark_raw is needed. Routes don't have to know a component exists -- the template asks for what it wants.

The page furniture is built this way: Header, Footer, HtmlTitle, MidTitle, TopBar, LeftBar, RightBar, FootBar and CategoryBar are what index.tx is made of, and PostHeader/PostFooter are the per-series header and footer posts.tx pulls in.

Ideas to come:

domain picker at top -- manage all your web properties from one place

login and registration (forces email for a domain to allow posting on said domain) User data also stored in ES -- it's their profile page!

Error and Access logs immediately dumped into ES for EZ viewing in grafana

Automatic analytics!

Multiple auth models (ldap, oauth etc)

Builtin paywall -- add in LDAP users not on primary domain, give differing privs Have all content able to assign to paywall packages

One click share to social via oauth Mailing list blasts for paywall content