← Back to branch summary

~jose/charms/precise/kusabax/1297602-fix

« back to all changes in this revision

Viewing changes to README.md

  • Committer: José Antonio Rey
  • Date: 2014-03-26 03:37:18 UTC
  • Revision ID: jose@ubuntu.com-20140326033718-1f14jh2p1w4euuvt
https://launchpad.net/bugs/1297602
Added icon and category, fixed typo on config.yaml, fixed typos on README and reformatted it to Markdown

Show diffs side-by-side

added added

removed removed

Lines of Context:
README.md
 
1
Kusaba X Juju Charm
 
2
Copyright 2012 by Chris Hardee
 
3
 
 
4
# About
 
5
This charm is used to deploy a fully usable Kusaba X imageboard instance without
 
6
any user interaction. This is a great charm to deploy if you want a
 
7
2ch/4chan-style imageboard but are not up to speed on server installation etc.
 
8
 
 
9
# Tutorial
 
10
First make sure your environment is setup and you have juju installed, please
 
11
see the [juju documentation](https://juju.ubuntu.com/docs/) for help on this.
 
12
 
 
13
Edit the config.yaml, and change anything you'd like. Please be careful when
 
14
changing the slogan value, as some characters will break the scripts. As of now,
 
15
don't use pipes '|' or single-quotes.
 
16
 
 
17
After juju has been configured, bootstrap it:
 
18
 
 
19
    juju bootstrap
 
20
 
 
21
(if running a local instance you might need sudo privileges)
 
22
 
 
23
Then deploy kusabax, you should do this from the root charm directory
 
24
(ie charmroot/*distros*/kusabax)
 
25
 
 
26
    juju deploy --repository=. local:kusabax
 
27
 
 
28
Then deploy mysql:
 
29
 
 
30
    juju deploy --repository=. local:mysql
 
31
 
 
32
Check on the status:
 
33
 
 
34
    juju status
 
35
 
 
36
When both nodes are up and running, add the relation:
 
37
 
 
38
    juju add-relation kusabax mysql
 
39
 
 
40
Then expose kusabax:
 
41
 
 
42
    juju expose kusabax
 
43
 
 
44
Check on that status until the relation is set and everything is running.
 
45
 
 
46
Grab the public address from the status output and paste it into your browser.
 
47
If everything went ok, then you should see the basic kusaba x imageboard ready
 
48
to go.
 
49
 
 
50
## We're not done yet though!
 
51
 
 
52
Navigate to manage.php by appending it to the public address
 
53
(e.g. http://23.42.52.232/manage.php).
 
54
 
 
55
Login with username: admin password: admin
 
56
 
 
57
 1. On the left side, under Site Administration, click on Staff.
 
58
 2. Add a new administrator by giving a username, password, leaving the type to
 
59
    administrator, and clicking Add Staff Member.
 
60
 3. Log off, then renavigate to the manage.php site and log in with the new
 
61
    user. If everything went ok, then Delete the old default Admin user.
 
62
 
 
63
You are now ready!
 
64
 
 
65
Remember to add a board under Boards Administration, then go to Edit Section and
 
66
Add Section, then finally under Board options select the new board you just made
 
67
and change the Section drop-down to the new section.
 
68
 
 
69
When you navigate to the home page, you should see your new board and should be
 
70
able to post. Repeat for other boards/sections.
 
71
 
 
72
## Known limitations and issues
 
73
 
 
74
This charm will checkout the latest stable release from 
 
75
http://kusabax.cultnet.net/svn/ and installs it to the root /var/www directory.
 
76
 
 
77
Currently the script uses the current hostname for all configuration, you might
 
78
get some errors if you want to move to a proper domain (e.g. example.com).
 
79
 
 
80
Keep in mind imageboards like these are notorious for cross-site scripting
 
81
attacks, so keep note of current vulnerabilities from the kusabax home page.
 
82
 
 
83
# Support
 
84
 
 
85
For support on kusabax itself, checked out the
 
86
[support board](http://kusabax.cultnet.net/sup/) and the
 
87
[wiki](http://kusabax.cultnet.net/wiki/).
 
88
 
 
89
# Contact Information
 
90
 
 
91
Maintainer: Chris Hardee <shazzner@gmail.com>
 
92
Report bugs at: https://bugs.launchpad.net/charms
 
93
 
 
94
# TODOs
 
95
 
 
96
 * More config options
 
97
 * Add postgresql support
 
98
 * Double-check what exactly needs permissions to avoid www-root chmod 777
 
99
 * Add a way to change db relations
 
100
 * Would probably be a good candidate for
 
101
   [apparmor support](https://juju.ubuntu.com/AppArmor)