README.rdoc
changeset 9 47425483883e
parent 8 1ad0d5bc5083
child 10 8388c2d1d7af
equal deleted inserted replaced
8:1ad0d5bc5083 9:47425483883e
     1 = Thingfish PostgreSQL Metastore
       
     2 
       
     3 * http://bitbucket.org/mahlon/thingfish-metastore-pggraph
       
     4 
       
     5 == Description
       
     6 
       
     7 This is a metadata storage plugin for the Thingfish digital asset
       
     8 manager.  It provides persistent storage for uploaded data to a
       
     9 PostgreSQL table.
       
    10 
       
    11 It is heavily based on the regular PG metastore, however it differs by
       
    12 storing objects as nodes, and their relations as edges.
       
    13 
       
    14 
       
    15 == Authors
       
    16 
       
    17 * Michael Granger <ged@FaerieMUD.org>
       
    18 * Mahlon E. Smith <mahlon@martini.nu>
       
    19 
       
    20 
       
    21 == Installation
       
    22 
       
    23     $ gem install thingfish-metastore-pggraph
       
    24 
       
    25 
       
    26 ==  Usage
       
    27 
       
    28 As with Thingfish itself, this plugin uses
       
    29 Configurability[https://rubygems.org/gems/configurability] to modify
       
    30 default behaviors.
       
    31 
       
    32 Here's an example configuration file that enables this plugin.
       
    33 
       
    34 	---
       
    35 	thingfish:
       
    36 	  metastore: pggraph
       
    37 
       
    38 	pggraph_metastore:
       
    39 	  uri: postgres://thingfish:password@db.example.com/database
       
    40 
       
    41 
       
    42 When Thingfish starts, it will install the necessary database schema
       
    43 automatically.
       
    44 
       
    45 
       
    46 == License
       
    47 
       
    48 Copyright (c) 2014-2015, Michael Granger and Mahlon E. Smith.
       
    49 
       
    50 All rights reserved.
       
    51 
       
    52 Redistribution and use in source and binary forms, with or without modification, are
       
    53 permitted provided that the following conditions are met:
       
    54 
       
    55 * Redistributions of source code must retain the above copyright notice, this
       
    56   list of conditions and the following disclaimer.
       
    57 
       
    58 * Redistributions in binary form must reproduce the above copyright notice, this
       
    59   list of conditions and the following disclaimer in the documentation and/or
       
    60   other materials provided with the distribution.
       
    61 
       
    62 * Neither the name of the authors, nor the names of its contributors may be used to
       
    63   endorse or promote products derived from this software without specific prior
       
    64   written permission.
       
    65 
       
    66 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
       
    67 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
       
    68 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
       
    69 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
       
    70 CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
       
    71 EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
       
    72 PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
       
    73 PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
       
    74 LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
       
    75 NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
       
    76 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
       
    77