Skip to content
This repository has been archived by the owner on Jun 22, 2024. It is now read-only.

Latest commit

 

History

History
294 lines (211 loc) · 7.64 KB

set_up.md

File metadata and controls

294 lines (211 loc) · 7.64 KB
Raw

Utility guide: set up the project

Warning

Some steps may be superficial.
It is suggested to follow this tutorial:

LAMP environment

Compatibility

Linux Ubuntu 20.04.1 Kernel 5.13.0-39-generic

Apache 2.4.41-4ubuntu3.8

MySQL 8.0.28-0ubuntu0.20.04.3

PHP 8.1.4

Apache Server

Install the server from the bash using:

sudo apt install apache2

Server configurations

Enable the RewriteRules from the bash with:

sudo a2enmod rewrite

Enable the WebSocket connection with the proxy_wstunnel module:

sudo a2enmod proxy_wstunnel

After having enabled the proxy module, if it isn't already active:

sudo a2enmod proxy

In the file /etc/apache2/apache2.conf add:

# This is the main Apache server configuration file. It contains the   
# [...]

<Directory /absolute/path/to/your/project/directory>  
    RewriteEngine on   
    AllowOverride All   
    Require all granted  
</Directory>

# [...]

The path mustn't contain a trailing slash, like this:

<Directory /absolute/path/to/your/project/directory/>

Also, the directory should be under the current user ownership:

Project_directory_signature

In case it is not, type:

sudo chown you:yourGroup path/to/your/project/directory

Logging

In case you need to debug server errors it is suggested to add:

# LogLevel: Control the severity of messages logged to the error_log.   
# [...]  
LogLevel alert rewrite:trace6

The log files can be found in:
/var/log/apache2/access.log

The error log can be found in:
/var/log/apache2/error.log

Project domain configuration

Under /etc/apache2/sites-available add server.wave.com.conf (in general your.domain.conf)
and write:

<VirtualHost *:80>    
    ErrorLog ${APACHE_LOG_DIR}/error.log
    CustomLog ${APACHE_LOG_DIR}/access.log combined
    
    # Name
    ServerName server.wave.com
    
    # Home
    DocumentRoot /home/giacomo/Projects/LAMP/Wave/
    
    # WebSocket proxy
    ProxyPreserveHost On
    ProxyPass /channel  ws://127.0.0.1:8000
</VirtualHost>

Use the bash to enable the domain:

sudo a2ensite server.wave.com.conf

And finally, make it visible on your machine by adding the domain inside the file /etc/hosts:

# Wave server address
127.0.1.1	server.wave.com

Test correct configuration

To check if it all went fine, type:

sudo apache2ctl configtest

You should expect Syntax OK.

MySQL database

Install the service with:

sudo apt install mysql-server

Database user

Enter the CLI with:

sudo mysql

In this modality you're using the root, to add a user for future uses type:

CREATE USER 'user'@'localhost' IDENTIFIED BY 'password';

and

GRANT ALL PRIVILEGES ON *.* TO 'user'@'localhost';

In this project, the database user is called "giacomo" with the password "".
It's written in /src/Specification/Database/Database.php.

Database schema

First, create the database using the mysql CLI:

CREATE DATABASE wave

Then define the DDLs:

CREATE TABLE sessions
(
  session_id         INTEGER     NOT NULL PRIMARY KEY AUTO_INCREMENT,
  session_token      VARCHAR(36) NOT NULL CHECK ( LENGTH(session_token) > 35 ) UNIQUE,
  source             VARCHAR(36) NOT NULL CHECK ( LENGTH(source) > 35 ) UNIQUE,
  user               INTEGER     NOT NULL,
  creation_timestamp TIMESTAMP   NOT NULL,
  last_updated       TIMESTAMP   NOT NULL,
  active             BOOLEAN     NOT NULL,
  FOREIGN KEY (user)
    REFERENCES users (user_id)
    ON DELETE CASCADE
)
CREATE TABLE users
(
  user_id  INTEGER                 NOT NULL PRIMARY KEY AUTO_INCREMENT,
  username VARCHAR(32)             NOT NULL CHECK ( LENGTH(username) > 4 ) UNIQUE,
  password VARCHAR(255)            NOT NULL,
  name     VARCHAR(64)             NOT NULL,
  surname  VARCHAR(64)             NOT NULL,
  picture  VARCHAR(255),
  phone    VARCHAR(19) CHECK ( LENGTH(phone) > 4 ),
  theme    VARCHAR(1) DEFAULT 'L'  NOT NULL,
  language VARCHAR(2) DEFAULT 'EN' NOT NULL CHECK ( LENGTH(language) > 1 ),
  active   BOOLEAN                 NOT NULL
)
CREATE TABLE contacts
(
  first_user  INTEGER    NOT NULL,
  second_user INTEGER    NOT NULL,
  status      VARCHAR(1) NOT NULL,
  blocked_by  INTEGER,
  chat        VARCHAR(36) CHECK ( LENGTH(chat) > 35 ) UNIQUE,
  active      BOOLEAN    NOT NULL,
  FOREIGN KEY (first_user)
    REFERENCES users (user_id)
    ON DELETE CASCADE,
  FOREIGN KEY (second_user)
    REFERENCES users (user_id)
    ON DELETE CASCADE,
  FOREIGN KEY (blocked_by)
    REFERENCES users (user_id)
    ON DELETE SET NULL
)
CREATE TABLE `groups`
(
  group_id INTEGER      NOT NULL PRIMARY KEY AUTO_INCREMENT,
  name     VARCHAR(64)  NOT NULL,
  info     VARCHAR(225) NOT NULL,
  picture  VARCHAR(225) UNIQUE,
  chat     VARCHAR(36)  NOT NULL CHECK ( LENGTH(chat) > 35 ) UNIQUE,
  active   BOOLEAN      NOT NULL
)
CREATE TABLE groups_members
(
  user    INTEGER    NOT NULL,
  `group` INTEGER    NOT NULL,
  state   VARCHAR(1) NOT NULL,
  muted   BOOLEAN    NOT NULL,
  active  BOOLEAN    NOT NULL,
  FOREIGN KEY (user)
    REFERENCES users (user_id)
    ON DELETE CASCADE,
  FOREIGN KEY (`group`)
    REFERENCES `groups` (group_id)
    ON DELETE CASCADE
)

The schema diagram should correspond to this:
Database_schema

phpMyAdmin

If you prefer having a visual assistance tool, you can install phpMyAdmin following this tutorial.

Because the database user has no password, to allow phpMyAdmin to have this kind of user by going to the file /etc/phpMyAdmin/config.inc.php and change line 98, as the comment suggests:

$cfg['Servers'][$i]['AllowNoPassword'] = TRUE;

PHP runtime

Install the dependency with:

sudo apt install software-properties-common
sudo add-apt-repository ppa:ondrej/php
sudo apt update
sudo apt install php8.1

Since by default Apache uses PHP 7.4, you need to change it, by typing:

sudo a2dismod php7.4
sudo a2enmod php8.1

Composer

Finally, you need to add composer to the machine, by following this tutorial.

Type composer install in your project directory and the vendor directory, containing the project dependencies, will appear.

Test

To test either the application run with PHPUnit the scripts under the test directory or use the Insomnia tool and add the collection by clicking the "create" button and "import from file".
Choose either the YAML file or the JSON included in the project under test/Insomnia/.