atlas

README

Overview

atlas is a BSD-licensed experimental wiki intended to explore low-latency search, editing, and mapping of the kinds of boundary objects found in complex sociotechnical systems.

Caveats

Warning: as initially published, atlas has known issues, several of which have security implications that may make atlas inappropriate for use in your environment.

Dependencies

atlas:

• build-depends on Golang, sqlite3, and several MIT- and Apache 2.0-licensed Golang libraries including glog, mattn/go-sqlite3, and blackfriday,

• run-depends on etherpad-lite, and

• bundles atom.go, jQuery, svg-edit, and several MIT-licensed jQuery plugins (Chosen, BBQ, and AutoSize).

Use

This repository is intended to be mounted in your GOPATH, presently at $GOPATH/src/akamai/atlas.

For ideas on how to run an atlas instance, please see our example setup.sh script.

Documentation

Overview

Package main calls the atlas web package.

The web package defines the web UI and controllers.

The main package ties the other packages together and configures them via command-line flags.