← Back to branch summary

~paulgear/charms/trusty/quassel-core/trunk

« back to all changes in this revision

Viewing changes to README.md

  • Committer: Paul Gear
  • Date: 2014-11-17 03:06:13 UTC
  • Revision ID: paul.gear@canonical.com-20141117030613-3tizbs0rhchwmlzx
Reformat and update documentation

Show diffs side-by-side

added added

removed removed

Lines of Context:
README.md
1
1
# Overview
2
2
 
3
 
This is the core (server) component of [Quassel](http://quassel-irc.org/), a modern, cross-platform, distributed IRC platform.
4
 
One or more Quassel clients can attach to and detach from this central core.
 
3
This is the core (server) component of [Quassel](http://quassel-irc.org/), a
 
4
modern, cross-platform, distributed IRC platform.  One or more Quassel
 
5
clients can attach to and detach from this central core.
5
6
 
6
7
# Usage
7
8
 
8
9
To use this charm, run:
9
10
 
10
11
    juju deploy quassel-core
11
 
 
12
 
Once the unit has deployed successfully, you can open your quassel client (e.g. the Ubuntu package quassel-client) to connect to your
13
 
quassel-core unit's address on the configured port (default 4242) and configure the service.
 
12
    juju expose quassel-core
 
13
 
 
14
Once the unit has deployed successfully, you can open your quassel client
 
15
(e.g. the Ubuntu package quassel-client) to connect to your quassel-core
 
16
unit's address on the configured port (default 4242) and configure the
 
17
service.
 
18
 
 
19
WARNING: The first user to connect to the quassel-core installation after it
 
20
is exposed will be prompted to configure the service, and will gain
 
21
administrative privileges over the quassel-core installation.
14
22
 
15
23
# Configuration
16
24
 
18
26
 
19
27
# Contact Information
20
28
 
 
29
- Copyright (c) 2014, Canonical Ltd.
 
30
- License: GPLv3
21
31
- Maintainer: Paul Gear <https://launchpad.net/~paulgear>
22
32
- Upstream website: http://quassel-irc.org/
23
33
- Upstream bug tracker: http://bugs.quassel-irc.org/projects/quassel-irc 
24
34
- Upstream source code: http://github.com/quassel/quassel
25
35
 
26
 
# To do list
27
 
 
28
 
- Testing; I don't know if this actually works.
29
 
- Actually implement the configuration items; at the moment, they're all ignored.
30
 
- The lack of control that the quassel-core package provides over certificate parameters (files/postinst is a reference copy of the postinst
31
 
  file from the .deb package) means that we need to take certificate generation into our own hands and make something more flexible.
 
36
# To do
 
37
 
 
38
- Check certificate validity length and change the cert if it has changed;
 
39
  at present, the validity is only set on unit install, meaning that if you
 
40
  want to change it, you must deploy the service, destroy the first unit and
 
41
  associated machine, then create a new unit; alternatively, assuming your
 
42
  environment is not lightning fast, you can set the preferred options using
 
43
  juju set while the first machine for the service is installing.
 
44
 
 
45
- Currently, all of the juju hook scripts run with 'set -x' enabled.  Once
 
46
  this charm has received an appropriate level of testing, this needs to be
 
47
  disabled and the hook scripts modified to use juju-log instead.
 
48