← Back to branch summary

~marcoceppi/charms/precise/tracks/tests

« back to all changes in this revision

Viewing changes to README.md

  • Committer: Charles Butler
  • Date: 2014-06-09 22:22:25 UTC
  • mfrom: (4.1.12 tracks)
  • Revision ID: chuck@dasroot.net-20140609222225-ypgmrryqlh3d13gh
    José Antonio Rey 2014-05-12 Changed < for -lt
    José Antonio Rey 2014-05-08 Fixed port-changing blocker
    José Antonio Rey 2014-05-08 Fixed problem with brackets and non-executable website-relation...
    José Antonio Rey 2014-05-08 Fixed redundancy
    José Antonio Rey 2014-05-08 Fixed a problem with ports check
    José Antonio Rey 2014-05-08 Fixed some bugs
    José Antonio Rey 2014-05-07 Fixed all errors, ready for review
    José Antonio Rey 2014-05-06 Fixed some bugs, still need to fix upstart job
    José Antonio Rey 2014-05-06 Added upstart job
    José Antonio Rey 2014-05-06 Fixed various bugs
    José Antonio Rey 2014-04-15 Added support to change port number
    José Antonio Rey 2014-04-15 Converted README to Markdown

Show diffs side-by-side

added added

removed removed

Lines of Context:
README.md
 
1
# Overview
 
2
 
 
3
Tracks is a Ruby on Rails based web service that helps you to manage to do lists
 
4
and get things done (GTD). Tracks is based on David Allen's Get Things Done (TM)
 
5
methodology.
 
6
 
 
7
Please note that this charm uses the brightbox/ruby-ng PPA in order to get a
 
8
newer version of Ruby.
 
9
 
 
10
# Usage
 
11
 
 
12
To deploy:
 
13
 
 
14
     juju bootstrap
 
15
     juju deploy tracks
 
16
     juju deploy mysql
 
17
     juju add-relation mysql tracks
 
18
     juju expose tracks
 
19
 
 
20
Then do a `juju status` to determine the IP of the service, and just open it in
 
21
your browser. On the initial screen you can create your user, then sign-in and
 
22
begin using Tracks. It uses a built-in webserver, WEBrick.
 
23
 
 
24
## Configuration
 
25
 
 
26
This charm offers one configuration option, the port on which to run the web
 
27
server, default is 3000. At this point, it can not be ran in a port minor to
 
28
1025. If you set a port lower or equal to 1024, it will refuse to install
 
29
until you change it. If you want to use port 80, for example, you can add a
 
30
reverse proxy server, such as haproxy (also available in Juju).
 
31
 
 
32
# Known Limitations
 
33
 
 
34
As mentioned in the configuration part, the charm does not currently allow a
 
35
port number lower than 1025.
 
36
 
 
37
# Links
 
38
 
 
39
- Homepage: <http://getontracks.org/>
 
40
- Code: <https://github.com/TracksApp/tracks>