Installation

Below are the installation guides for various different setups. If you have any problems feel free to reach out using our Discord.

Requirements

• PHP > 7.0
• mbstring
• Composer (if not using built release)
• Altis Life 5 or newer

Using the installer

You will need to first complete the steps below to setup your environment then visit /installer.php. Enter your database details for it to generate the configs.

Linux

We always recommend running PHP on linux and do all of our testing on linux environments. (Also because Linux is better)

Docker

We recommend you deploy CyberWorks 3 to your own servers using docker. We have included a docker-compose.yml which will allow you to get started quickly. All you need to do is install docker and docker-compose and run the following command.

wget https://github.com/Cyberbyte-Studios/CyberWorks-3/releases/download/1.1.0/cyberworks.zip
unzip cyberworks.zip
docker-compose up

This should work out of the box and might also work on other operating systems.

Shared hosting

The application should work on shared hosting such as cPanel as long as they support PHP 7 or above. All you will need to do is upload the files into your webroot and visit /installer.php. IF there is enough interest we might setup preconfigured Cyberworks hosting. Contact us for more details.

Manually

A guide will be written shortly. Basicly you want to install PHP 7 and Nginx in a standard setup.

• Windows: As this version is Please note GUID conversion does not work on Windows due to 32bit PHP
  • Download XAMPP
  • Download the latest release from HERE
  • Navigate To C:\xampp\htdocs
  • Make a folder called Cyberworks
  • Extract cyberworks.zip in to the folder you just created.
  • Open the XAMPP Control Panel, go to config -> Apache(httpd-xampp.conf)
  • Add the Following to the config after /phpmyadmin block

    Alias /cyberworks "C:/xampp/htdocs/cyberworks/public/"
    <Directory "C:/xampp/htdocs/cyberworks/public">
        Options Indexes FollowSymLinks
        AllowOverride All
        Require all granted
    </Directory>
    

• Linux (Ubuntu) - Nginx:
  • Follow This Guide To Setup a LEMP stack DigitalOcean
  • Also install php-mbstring
  • Follow This Guide To Setup a Nginx Server Block DigitalOcean
  • Download the latest release from HERE in to the folder you made for the site during the server block guide.

    wget https://github.com/Cyberbyte-Studios/CyberWorks-3/releases/download/1.1.0/cyberworks.zip
    unzip cyberworks.zip
    

  • Now replace the location section in your site config you made with the following:

    location / {
        try_files $uri /index.php$is_args$args;
    }
    
    location ~ \.php$ {
       try_files $uri =404;
       fastcgi_split_path_info ^(.+\.php)(/.+)$;
       fastcgi_pass unix:/run/php/php7.0-fpm.sock;
       fastcgi_index index.php;
       include fastcgi_params;
       fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
       fastcgi_param PATH_INFO $fastcgi_path_info;
    }
    

  • Still in the config you will need to ensure the root ends with /public as this is where the requests need to land. Example:

    root /var/www/html/public;
    

• Linux (Ubuntu) - Apache:
  • Follow This Guide To Setup a LEMP stack from DigitalOcean
  • Install php-mbstring and apache rewrite

    sudo a2enmod rewrite
    sudo service apache2 restart
    

  • Download the latest release from GitHub releases into /var/www/html/cyberworks.

    mkdir -p /var/www/html/cyberworks
    wget https://github.com/Cyberbyte-Studios/CyberWorks-3/releases/download/1.1.0/cyberworks.zip /var/www/html/cyberworks
    unzip cyberworks.zip
    

  • Now make a new config file called /etc/apache2/sites-enabled/cyberworks.conf

    Alias /cyberworks "/var/www/html/cyberworks/public/"
    <Directory "/var/www/html/cyberworks/public">
        Options Indexes FollowSymLinks
        AllowOverride All
        Require all granted
    </Directory>
    

Permission

You will need to make sure you have permissions to create your log file.

Composer

If you do not use a release version and you get an error like You need to run composer install first. Or use a bundled release then you have two options. You can either install composer (recommended on linux systems with shell access) from getcomposer.org and run composer install or you can make sure to download the latest release bundle version.

Windows

The platform should be compatible with IIS web server. We are looking to make a guide on how to use this and would like people who are interested in helping us get in contact though Discord.

Security

We recommend you also deploy SSL for your installations. Guides to do this can be found online after a quick Google. LetsEncrypt is a good free SSL certificate provider.