1# Conch API Server
3Conch helps you build and manage datacenters.
5Conch's goal is to provide an end-to-end solution for full datacenter resource
6lifecycle: from design to initial power-on to end-of-life for all components of
9Conch is open source, licensed under MPL2.
11## Caveat Emptor
13At the time of writing, the API is not considered to be stable. While we do our
14best to prevent breakage, the core is in considerable flux and we do not
15guarantee fit or function right now. The [conch
16shell](https://github.com/joyent/conch-shell) is our current stable interface.
20### Operating System Support
22We currently support SmartOS 17.4 and FreeBSD 11.2. Being a Perl app, the API
23should run most anywhere but the code is only actively tested on SmartOS and
26### Perl Support
28The API is only certified to run against Perl 5.26.
32Below is a list of useful Make commands that can be used to build and run the
33project. All of these should be run in the top level directory.
35* `make run` -- Build the project and run it
36* `make test` -- Run tests
37* `make migrate-db` -- Run database migrations
39#### Needed Packages
41* PostgreSQL 9.6.x
43* Perl, 5.26 or above (e.g. via [perlbrew](https://perlbrew.pl/))
48Copy `conch.conf.dist` to `conch.conf`, modifying for any local parameters,
49including database connectivity information.
51### Starting Conch
53* `make run`
57Copyright Joyent, Inc.
59This Source Code Form is subject to the terms of the Mozilla Public License,
60v.2.0. If a copy of the MPL was not distributed with this file, You can obtain
61one at http://mozilla.org/MPL/2.0/.