CSP MySQL User Manager - ReadMe
-------------------------------

C.M.U.M. is a user manager for CardserverProxy (CSP) with a PHP frontend. It uses mySQL to store user
accounts and info and can easily be setup with CSP in under 5 minutes.

Requirements
------------
* A fully functional csp up and running (0.8.13 or later) (could work with older versions, but are not tested)
* Apache or IIS with PHP support (or any other webserver that support PHP)
* MySQL (version 5 or later)


Installation
------------
1. Import cmumdb.sql to your mysql db
2. Upload all the files from the 'www' folder to you webserver
3. Edit config.example.php with you mysql info and rename it to config.php
4. Edit /genxml/genxml.php with the same mysql info
5. Configure csp to fetch users from /genxml/genxml.php file (more info below)
6. Browse to your server where you uploaded the files and start using it

!!! Default user is 'admin' and password is 'password' (without the '') !!!

CSP config example for use on a local webserver:
<user-manager class="com.bowman.cardserv.XmlUserManager" allow-on-failure="false" log-failures="true">
<auth-config>
<update-interval>5</update-interval>
<user-source name="genxmloutput">
<user-file-url>http://some.webserver/genxml/genxml.php</user-file-url>
</user-source>
</auth-config>
</user-manager>

CSP config example for use on a remote (or local) secure webserver:
<user-manager class="com.bowman.cardserv.XmlUserManager" allow-on-failure="false" log-failures="true">
<auth-config>
<update-interval>5</update-interval>
<user-source name="genxmloutput">
<user-file-url>http://user:password@some.safe.webserver/genxml/genxml.php</user-file-url>
</user-source>
</auth-config>
</user-manager>


Upgrading 2.x to latest version
-------------------------------
1. Remove all old files, except config.php
2. Upload all the files from the 'www' folder to you webserver
3. Edit genxml.php in the genxml folder on your webserver with your sql info
4. Browse to upgrade.php and follow the steps to upgrade your database


Upgrading v1.x to v2.x
----------------------
Since there are to many changes to the database since v1.0, i decided not to make
it upgrade able. So to upgrade from v1.0 to v2.0, follow these simple steps:

1. Place csvexport.php in your current c.m.u.m install dir
2. Browse to the file and copy the csv output
3. Remove all old files and database tables
4. Follow the installation steps
5. Add your profiles to the profile manager (csp value must match profiles used on exported users)
6. Use the 'Import users (CSV)' tool to import your users


Security Tip
------------
If you are running c.m.u.m on a remote server then you might wanna secure the /genxml/ dir
with a .htaccess file, or in security settings if you are using IIS.


Contact me
----------
If you find any bugs, got an idea or just wanna say "Hi!", send me a email on
dukereborn@gmail.com or find me on some forum. You can also follow me on twitter
for updates and news about the development on cmum http://www.twitter.com/dukereborn/


Donations
---------
If you like cmum and all the work I have put into it, consider donating a buck or two, or so :)
All donations are welcome through paypal to account dukereborn@gmail.com


Last words
----------
Please use a modern browser like google chrome, mozilla firefox or safari. If it looks like
hell in internet explorer, well that's just the way it will be.