Merge lp:~jose/charms/precise/kusabax/1297602-fix into lp:charms/kusabax

[José Antonio Rey]

Added maintainer and category, fixed typo on config.yaml, fixed typos on README and reformatted it to Markdown

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.

[lp:~jose/charms/precise/kusabax/1297602-fix]

10. By José Antonio Rey on 2014-03-29

Removed icon as it didn't comply with Charm Store policies

[Charles Butler (lazypower)]

Greetings Jose, Thanks for all the hard work! This merge looks great.

Acked as a +1 for merging.

I'll follow up once this has been merged into upstream.

Thanks again!

[Charles Butler (lazypower)]

Merged!

review: Approve

=== added file 'README.md'
--- README.md	1970-01-01 00:00:00 +0000
+++ README.md	2014-03-29 00:57:04 +0000
@@ -0,0 +1,101 @@
+Kusaba X Juju Charm
+Copyright 2012 by Chris Hardee
+
+# About
+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.
+
+# Tutorial
+First make sure your environment is setup and you have juju installed, please
+see the [juju documentation](https://juju.ubuntu.com/docs/) for help on this.
+
+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.
+
+After juju has been configured, bootstrap it:
+
+    juju bootstrap
+
+(if running a local instance you might need sudo privileges)
+
+Then deploy kusabax, you should do this from the root charm directory
+(ie charmroot/*distros*/kusabax)
+
+    juju deploy --repository=. local:kusabax
+
+Then deploy mysql:
+
+    juju deploy --repository=. local:mysql
+
+Check on the status:
+
+    juju status
+
+When both nodes are up and running, add the relation:
+
+    juju add-relation kusabax mysql
+
+Then expose kusabax:
+
+    juju expose kusabax
+
+Check on that status until the relation is set and everything is running.
+
+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.
+
+## We're not done yet though!
+
+Navigate to manage.php by appending it to the public address
+(e.g. http://23.42.52.232/manage.php).
+
+Login with username: admin password: admin
+
+ 1. On the left side, under Site Administration, click on Staff.
+ 2. Add a new administrator by giving a username, password, leaving the type to
+    administrator, and clicking Add Staff Member.
+ 3. 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.
+
+You are now ready!
+
+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.
+
+When you navigate to the home page, you should see your new board and should be
+able to post. Repeat for other boards/sections.
+
+## Known limitations and issues
+
+This charm will checkout the latest stable release from 
+http://kusabax.cultnet.net/svn/ and installs it to the root /var/www directory.
+
+Currently the script uses the current hostname for all configuration, you might
+get some errors if you want to move to a proper domain (e.g. example.com).
+
+Keep in mind imageboards like these are notorious for cross-site scripting
+attacks, so keep note of current vulnerabilities from the kusabax home page.
+
+# Support
+
+For support on kusabax itself, checked out the
+[support board](http://kusabax.cultnet.net/sup/) and the
+[wiki](http://kusabax.cultnet.net/wiki/).
+
+# Contact Information
+
+Maintainer: Chris Hardee <[e-mail]>
+Report bugs at: https://bugs.launchpad.net/charms
+
+# TODOs
+
+ * More config options
+ * Add postgresql support
+ * Double-check what exactly needs permissions to avoid www-root chmod 777
+ * Add a way to change db relations
+ * Would probably be a good candidate for
+   [apparmor support](https://juju.ubuntu.com/AppArmor)
 
=== modified file 'config.yaml'
--- config.yaml	2012-04-06 00:57:35 +0000
+++ config.yaml	2014-03-29 00:57:04 +0000
@@ -12,6 +12,6 @@
     type: string
     description: Site slogan, set to nothing to disable its display
   style-switcher:
-    defualt: 'true'
+    default: 'true'
     type: boolean
     description: If true, will allow users to change style
 
=== modified file 'metadata.yaml'
--- metadata.yaml	2012-03-27 18:53:41 +0000
+++ metadata.yaml	2014-03-29 00:57:04 +0000
@@ -1,7 +1,10 @@
 name: kusabax
+maintainer: Chris Hardee <[e-mail]>
 summary: "Kusaba X is a continuation of the Imageboard software Kusaba"
 description: |
     Deploys KusabaX
+categories:
+  - applications
 requires:
   db:
     interface: mysql
 
=== removed file 'readme'
--- readme	2012-04-02 08:52:39 +0000
+++ readme	1970-01-01 00:00:00 +0000
@@ -1,67 +0,0 @@
-Kusaba X Juju Charm
-Copyright 2012 by Chris Hardee
-
-About:
-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.
-
-Tutorial:
-First make sure your environment is setup and you have juju installed, please see the juju documentation for help on this:
-https://juju.ubuntu.com/docs/index.html
-
-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.
-
-After juju has been configured, bootstrap it:
-	juju bootstrap
-(if running a local instance you might need sudo privileges)
-
-Then deploy kusabax, you should do this from the root charm directory (ie charmroot/*distros*/kusabax)
-	juju deploy --repository=. local:kusabax
-Then deploy mysql:
-	juju deploy --repository=. local:mysql
-
-Check on the status:
-	juju status
-When both nodes are up and running, add the relation:
-	juju add-relation kusabax mysql
-Then expose kusabax:
-	juju expose kusabax
-
-Check on that status until the relation is set and everything is running.
-
-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.
-
-We're not done yet though!
-
-Naviagate to manage.php by appending it to the public address (ie http://23.42.52.232/manage.php).
-
-Login with username: admin password: admin
-
-On the left side, under Site Administration, click on Staff
-Add a new administrator by giving a username, password, leaving the type to administrator, and clicking Add Staff Member.
-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.
-
-You are now ready!
-
-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.
-When you navigate to the home page, you should see your new board and should be able to post. Repeat for other boards/sections.
-
-Notes:
-This charm will checkout the latest stable release from http://kusabax.cultnet.net/svn/ and install it to the root /var/www directory.
-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.
-Keep in mind imageboards like these are notorious for cross-site scripting attacks, so keep note of current vulnerabilities from the kusabax home page.
-
-Support:
-For support on kusabax itself, checked out the support board:
-http://kusabax.cultnet.net/sup/
-and the wiki:
-http://kusabax.cultnet.net/wiki/
-
-For issues with the charm itself, please contact me at:
[e-mail]
-
-TODOs:
-More config options
-Add postgresql support
-Double-check what exactly needs permissions to avoid www-root chmod 777
-Add a way to change db relations
-Would probably be a good candidate for apparmor support: https://juju.ubuntu.com/AppArmor