← 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:25:32 UTC
  • Revision ID: paul.gear@canonical.com-20141117032532-se85622n97x4se60
Add warning about certificate change

Show diffs side-by-side

added added

removed removed

Lines of Context:
README.md
 
1
# Overview
 
2
 
 
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.
 
6
 
 
7
# Usage
 
8
 
 
9
To use this charm, run:
 
10
 
 
11
    juju deploy quassel-core
 
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.
 
22
 
 
23
WARNING: If you're upgrading from a previous version of this charm, if your
 
24
existing certificate does not match the key size specified in the
 
25
configuration options (2048 bits, by default), your existing certificate
 
26
will be removed and recreated, resulting in a certificate mismatch warning
 
27
on the client.
 
28
 
 
29
# Configuration
 
30
 
 
31
Configuration options are documented in config.yaml.
 
32
 
 
33
# Contact Information
 
34
 
 
35
- Copyright (c) 2014, Canonical Ltd.
 
36
- License: GPLv3
 
37
- Maintainer: Paul Gear <https://launchpad.net/~paulgear>
 
38
- Upstream website: http://quassel-irc.org/
 
39
- Upstream bug tracker: http://bugs.quassel-irc.org/projects/quassel-irc 
 
40
- Upstream source code: http://github.com/quassel/quassel
 
41
 
 
42
# To do
 
43
 
 
44
- Check certificate validity length and change the cert if it has changed;
 
45
  at present, the validity is only set on unit install, meaning that if you
 
46
  want to change it, you must deploy the service, destroy the first unit and
 
47
  associated machine, then create a new unit; alternatively, assuming your
 
48
  environment is not lightning fast, you can set the preferred options using
 
49
  juju set while the first machine for the service is installing.
 
50
 
 
51
- Currently, all of the juju hook scripts run with 'set -x' enabled.  Once
 
52
  this charm has received an appropriate level of testing, this needs to be
 
53
  disabled and the hook scripts modified to use juju-log instead.
 
54