No Description

George Baugh ebeedebb90 Better running on sock 5 months ago
.github d5bab21dcd Create Funding.yml 3 years ago
bin ebeedebb90 Better running on sock 5 months ago
config 056236bae5 Fix #295 8 months ago
etc 6ca7a50bb8 Reload, not restart, other fix 8 months ago
fail2ban 7e8f6a6e3e ha ha ha 6 months ago
images 26aa721b81 added a readme for buildah 3 years ago
lib ac1157cb26 better validation 5 months ago
mail 455f8d39ef More tweaks to dkimming 5 months ago
nginx 0dbce71ae0 Modify tcms service, expect to run on an AF_UNIX socket now 5 months ago
schema aa6fe44864 fix change_request_full 6 months ago
service-files 0dbce71ae0 Modify tcms service, expect to run on an AF_UNIX socket now 5 months ago
t 97edb9e0b5 unit tests yay 2 years ago
ufw 0dbce71ae0 Modify tcms service, expect to run on an AF_UNIX socket now 5 months ago
www ac1157cb26 better validation 5 months ago
.gitignore 0dbce71ae0 Modify tcms service, expect to run on an AF_UNIX socket now 5 months ago
.perltidyrc 4579c59c1c Mass Tidy 10 months ago
CHANGELOG aa68fc34ab removed -x 3 years ago
Dockerfile d1133dca24 remove bad make target from makefile 2 years ago
Dockerfile.build 5074e5a975 remove unneeded AS statements 3 years ago
Installer.mk 0dbce71ae0 Modify tcms service, expect to run on an AF_UNIX socket now 5 months ago
LICENSE aa68fc34ab removed -x 3 years ago
Makefile.PL 455f8d39ef More tweaks to dkimming 5 months ago
Readme.md 88a83fe6ac Just move the makefile, update readme to use -f 7 months ago
call.pl 734ac51eb7 Mass tidy 8 months ago
docker-exfil.sh c76fee1fe6 make docker exfil work on windows mingw 3 years ago
dockerdeploy.sh 5b2f374b4a Fix #171 3 years ago
fulldeploy.sh 9933224850 set +x on fulldeploy 3 years ago
package-lock.json e6afa02bec Work towards #164: Add means of transforming renders into emails 2 years ago
package.json e6afa02bec Work towards #164: Add means of transforming renders into emails 2 years ago
profile.sh 54842cc739 Massive speedups with memoization 2 years ago
tcms ebeedebb90 Better running on sock 5 months ago
tcms-uwsgi ebeedebb90 Better running on sock 5 months ago

Readme.md

tCMS

A flexible perl CMS which supports multiple data models and content types

Deployment is currently:

  • make -f Installer.mk depend
  • make -f Installer.mk install

Then:

  • Set up proxy rule in your webserver
  • open tmux or screen
  • starman -p $PORT www/server.psgi OR (if you want tCMS as a systemd service for the current user):
  • PORT=$PORT make install-service

$PORT being whatever port you want it to sit on.

A Dockerfile and deployment scripts are provided for your convenience in building/running containers based on this:

# Build and run the server
./fulldeploy.sh
# Just run the server with latest changes
./dockerdeploy.sh
# Extract configuration & local data, then spin down the server
./docker-exfil.sh

The user guide is self-hosted; After you first login, hit the 'Manual' section in the backend.

Rate-Limiting is expected to be handled at the level of the webserver proxying requests to this application.

Migration of tCMS1 sites

See migrate.pl, and modify the $docroot variable appropriately

Content Types

Content templates are modular. Add in a template to /templates/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.

Currently supported:

  • Microblogs
  • Blogs
  • Files (Video/Audio/Images/Other)
  • About Pages
  • Post Series

Planned development:

  • Presentations
  • Test Plans / Issues (crossover with App::Prove::Elasticsearch)

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

  • DUMMY - A JSON blob. Used for testing mostly, but could be handy for very small sites.
  • Flat File - Pretty much the tCMS1 data model; a migration script is forthcoming

Planned Development:

  • Elasticsearch - Documents are ideally indexed in a search engine, should be nice and fast too.
  • Git - More for the APE crossover

Supported PSGI servers

Starman and uWSGI

In production, I would expect you to run under uWSGI, and the tcms command in the TLD runs this. Otherwise, you can run www/server.psgi to start starman normally.

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