statedecoded / statedecoded-vagrant Goto Github PK

Vagrant configuration for State Decoded, to make it easy to get started, in the spirit of GitMachines.

Ruby 37.20% Puppet 47.43% Shell 12.95% HTML 0.81% Pascal 0.16% Vim Script 1.45%

statedecoded-vagrant's Introduction

The State Decoded

What is The State Decoded?

The State Decoded is a free, open source, web-based application to display laws online. Although it's meant for laws, it'll basically work for any structured legal text. It makes legal text searchable, interconnected, and machine-readable, adding an API, bulk downloads, and powerful semantic analysis tools. With The State Decoded, legal codes become vastly easier to read, more useful, and more open. Here's an actual before-and-after from the Code of Virginia:

Can I try it out?

Sure! This project can be seen in action on sites for Virginia, Chicago, San Francisco, and a growing list of others. If you want to install it, you can also download a Vagrant image from GitMachines, or just download and install it from scratch.

Is this ready for prime time?

Quite nearly! The current release is being used in production on a half-dozen different sites, with no serious bugs, and is certainly in good enough shape to be used on websites that aren't official, government-run repositories of the law.

This is a v1.0 release, which is to say that it's functionally complete but may have minor issues. A capable developer who is comfortable with legal terminology should be able to wrangle her laws into this release with a couple of hours of work. There is, however, no built-in upgrade path to new releases. That said, it's easy enough to install a new version and just re-import your site's legal code.

How do get my legal code into The State Decoded?

There are two ways.

Natively, The State Decoded imports XML in The State Decoded XML format. If you have your legal code as XML, you can adapt the provided XSLT to transform it into the proper format. Or if you don't have your legal code as XML, you can convert it into XML.
Skip XML entirely and modify the included parser to import it in the format in which you have it.

Project documentation

Project documentation can be found at docs.statedecoded.com, which explains how to install the software, configure it, customize it, use the API, and more. The documentation is stored as a GitHub project, with its content automatically published via Jekyll, so in addition to reading the documentation, you are welcome to make improvements to it!

How to help

Use State Decoded sites and share your feedback in the form of filing issues—suggestions for new features, notifications of bugs, etc.
Write or edit documentation on the wiki.
Read through unresolved issues and comment on those on which you have something to add, to help resolve them.
Contribute code to fix bugs or add features.
Comb through existing code to clean it up—standardizing code formatting, adding docblocks, or editing/adding comments.

Keep up to date

Follow along on Twitter @StateDecoded, or on the project website at StateDecoded.com.

Supported by

Development of The State Decoded was funded by the John S. and James L. Knight Foundation’s News Challenge.

statedecoded-vagrant's People

Contributors

Stargazers

Watchers

Forkers

datajus aramonc

statedecoded-vagrant's Issues

Creating a CentOS 6 version of statedecoded-vagrant

@waldoj Over here at GitMachines we are creating from ground up a one-click install stated-decoded vagrant version on CentOS.

https://github.com/GitMachines/statedecoded-gm-centos6

Why CentOS instead of Ubuntu?

Bit compatibility with RedHat Enterprise Linux (RHEL) since RHEL is popular with is common/popular among governments and businesses.
We want cities to adopt Statedecoded and RHEL has government acceptance b/c it is built on SELinux (Security Enhanced Linux)
SELinux has elements, like default firewall (/etc/sysconfig/iptables) that Ubuntu does not
OpenSCAP (Security Content Automation Protocols) and base line control configurations already exist for CentOS but do not yet for Ubuntu (from what we can tell). We need SCAP to produce the scans and audit reports to make Statedecoded accreditation-ready.

Why from scratch?

To learn.
To deal easier with CentOS's built-in firewall.
To automate OpenSCAP scanning and reporting.
To see if we can streamline and further automate the install.
To rethink how documentation can be managed and even driven from code.
Because some installations will require the database to be run on a different server from the application and to have other redundancies. We want to understand how to create a path for varying configurations.

Status

Follow along our repo, which will probably have many branches as we experiment. We've made this our main technical focus right now.

Development domains don't work

PuPHPet insists on setting up a VirtualHost, but that necessitates editing /etc/hosts in order to map that virtual host properly. @markjaquith has some localdev Vagrant code that will resolve that. This may, as a result, resolve #1, too.

Update Vagrant and Readme so the development environment actually works.

I just started trying to get this working on my machine. The main problem right now is that a file config.inc.php (for phpmyadmin I assume) is not included in the statedecoded repository. There needs to be an example one included either in this repository or the main php with the nessecary constants filled out. Waldo could you sanitisize yours and push into this repo?

mysqlnd.so missing

Apache is throwing this error:

PHP Startup: Unable to load dynamic library '/usr/lib/php5/20090626/mysqlnd.so

Looks like a missing library.

Are we still updating the vagrant image for 0.8?

If so I can work tomorrow on getting my branch wrapped up. Also when all is said and done we should give a version tag to the statedecoded-vagrant repo in line with the statedecoded release.

Solr installation failing

Something in our Puppet config is no longer working for Solr installation. Looks like wget on the package isn't working.

Include Jetty and Solr via Puppet

@o19s has provided a Puppet module to do just that, so it should be accomplished easily.

Requests are intercepted prior to VirtualHost

Requests are mapped to /var/www/index.html, rather than /var/www/htdocs/, which is to say that the requests aren't making it to the VirtualHost configuration, but are instead being handled by the default Apache server. As a result, nothing works.

Website appears with http://192.168.56.101 but not with http://www.statedecoded.dev

Even with /etc/hosts including references, web site only appears with http://192.168.56.101 and http://www.statdecoded.dev returns default apache page.

/etc/hosts/

# various content...

192.168.56.101  statedecoded.dev  # VAGRANT: 2e293b7cc87633006e057193487decba (default) / 3711e580-44c1-4f7f-97c5-9bd462024e40
192.168.56.101  www.statedecoded.dev  # VAGRANT: 2e293b7cc87633006e057193487decba (default) / 3711e580-44c1-4f7f-97c5-9bd462024e40
192.168.56.101  statedecoded.dev  # VAGRANT: 2e293b7cc87633006e057193487decba (default) / 3711e580-44c1-4f7f-97c5-9bd462024e40
192.168.56.101  www.statedecoded.dev  # VAGRANT: 2e293b7cc87633006e057193487decba (default) / 3711e580-44c1-4f7f-97c5-9bd462024e40

I have to dig into apache configuration to find issue.

Windows installation problems

Running the installation on Windows, the .bash_aliases is throwing an error on line 5, the __has_parent_dir definition, saying unexpected token '$'{\r'', which looks like windows line endings causing havoc. I'm not sure why these would be in there since it should all be VM-side, unless we're doing some copying that could cause it to be written wrong.

Verify devel branch works and merge it into master once 0.8 has been released.

I am going to stop playing around with this until, 0.8 gets tagged and work out issues from there. Right now when I run the vagrant setup process, then run the parser php runs into errors which may or may not be my fault, the fault of the commit I am using or just a bug.

For future reference here is the error:

[Mon Oct 14 19:37:08 2013] [error] [client 192.168.42.1] PHP Stack trace:, referer: http://192.168.42.33/admin/?page=parse&noframe=1
[Mon Oct 14 19:37:08 2013] [error] [client 192.168.42.1] PHP   1. {main}() /var/www/statedecoded/htdocs/index.php:0, referer: http://192.168.42.33/admin/?page=parse&noframe=1
[Mon Oct 14 19:37:08 2013] [error] [client 192.168.42.1] PHP   2. MasterController->execute() /var/www/statedecoded/htdocs/index.php:284, referer: http://192.168.42.33/admin/?page=parse&noframe=1
[Mon Oct 14 19:37:08 2013] [error] [client 192.168.42.1] PHP   3. require() /var/www/statedecoded/includes/class.MasterController.inc.php:48, referer: http://192.168.42.33/admin/?page=parse&noframe=1

Question: Documentation refers to database statedecoded but config.inc.php refers to statelaws

The documentation refers to the database being named statedecoded. However the config-sample.inc.php is hardcoded to statelaws as the name of the database.

Which should be adjusted?