snoyberg/keter
1
1
Fork 0
mirror of https://github.com/snoyberg/keter.git synced 2024-12-14 08:05:40 +03:00
Code Issues Projects Releases Wiki Activity

Doc updates

Browse Source
This commit is contained in:
Michael 2012-09-14 06:26:47 +03:00
parent 4d64ff87de
commit 1e271d81e7
2 changed files with 25 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
README.md
View File

@ -6,17 +6,27 @@ Instructions are for an Ubuntu system. Eventually, I hope to provide a PPA for
this (please contact me if you would like to assist with this). For now, the
following steps should be sufficient:
First, install Nginx and PostgreSQL
First, install PostgreSQL
sudo apt-get install nginx postgresql
sudo apt-get install postgresql
Second, build the `keter` binary and place it at `/usr/bin`. At the time of
writing, a copy of this executable compiled for Ubuntu 12.04 64-bit is
available at:
[http://www.yesodweb.com/static/keter.bz2](http://www.yesodweb.com/static/keter.bz2).
Note that this file may not be available in the future.
Second, build the `keter` binary and place it at `/usr/bin`.
Third, set up an Upstart job to start `keter` when your system boots.
Third, create a Keter config file:
```yaml
# /opt/keter/etc/keter-config.yaml
root: ..
# host: host to bind to
# port: port to listen on
# ssl:
# host:
# port:
# key:
# certificate:
```
Fourth, set up an Upstart job to start `keter` when your system boots.
```
# /etc/init/keter.conf
@ -26,7 +36,7 @@ respawn
console none
exec /usr/bin/keter /opt/keter
exec /usr/bin/keter /opt/keter/etc/keter-config.yaml
```
Finally, start the job for the first time:
@ -46,9 +56,7 @@ args:
host: www.yesodweb.com
```
yesodweb.com uses the following Bash script to create its keter bundle. Going
forward, this will probably be a command available from the `yesod` executable
and part of all scaffolded sites:
A sample Bash script for producing a Keter bundle is:
```bash
#!/bin/bash -ex
@ -59,6 +67,9 @@ rm -rf static/tmp
tar czfv yesodweb.keter dist/build/yesodweb/yesodweb config static
```
For users of Yesod, The `yesod` executable provides a `keter` command for
creating the bundle, and the scaffolded site provides a `keter.yaml` file.
## Deploying
In order to deploy, you simply copy the keter bundle to `/opt/keter/incoming`.
@ -81,10 +92,6 @@ Components:
* Postgres: Ask it for database information for an app. If no information is
available, it will create a database/user.
* Nginx: Send it commands to add/modify/remove a virtual host. It will write
the config file and reload nginx. Also handles management of the pool of open
ports to be assigned.
* TempFolder: Wipes out a folder on startup, then assigns random, unique
folders inside it on request.

4
keter.cabal
View File

@ -1,7 +1,7 @@
Name: keter
Version: 0.2.0.1
Version: 0.2.0.2
Synopsis: Web application deployment manager, focusing on Haskell web frameworks
Description: Handles deployment of web apps, using Nginx as a reverse proxy to achieve zero downtime deployments. For more information, please see the README on Github: <https://github.com/snoyberg/keter#readme>
Description: Handles deployment of web apps, providing a reverse proxy to achieve zero downtime deployments. For more information, please see the README on Github: <https://github.com/snoyberg/keter#readme>
Homepage: http://www.yesodweb.com/
License: MIT
License-file: LICENSE