META

Docker install (MySQL)

Use the Docker MySQL folder for a quick and easy setup of the Ramses Server.

  1. Un-Zip the ramses-server_docker-mysql archive you’ve downloaded.
  2. On Linux, you may need to adjust permissions to the unzipped folder to make sure Docker has write access in there.
  3. Set passwords for the database. You may skip this step in development environments, but they must be set in production.
    1. Set the $sqlpassword variable in www/config/config.php.
    2. Set the same password for the MYSQL_PASSWORD variable in docker-compose.yml.
    3. Set a new password for the MYSQL_ROOT_PASSWORD variable in docker-compose.yml.
    4. Replace password and rootpassword in the db/init.sql file with the new passwords you’ve chosen.
  4. Go inside the docker folder and use the command docker compose up.
  5. Go to http://localhost:8001/ramses/install.
  6. Delete the install folder from the docker folder.

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.

Warning

It is important to delete the install folder as soon as the server’s been installed, to prevent anyone to run the install script again.

When the install script is run, it wipes all existing data from the server’s database!

Customize the Docker container

There are some settings you may find useful to adjust in the provided docker-compose.yml file before you run your container.

Default www port

By default, the Docker Ramses Server is set to use the 8001 port. It may be easier to use the default 80 port.

Default MySQL port

By default, the Docker Ramses Server is set to use the usual 3306 port. You can adjust this port to avoid conflicts on the server running the container. This is also true for PHPMyAdmin which exposes the 8000 port by default in this configuration.

Secured connection (SSL)

In production, it is recommended to add an SSL certificate to the Ramses Server and set $forceSSL = true; in the Ramses Server config/config.php file.

In this case, you can add this port mapping to the www service:
- "XXX:443"
Change XXX by the port you want to expose, which should be 443 by default.

Access the MySQL Data

A PHPMyAdmin container is included to help you access and manage the database. Go to http://localhost:8000 to access it, and user either the ramses user and its password to access the ramses database, or the admin user and its rootpassword to manage the whole database.