Files
Open-RSC-Docker-Home/README.md
2018-07-07 20:26:23 -04:00

4.0 KiB

Overview

  1. Install prerequisites

  2. Clone the project

  3. Run the application


Install prerequisites

This project has been created for (Windows, Linux, and OS X).

Requisites:

This project uses the following ports:

Server Port
MySQL database server 3306
PHPMyAdmin 8080
Nginx web server 80

Clone the project

Install Git, then clone the project:

git clone https://github.com/Marwolf/Open-RSC-Docker.git

Go to the project directory:

cd Open-RSC-Docker

Important!

If you are using Windows, open Docker and make your drives available to your Docker containers:

Shared drives setting


Run the application

  1. Perform first time setup and start the Docker application:

    OS X/Linux: ./first-time-setup.sh
    
    Windows: "First time setup.cmd"
    

    Please wait this might take a several minutes...

  2. Open your favorite browser:

  3. Backup your databases:

    OS X/Linux: ./backup-database.sh
    
    Windows: "Backup Databases.cmd"
    
  4. Restore your databases:

    OS X/Linux: ./restore-database.sh
    
    Windows: "Restore Databases.cmd"
    
  5. Stop the application:

    OS X/Linux: ./stop.sh
    
    Windows: "Stop Containers.cmd"
    
  6. Start the application:

    OS X/Linux: ./start.sh
    
    Windows: "Start Containers.cmd"
    
  7. Restart the application:

    ./restart.sh
    
    Windows: "Restart Containers.cmd"
    
  8. View container logs:

./view-logs.sh
Windows: "View Container Logs.cmd"
  1. Pull repository updates:
./pull-updates.sh
Windows: "Pull Repository Updates.cmd"

Additional commands for troubleshooting use

Name Description
first Perform first time setup
clone Clone the git repository folders
pull Get the latest git repository updates
start Create and start containers
stop Stop all containers
restart Restart all containers
logs Display log output
import Import all databases from git repositories
backup Create backup of all local databases
restore Restore backup of all local databases
flush Delete local git repository folders

Optional: configure Nginx With SSL Certificates

You can change the host name by editing the .env file.

If you modify the host name, do not forget to add it to the /etc/hosts file.

  1. Configure Nginx:

    Do not modify the Website/etc/nginx/default.conf file, it is overwritten by Website/etc/nginx/default.template.conf

    Edit nginx file Website/etc/nginx/default.template.conf and uncomment the SSL server section :

    # server {
    #     server_name ${NGINX_HOST};
    #
    #     listen 443 ssl;
    #     fastcgi_param HTTPS on;
    #     ...
    # }
    
  2. Copy your server.pem and server.key files in to the Website/etc/nginx/ssl folder and restart the application. (Lets Encrypt can register SSL certs for free)

    sudo make restart