~aisrael/charms/precise/kusabax/charm-proof

« back to all changes in this revision

Viewing changes to readme

  • Committer: Charles Butler
  • Date: 2014-04-08 01:32:37 UTC
  • mfrom: (8.1.2 kusabax)
  • Revision ID: chuck@dasroot.net-20140408013237-59d2s9whw6qfsio0
[jose] Charmworld reports the following errors:

    err: Charms need a maintainer (See RFC2822) - Name <email>
    warn: Metadata is missing categories.
    warn: No icon.svg file.
    warn: config.yaml: option style-switcher does not have the keys: default
    warn: config.yaml: option style-switcher has unknown keys: defualt

    Fixed all of them. Set the charm author as maintainer as he showed the wish to be so, but didn't know how to fix it (see MP #111982, https://code.launchpad.net/~charmers/charms/precise/kusabax/trunk/+merge/111982). Also reformatted README to Markdown.

Show diffs side-by-side

added added

removed removed

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