META

Ramses Server installation

Ramses Server runs on very standard web servers, with the usual Web Server / PHP / mySQL stack. That means you can install it on almost any desktop or server computers, private server, shared hosting, workstation, Raspberry… It doesn’t need much resources.

Warning

The procedure to install and to update Ramses differ a bit. Do not follow the installation procedure to update your server, as it will wipe all your data!

It is also a good habit to always backup the data before updating.

Prerequisites

Ramses Server must be installed on a computer with:

The recommended configuration is a standard AMP stack (Apache - mySQL - PHP), with at least 2GB of RAM if the SQL server is on the same computer than the Apache server.

We provide a detailed, step-by-step guide to help you install your own web server satisfying these requirements on Windows, Linux or Mac OS if you need to, before installing the Ramses Server: install your own webserver.

Standard Installation

You first have to decide what type of database the Ramses Server will be using. There are two options:

Once you’ve made your choice, follow these steps:

  1. (MySQL only) Create a new base on the SQL server, along with its user and password.
  2. Un-Zip the Ramses Server you’ve downloaded.
  3. Edit config.php with needed info (read below).
  4. (optional) Edit config_logs.php if you want to enable logs on the server.
  5. Copy the Ramses Server files to the web server (you can just copy the ramses folder from the ZIP archive).
  6. Go to http://your.server/ramses/install (if you’re running your own local server, this is probably something like http://localhost/ramses/install)
  7. Delete the install folder from the server.

The default user for Ramses is Admin with the password password. You should start by changing this name and password using the Ramses Client Application.

config.php

The config.php file you have to edit looks like that:

    // === DEV MODE ===
    // Activates printing the SQL & PHP errors.
    // For security reasons, it is important to set this to false in production mode
    $devMode = false;

    // ==== SQL SETTINGS ====

    // either 'mysql' (works for MariaDB too) or 'sqlite'
    $sqlMode = 'sqlite';

    // ==== MySQL/MariaDB SETTINGS ====

    // Host URL
    $sqlHost = "localhost";
    $sqlPort = 3306;
    // Database name
    $sqlDBName = "ramses";
    // User
    $sqlUser = "ramses";
    // Password
    $sqlpassword = "password";
    // Table prefix
    // DO NOT CHANGE THIS, not working yet
    $tablePrefix = "ram";

    // ==== SESSION SETTINGS ====

    // Session timeout (seconds)
    // The client will be disconnected after being idle for this time
    // 30 minutes by default (1800) are more than enough:
    // The official client makes a call at least every 2 minutes by default.
    $sessionTimeout = 1800;
    // Max Session timeout (seconds)
    // The client will be disconnected no matter what after this time
    // 5 hours by default( 18000 )
    $cookieTimeout = 18000;

    // This must be the server public adress, exactly as used in the clients
    $serverAdress = "localhost/ramses";

    // This should never be changed, unless you change the key before building the official client or implementing your own client.
    // It can be used to make sure only your own client, built by yourself, can connect to your own server. In this case, keep it secret!
    // It is used to hash passwords.
    $clientKey = "H6BuYLsW";

The next options are only used in MySQL mode. Ignore them when using SQLite.

Hint

You will need your database information to configure the Ramses Server to use it. If you don’t know how to do that or if you’ve just installed your own web server following our instructions, read the next section first.

Tip

If you know what you’re doing, you can actually already change the table prefix, but Ramses will be installed using the default prefix anyway. That means you have to install Ramses with this default ram prefix, then rename all the tables with a new prefix, and finally change the prefix in config.php.