~george-edison55/charms/precise/uwsgi/trunk

« back to all changes in this revision

Viewing changes to README.md

  • Committer: Nathan Osman
  • Date: 2014-04-05 22:43:22 UTC
  • Revision ID: admin@quickmediasolutions.com-20140405224322-rgfo80emny3wedax
Updated README.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
Describe the intended usage of this charm and anything unique about how
2
 
this charm relates to others here. 
3
 
 
4
 
This README will be displayed in the Charm Store, it should be either Markdown or RST. Ideal READMEs include instructions on how to use the charm, expected usage, and charm features that your audience might be interested in. For an example of a well written README check out Hadoop: http://jujucharms.com/charms/precise/hadoop
5
 
 
6
 
Here's an example you might wish to template off of:
7
 
 
8
 
Overview
9
 
--------
10
 
 
11
 
This charm provides uWSGI from https://github.com/unbit/uwsgi. 
12
 
 
13
 
 
14
 
Usage
15
 
-----
16
 
 
17
 
Step by step instructions on using the charm:
18
 
 
19
 
    juju deploy servicename
20
 
 
21
 
and so on. If you're providing a web service or something that the end user needs to go to, tell them here, especially if you're deploying a service that might listen to a non-default port. 
22
 
 
23
 
You can then browse to http://ip-address to configure the service. 
24
 
 
25
 
Configuration
26
 
-------------
27
 
 
28
 
The configuration options will be listed on the charm store, however If you're making assumptions or opinionated decisions in the charm (like setting a default administrator password), you should detail that here so the user knows how to change it immediately, etc.
29
 
 
30
 
 
31
 
Contact Information
32
 
-------------------
33
 
 
34
 
Though this will be listed in the charm store itself don't assume a user will know that, so include that information here:
35
 
 
36
 
Author:
37
 
Report bugs at: http://bugs.launchpad.net/charms/+source/charmname
38
 
Location: http://jujucharms.com/charms/distro/charmname
39
 
 
40
 
* Be sure to remove the templated parts before submitting to https://launchpad.net/charms for inclusion in the charm store.
 
1
## Overview
 
2
 
 
3
This charm provides uWSGI from https://github.com/unbit/uwsgi.
 
4
 
 
5
## Usage
 
6
 
 
7
This charm is designed to be used with WSGI applications. One example of this
 
8
is the python-django charm. Deploying uwsgi should be as simple as:
 
9
 
 
10
    juju bootstrap
 
11
 
 
12
    juju deploy python-django
 
13
    juju deploy uwsgi
 
14
 
 
15
    juju add-relation python-django uwsgi
 
16
 
 
17
This should result in a fully functional uWSGI installation accessible on the
 
18
unit's pulic IP address. The port will be 8080 unless you have modified the
 
19
default configuration. 
 
20
 
 
21
## Configuration
 
22
 
 
23
There is currently only a single configuration option:
 
24
 
 
25
 - **port** - *set to 8080 by default*
 
26
 
 
27
## Contact Information
 
28
 
 
29
Author(s): 
 
30
 
 
31
 - Nathan Osman <admin@quickmediasolutions.com>
 
32
 
 
33
Report bugs at: http://bugs.launchpad.net/charms/+source/uwsgi
 
34
Location: http://jujucharms.com/charms/precise/uwsgi
 
35
 
41
36