Skip to content
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
lib
 
 
 
 
t
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Build Status Docker build status

Tuvix

Tuvix is a top modern social media weblog software based on Plerd (Ultralight Dropbox-friendly Markdown-based blogging), except instead of rendering a static site like Plerd does, it uses Mojolicious (An amazing real-time web framework) to render a dynamic web page. This means that infinite scrolling and other great stuff works out of the box (but could potentially be turned of in favour of more traditional pagination in a future release version). Furthermore, while Plerd is ultralight Tuvox is more focused on being (somewhat) feature-rich, (atleast feature-richer) for example it supports the powerful Instaplerd extension, so that you swiftly can spin up a photoblog (or rather a hybrid, since it'll accept markdown and jpegs both as source files)

How to install

curl -fsSL https://cpanmin.us | perl - --installdeps .
perl Makefile.PL
make
make test
# make install

Demo

docker run -p 8080:8080 doddo/tuvix

and then visit http://localhost:8080

How it works

It works much the same as Plerd does: a designated "source" directory is listened to for changes, so that if a new file is dropped in there, if it's of appropriate type (a markdown file (but can be extended to support any source format)), then it will be published into a blog post immediatly (or periodically if run from a cron job)

A difference though from Plerd, is that instead of rendering the Plerd::Posts into a static html document, it stores it in a Database. Likely it will work with any database which can be managed by DBIx::Class (but that might require extra modules), but Sqlite is the "supported" one (insofar as any such thing as support can be talked about in this context).

This means that you can have the sqlite3.db file hosted near the source file in a directory mounted from dropbox for example.

Project status

It works, as you can see on my personal photo blog which uses vanilla Tuvix plus an extension called InstaPlerd to create the pictures.

However it is not stable yet, and still under heavy development. GA and initial release version is planned for Q4 2019.

More extensive documentation

There are some intraductory instructions here, which detail how to run tuvix in concert with Dropbox, as well as some notes on running tuvix behind a reverse proxy (nginx or apache2) (to terminate SSL usw.)

Other notes on composing posts are pretty much the same as for plerd.

How to run

Besides from running it in the docker container, you can fire up the app in two simple steps. First is editing tuvix.conf to add some config directives (which will soon be documented), then deploy the SQL schema aswell as publish the source directory with:

$ script/plerdall_db.pl --config /home/petter/git/tuvix/tuvix.conf \
    --deploy-schema \
    --drop-tables

Then finally start it either through plain script/tuvix daemon or for production sites with hypnotoad like this:

$ hypnotoad script/tuvix
Starting hot deployment for Hypnotoad server 32023.

Start the job queue

Webmention support as well as other such relatively slow tasks are managed with Minion job que and associated workers.

It is started as a separate process like so:

script/tuvix minion worker

Jobs such like processing incoming webmentions are jobs which gets automatically enqueued if recieve_webmentions is set to something which Perl evaluates to "true", like 1.

LICENSE

Copyright (C) Petter H

This library is released under the MIT license.

AUTHOR

Petter H dr.doddo@gmail.com

CREDITS

  • Jason McIntosh: Most of the templates have been ported from Plerds templates which is originally written by Jason McIntosh. They have been re-written from .tt => .ep format but has in time diverged from the look and feel of Plerd into something with a slightly bluer hue. (They have diverged in other ways aswell, such like been migrated to Bootstrap 4). Also a variant of the Web::Mention module (also by Jason McIntosh) have been shoehorned into this project. It has been made to use Mojo::UserAgent in stead of LWP::UserAgent, (mainly because it is easier to test this app with it).

About

A top modern top notch dynamic lightweight Dropbox friendly weblog software based on Plerd + Mojo

Resources

License

Releases

No releases published

Packages

No packages published