Setup the AMS

Configuring and running the Account Management System

Location of the AMS code

You should have 2 AMS related folders located at code/ryzom/tools/server, namely:

  • ryzom_ams (the system)
  • ryzom_ams_docs (documentation)

If you want information about the design, take a look at the page AMS Design Info

Prerequisites

It is assumed you have already setup the shard server by following Configure Linux Web Services

Preparing packages

The following packages are required to enjoy the entire functionality of the AMS.

In case you don't plan to support the email functionality, which is by default set to false ($TICKET_MAILING_SUPPORT = false; in the config.php file), you will only need the php an mysql related packages and ignore IMAP, Postfix and Dovecot

PHP and Mysql

Normally you should have already set up the server by following the instructions of Configure Linux Web Services or those specific for another OS.

This is important because this project is written in PHP and therefore needs the php related packages. These were installed by using the following command listed in the server setup guide(therefore you do not need to install it again):

sudo apt-get install apache2 php5 php5-mysql php5-gd rrdtool screen

IMAP

IMAP is needed for fetching incoming emails you will need to install the following package:

sudo apt-get install php5-imap

Postfix

Postfix is used as mail server (e.g: for sending out emails, when someone replies on a user his ticket). If you don't like to use postfix, you can always use another service that supports 'sendmail'.

you can install Postfix by running the following command:

sudo apt-get install postfix

Afterwards you can configure it by following for example the instructions at https://www.digitalocean.com/community/articles/how-to-install-and-setup-postfix-on-ubuntu-12-04

Dovecot (optional)

Dovecot is a IMAP/POP3 Server, which we used to receive new emails sent to a support group of our AMS. This is optional, because it's perfectly possible to use gmail accounts or any other IMAP supporting mail accounts instead.

You can install and configure dovecot by following the instructions at https://help.ubuntu.com/community/Dovecot

 

Change the configuration settings

Now open ryzom_ams/www/config.php and change the following settings if needed.

  • The $cfg['db']['web'] refers to the location of the websites mysql database, the port, the username and matching password.
  • The $cfg['db']['lib'] refers to the location,port, username and password for the database that stores all ticketing related info.
  • The $cfg['db']['shard'] refers to the db info of your running shard.
  • The $cfg['db']['ring'] refers to the open_ring database.

In case you plan to support the email functionality you should set the $TICKET_MAILING_SUPPORT to true.

you might want to set the email related info after getting the site up and running

The $cfg['mail'] array holds information about the default email address, people with non-specific questions should email to this adress (most likely its something like support@ryzomcore.org). In case you don't plan to support mailing you can ignore this setting, else fill in the email addres, username, password and connection string for the mailserver, if you use a gmail account it will probably be {imap.gmail.com:993/imap/ssl}INBOX. If you have dovecot up and running, you might use {localhost:995/imap/ssl/novalidate-cert}INBOX

$MAIL_DIR refers to the location where email backups should be placed, this way you always have a local backup of the received email. $MAIL_LOG_PATH refers to a file path where the log of the mail cron job should be stored. The default setting is the following:

$MAIL_DIR = "/home/username/mail";
$MAIL_LOG_PATH = "/home/username/mail/cron_mail.log";

You will have to make sure that the path exists! This means in our scenario that you'll have to create a new directory 'mail' for it!

The $BASE_WEBPATH and $IMAGELOC_WEBPATH have to be changed and should point to the url that brings you to the website, this could be http://shard.ryzomcore.org/ams/ for the base webpath and  http://shard.ryzomcore.org/ams/img/ for the imageloc.

 

Import the users of the shard

You can import the already registered users to the AMS database, by simply executing the following php script (the same way as above, so go to ryzom_ams/www/html/sql and execute):

php importusers.php

Afterwards remove the sql directory or make sure to change the permission that only you can access and excute it.

Login

Login with the admin account (default is id: admin, pass: admin) and appoint your moderators and fellow admins! You're good to go!