Skip to main content

YetiForce Server Setup and Configuration

There's a time and place for everything, maybe not now.

This guide supposes that you have already followed the Setting Up Your Environment guide. If you haven't done so, please refer to the Setting Up Your Environment guide before proceeding.

BE SURE TO FOLLOW CAREFULLY AND TROUGHLY

This guide is a step-by-step process to configure the YetiForce server. Please ensure you follow each step carefully to avoid any issues. THE THIRD STEP CANNOT BE SKIPPED.

Prerequisites​

  • SSH access to the server hosting YetiForce
  • Administrative access to YetiForce admin panel

Step 1: Enable Web Service​

Locate YetiForce Installation​

  1. SSH into the server hosting YetiForce
  2. Use ls and cd commands to navigate to the YetiForce installation directory

Enable Webservice​

  1. Open the configuration file: config/Api.php
  2. Modify the $enabledServices array to include 'webservice'
/** List of active services. Available: dav, webservice */ 
public static $enabledServices = ['webservice'];

Step 2: Configure Custom Fields for Students Module​

Login and Access Module Configuration​

  1. Log into YetiForce admin panel
  2. Click on the gear icon in the top right corner
  3. In the left sidebar, select "Standard Modules"
  4. Choose "Edit Field"

Add PIN Field to Students Module​

  1. In the top left search, select "Students" module and press Enter
  2. Click "Add Custom Field" on the right side of Basic Information
    • Label Name: PIN
    • Field Name: pin
    • Length: 4
  3. Save the field

Add SID Field to Students Module​

  1. Repeat the previous steps
  2. Create another custom field
    • Label Name: SID
    • Field Name: sid
    • Length: 6
  3. Save the field

Repeat for Short Term Students​

  1. Perform the same field addition process for the "Short Term Students" module
  2. Follow the same steps to add PIN and SID fields

Step 3 configure the apache server

Locate the Apache Configuration File​

  1. SSH into the server hosting YetiForce
  2. Use ls and cd commands to navigate to the Apache configuration directory
  3. Open the configuration file (should be in /etc/apache2/apache2.conf)
  4. find and edit the following configuration
<Directory /var/www/>
    [... any other configuration ...]
    AllowOverride All
    [... any other configuration ...]
</Directory>

REMEMBER TO RESTART THE APACHE SERVER

After making the changes to the Apache configuration, you must restart the Apache server to apply the changes. Use the following command to restart the Apache server:

sudo service apache2 restart

Important Notes​

  • Ensure you have proper backup before making configuration changes
  • Verify each step is completed correctly before proceeding
  • Restart YetiForce services if required after configuration
tip

Always double-check your field names and lengths to maintain data integrity.