Configuring and running Ryzom Core server on GNU/Linux

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

If your frontend service is available through a firewall using NAT and a mapped IP address this is how you can advertise that external IP address. For example if your FS is on 192.168.1.100 internally but your firewall maps 74.125.225.210 through to your FS you would want to configure FSListenHost to be the address the clients connect to: 74.125.225.210.

For current Ubuntu versions you can just edit the file default in /etc/apache2/sites-available/ - substituting what is listed below for what is already there. It may be helpful to break this into multiple site configuration files but isn't necesasry.

Don't forget to change the paths used below to match where your source is checked out!

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>

You can place these into the same configuration file or separately, it's up to you. If you want to serve up some unique content, a signup page or something along those lines you can change the main website's DocumentRoot so long as the admin tool alias is still there.

• See Configuring WebTT for configuration details regarding the Web Translation Tool.
• See Configuring Ryzom API for configuration details regarding configuring the Ryzom API and WebIG applications.
• See Configuring Ryzom Ring Server for configuration details regarding the configuration of a Ryzom Ring shard.
• See Configuring Patching Services for configuration details regardin the patch site and tools.

In order to execute system commands like restarting services you will need to be able to log in as root or execute the command using sudo, e.g.:

sudo /etc/init.d/apache2 restart

The configuration files in code/ryzom/server expect your user to be named 'shard' with NO PASSWORD. If you decide to use a different name for your MySQL user, or assign it a password, you will need to go through the .cfg files and change these values from 'shard' and "" wherever they appear. (they appear in several of the .cfg files)

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.

If you are getting strange errors some config files may have Windows editor "control-M" endline characters, which appears as a blue ^M in vim. You can remove it with this vi command, noting that ^M is typed by pressing Ctrl+V followed by Ctrl+M:

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

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: 

• code/ryzom/server/sql.cfg
• code/ryzom/tools/server/www/login/config.php
• code/ryzom/tools/server/admin/config.php

If you plan to make your shard public only the SU, FS and web services should have a public IP. The other services should all be behind a firewall for security reasons.

If you're running on Ubuntu the default shell is actually dash and the shard/screen scripts will not run correctly in dash. The steps following will have you switch to bash. If you want to keep using dash as the default shell then you will need change the shebang from /bin/sh to /bin/bash in the following files:

• code/ryzom/tools/scripts/linux/shard
• code/ryzom/server/shard.screen.rc

Great screen how-to at: http://www.rackaid.com/resources/linux-screen-tutorial-and-how-to/

# 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

• To start: shard start
• To stop: shard stop
• To view screen: shard join
• To switch monitored service: Ctrl-A+n