Skip to content
Ian Monroe edited this page Jun 18, 2018 · 4 revisions

Welcome to the Coldreader wiki!

Over the coming weeks, documentation is going to start appearing here with information about how to do some custom development with Coldreader.

What is Coldreader

Installation

Coldreader is based on Laravel 5.6, and requires a server that is capable of serving a Laravel project.

For specific information about server requirements, see the Laravel docs.

The Homestead vagrant box works just fine with Coldreader, and you can try it out in your local environment with no risk. For more information about using Laravel Homestead, check out their fantasic documentation.

Once you have an environment set up, you'll want to create a directory to hold the project, and an empty database. Make sure you note the credentials you set up for the database to make installation easy.

The simple way to install everything is to use Composer. If you plan on developing with Coldreader, you are encouraged to use the Git method.

Via Composer:

$ cd /wherever/you/want/to/install/
$ composer create-project imonroe/coldreader .

Follow the prompts.

Via Git

$ cd /wherever/you/want/to/install/
$ git clone https://github.com/imonroe/coldreader.git .

Wait for the installation to complete. Then run:

$ php firstrun.php

Follow the prompts.

The configuration script will ask if you'd like to install the npm dependencies. If you are planning on developing with Coldreader, you may want to do that now. It can take some time, however, and can safely be skipped if you're just trying out the software.

Installing additional add-ons

One of the nice things about Coldreader is that it's easy to create new Aspect Types and Search Providers to accomodate different kinds of data, and different ways of displaying it. There are some Aspect Types already available to try.

To install Coldreader add-on packages, use composer:

$ composer require <vendor>/<package_name>
$ composer update

Some add-on packages may require additional configuration. Consult the package repo for details for any individual add-on.

Add-ons currently available:
  • COMING SOON!

Upgrading

Upgrading is a simple matter of using composer to get the most recent version.

$ composer update

Configuration

Storage

By default, Coldreader will attempt to symlink the /storage directory to /public/storage. On Homestead/Vagrant virtual machines in a Windows environment, this can throw a 'protocol error' with the simlinking process during installation. To get around this limitation on Windows, make sure you start your virtual machine as an Administrator.

Coldreader includes the Flysystem package from the PHP League. That means you can use any additional storage systems you wish (e.g., Amazon S3, Google Drive, Dropbox, SSH, etc.) Consult the Laravel documentation for more information on configuring remote filesystems.

You can’t perform that action at this time.