...

Configuring and running Ryzom Core

...

Web Services on GNU/Linux

Preparing Packages

For Debian/Ubuntu users you will need to install the following packages:

Making changes in services config files

• Change FSListenHost in code/ryzom/server/frontend_service.cfg to your address (e.g. 192.168.0.1). If you set up server on different machine, remember it has to be address that's reachable on client host.

Configuring Apache and web tools

• Ubuntu user: Don't forget to install php5-mysql synaptic packet and to uncomment "extension=mysql.so" into "php.ini" file to allow mysql connection from php code.

• Configure Apache with PHP. Make a VirtualHost (usually in /etc/apache2/httpd.conf) for the login scripts and admin app (replace DocumentRoot with your own path).

Listen 40916
<VirtualHost *:40916>
  <Directory "/home/username/ryzom/code/ryzom/tools/server/">
     Options -Indexes FollowSymLinks MultiViews
     IndexOptions FancyIndexing FoldersFirst NameWidth=*
     AllowOverride All
     Order allow,deny
     Allow from all
  </Directory> 
  ServerAdmin admin@localhost
  DocumentRoot /home/username/ryzom/code/ryzom/tools/server/www
  ServerName localhost
</VirtualHost>

<VirtualHost *:80>
  <Directory "/home/username/ryzom/code/ryzom/tools/server/">
     Options -Indexes FollowSymLinks MultiViews
     IndexOptions FancyIndexing FoldersFirst NameWidth=*
     AllowOverride All
     Order allow,deny
     Allow from all
  </Directory> 
  ServerAdmin admin@localhost

  # You can change this if you want.

  DocumentRoot /home/username/ryzom/code/ryzom/tools/server/admin

  # Admin Tool

  Alias /admin/ /home/username/ryzom/code/ryzom/tools/server/admin

  ServerName localhost 

</VirtualHost>

...

VHost

Create a public web directory and point a VHost to it.

Point a second VHost to the same directory with port 40916

Upload

Upload the following to your public web directory of your PHP host

/code/web/public_php

Upload the following to a private directory accessible by your PHP host

/code/web/private_php

Setup

Run the following script and follow the instructions

http://<hostname>/setup/

This script will create a config.php under the public php directory, and set up the nel, nel_tool and ams databases.

Additional Notes

sudo /etc/init.d/apache2 restart

• Restart Apache by typing the following.

/etc/init.d/apache2 restart

...

• Set NELTOOL_SITEBASE to your server address and NELTOOL_SYSTEMBASE to your path in code/ryzom/tools/server/admin/config.php.

• Create code/ryzom/server/save_shard/rrd_graphs/ directory.

mkdir -p code/ryzom/server/save_shard/rrd_graphs/

...

• Make sure the directory's requiring write permissions is writeable by all.

chmod a+w code/ryzom/tools/server/admin/graphs_output

...

• Change $LogRelativePath to 'logs/' in code/ryzom/tools/server/www/login/config.php (NOTE: log directory has to be writeable by webserver and it's not wise to give it write access to the directory where script is.)

$LogRelativePath = 'logs/';

• Make code/ryzom/tools/server/www/login/logs/ directory and make it writeable by all for login script logs.

...

chmod a+w

...

...

code/ryzom/tools/server/admin/templates/

...

default

...

_c

...

chmod a+w 

...

Setting up MySQL

...

code/ryzom/

...

Since this (and a password) can lead to unexpected errors (eg. error '4000') it is best to make sure everything works correctly with the defaults first.

find /home/username/ryzom/code -name "*.cfg" -name "*.php" | xargs grep -l '^M'
 
# if there are none, Vim will gladly eat your shell if you xargs it
vi <listed filename> 
 
# Next issue this command to vi :%s/^M//g

You may also skip this section and use the next section entitled "Setting up MySQL (Alternative)". It condenses all the steps listed below into a pre-generated MySQL file that you import.

• Remove STRICT_TRANS_TABLES from sql_mode in your MySQL configuration. You can check if you have it by doing

SHOW VARIABLES WHERE Variable_name='sql_mode';

• Or can run an SQL query within your database management tool, such as phpMyAdmin:

SET @@global.sql_mode= '';

• Prepare MySQL databases

* Login to the MySQL database server using the command line:

mysql -uroot -p

CREATE DATABASE nel;
CREATE DATABASE nel_tool;
CREATE DATABASE ring_open;

GRANT ALL ON nel.* TO shard@localhost;
GRANT ALL ON nel_tool.* TO shard@localhost;
GRANT ALL ON ring_open.* TO shard@localhost;

FLUSH PRIVILEGES;

...

If you use different usernames and password for database, you need to change the following files: 

...

tools/server/www/login/

...

logs

chmod a+w code/ryzom/tools/server

...

/ryzom_

...

• Change code/ryzom/tools/server/sql/ryzom_admin_default_data.sql replacing /home/nevrax/code/ryzom/server/save_shard/rrd_graphs by your directory.

• Popoulate databases with default data

...

ams/www/

chmod a+w code/ryzom/tools/server

...

/ryzom_

...

ams/www/html/cache

chmod a+w code/ryzom/tools/server

...

• In MySQL update host for admin app. Change YOUR_ADDRESS to your address (e.g. 192.168.0.1).

USE nel_tool;
UPDATE neltool_domains SET domain_as_host='YOUR_ADDRESS' where domain_id=12;

Setting up MySQL (Alternative)

• Use the Quick Start SQL Setup Script
• Edit the file and replace the following path with your own:
  • /home/ryzom/code/ryzom/server/save_shard/rrd_graphs
• Import in phpMyAdmin or sourcing via the mysql CLI.

Running the shard

• Run commands:

# if you're on Ubuntu - disable dash:
if [ `lsb_release -si` = 'Ubuntu' ];
then
    # Change your selection to 'no' so it uses bash instead.
    sudo dpkg-reconfigure dash;
fi
echo "export RYZOM_PATH=/home/user/ryzom/code/ryzom" >> ~/.bashrc
echo "export PATH=$PATH:$RYZOM_PATH/tools/scripts/linux" >> ~/.bashrc
source ~/.bashrc

...

Client login errors

• If your client gives you error messages on connect, check Client Connect Errors.

Notes

If you want to use your shard with the core client, you will have to copy the following file into code/ryzom/common/data_common:

...

/ryzom_ams/www/html/templates_c