Permalink
179 lines (126 sloc) 5.17 KB

Publify

The Ruby on Rails publishing software formerly known as Typo

Build Status Code Climate Dependency Status

What's Publify?

Publify is a simple but full featured web publishing software. It's built around a blogging engine and a small message system connected to Twitter.

Publify follows the principles of the IndieWeb, which are self hosting your Web site, and Publish On your Own Site, Syndicate Everywhere.

Publify has been around since 2004 and is the oldest Ruby on Rails open source project alive.

Features

  • A classic multi user blogging engine
  • Short messages with a Twitter connection
  • Text filters (Markdown, Textile, SmartyPants, @mention to link, #hashtag to link)
  • A widgets system and a plugin API
  • Custom themes
  • Advanced SEO capabilities
  • Multilingual : Publify is (more or less) translated in English, French, German, Danish, Norwegian, Japanese, Hebrew, Simplified Chinese, Mexican Spanish, Italian, Lithuanian, Dutch, Polish, Romanian…

Demo site

You can give Publify a try

The login / password to the admin are:

  • Administrator: admin / admin
  • Publisher: publish / publish

The demo is reset every 2 hours.

Install

Download

You can download the latest Publify stable release (8.3.3)

If you want to run the master branch, you can clone the Publify repository. However, random things may be broken there at any time, so tread carefully!

Running the master branch in production is not recommended!

Install Publify locally

To install Publify you need the following:

  • CRuby (MRI) 2.1, 2.2 or 2.3
  • Ruby on Rails 4.2.x
  • A database engine, MySQL, PgSQL or SQLite3
  • A compatible JavaScript installation for asset compilation. See the execjs readme for details.
  • ImageMagick (used by mini_magick).

  1. Unzip Publify archive
  2. Rename database.yml.yourEngine as database.yml
  3. Edit database.yml to add your database name, login and password.
$ bundle install
$ rake db:setup
$ rake db:migrate
$ rake db:seed
$ rake assets:precompile
$ rails server

You can now launch you browser and access 127.0.0.1:3000.

Install Publify on a server

You can use your preferred installation method (e.g., Capistrano) to install Publify on a server. You will also need to set up the environment so it contains at least SECRET_KEY_BASE. Your web server may allow you to set this, or you can consider using a tool like dotenv.

Install Publify on Heroku

In order to install Publify on Heroku, you’ll need to do some minor tweaks.

First of all, you need to setup Amazon S3 storage to be able to upload files on your blog. Set Heroku config vars.

heroku config:set provider=AWS
heroku config:set aws_access_key_id=YOUR_AWS_ACCESS_KEY_ID
heroku config:set aws_secret_access_key=YOUR_AWS_SECRET_ACCESS_KEY
heroku config:set aws_bucket=YOUR_AWS_BUCKET_NAME

To generate the Gemfile.lock, run:

HEROKU=true bundle install

Remove Gemfile.lock from .gitignore and commit it.

Add the HEROKU config variable to your Heroku instance:

heroku config:set HEROKU=true

You also need to set Rails' secret key base. Generate one using rake secret, then set the Heroku config var:

heroku config:set secret_key_base=YOUR_GENERATED_SECRET

Push the repository to Heroku.

When deploying for the first time, Heroku will automatically add a Database plugin to your instance and links it to the application. After the first deployment, don't forget to run the database migration and seed.

heroku run rake db:migrate db:seed

If application error has occurred after migration, you need to restart Heroku server.

heroku restart

Resources

Maintainers

This is a list of Publify maintainers. If you have committed, please add your name and contact details to the list.

Frédéric de Villamil frederic@publify.co blog: http://t37.net irc: neuro`

Matijs van Zuijlen blog: http://www.matijs.net/blog/ irc: matijs

Thomas Lecavelier blog: http://blog.ookook.fr/ irc: ook

Yannick François blog: http://elsif.fr irc: yaf

And many more cool people who’ve one day or another contributed to Publify.

Original Author: Tobias Luetke blog: http://blog.leetsoft.com/ irc: xal

Enjoy, The Publify team