Инструкция для Администратора

Инструкция для Администратора, проект "Большая Библиотека". Инструкция по установке и адаптации проекта - создается на основе выполненного ТЗ техническим специалистом заказчика или исполнителя. Руководствуясь этой инструкцией, администратор (системный администратор, администратор БД, администратор проекта, разработчик) заказчика устанавливает ИС в определенной среде исполнения, производит необходимые настройки, обеспечивает ее функционирование.

---

Основные требования к среде установки и исполнения

На сервере должно быть установлено ПО (Программное Обеспечение), указанное в ТЗ (Техническое Задание).

---

Установка БД

1.
Скачайте скрипт для установки БД

2.
С помощью любого универсального клиента (например, phpMyAdmin или pgAdmin4) подключитесь к БД и создайте нового пользователя с паролем и новую БД, например:

• bbuser - Пользователь БД
• bbPass$$$20240419 - Пароль Пользователя
• bbdb - БД

Это данные для примера. Позже их надо будет внести в специальный файл подключения БД.

3.
Выполняем SQL-запрос к базе данных bbdb (скрипт, который мы скачали на шаге 1).

Если процесс прошел успешно, то в нашем клиенте (например, phpMyAdmin), с помощью которого мы смотрим в нашу БД, должны отобразиться 4 таблицы.

---

Установка прикладного ПО (Программного Обеспечения)

1.
Скачайте дистрибутив с ПО

2.
Разверните скаченный архив в эту папку (например):
d:\web\www\bb_site.localhost\

3.
Внесите изменения в файл:
d:\xampp\apache\conf\extra\httpd-vhosts.conf

######################### bb_site ######################### <Directory "D:/web/www/bb_site.localhost"> Options Indexes FollowSymLinks MultiViews AllowOverride all Order Deny,Allow Allow from all Require all granted </Directory> <VirtualHost *:80> ServerAdmin webmaster@bb_site.localhost DocumentRoot "D:/web/www/bb_site.localhost" ServerName bb_site.localhost ServerAlias www.bb_site.localhost ErrorLog "D:/web/log/bb_site.localhost/error.log" CustomLog "D:/web/log/bb_site.localhost/access.log" common </VirtualHost> ######################### xxxxxxx #########################

Здесь и далее имеется в виду, что мы работаем на сервере с OS Windows, при этом apache и прочий необходимый системный софт установлен в папку d:\xampp\.

4.
Создайте папку с правами на запись и чтение для хранения логов:
d:\web\log\bb_site.localhost\

В эту папку у нас будут записываться логи: error.log и access.log

---

Настройка

1.
Подключение БД

Внесите необходимые изменения в специальный файл подключения БД:
d:\web\www\bb_site.localhost\config\db.php

• dsn mysql:host=localhost;dbname=bbdb
• password bbPass$$$20240419
• username bbuser

Это данные должны совпадать с параметрами подключения БД (см выше).

2.
Администрирование пользователей

Администрирование пользователей осуществляется путем внесения необходимых изменений в специальный файл:
d:\web\www\bb_site.localhost\models\User.php
По умолчанию заведены 2 пользователя:

private static $users = [ '1' => [ 'id' => '1', 'username' => 'user1', 'password' => 'user1', 'authKey' => 'user1', 'accessToken' => '1-token_user1', ], '2' => [ 'id' => '2', 'username' => 'user2', 'password' => 'user2', 'authKey' => 'user2', 'accessToken' => '2-token_user2', ], ];

Вы можете отредактировать эту информацию под свои нужды.

Такой подход к администрированию пользователей нельзя признать корректным, т.к. грубо нарушает принципы информационной безопасности (пароли пользователей хранятся в открытом виде и доступны администратору). Но для учебного проекта, учитывая простоту, такой подход является оптимальным.

3.
Изменение наименования проекта

Для того, чтобы изменить наименование проекта, внесите изменения здесь:
d:\web\www\bb_site.localhost\vendor\yiisoft\yii2\base\Application.php

Нужно изменить значение вот этой переменной:
public $name = 'Большая Библиотека';

4.
Изменение макета страниц

Для того, чтобы изменить макет, внесите изменения здесь:
d:\web\www\bb_site.localhost\views\layouts\book.php

Изменения, которые вы внесете здесь, скажутся на всех страницах сайта.

---

Проверка, все ли установилось ок

1.
Работают ли стили, скрипты и библиотека jQuery



2.
Проверка, работает ли дополнительная функция php debug20240316

Попробуйте для тренировки разные варианты использования функции debug20240316

---

Более глубокая и тонкая настройка

Если все настроечные мероприятия выше прошли успешно, вы можете, при желании и/или необходимости преступить к более глубоким и тонким настройкам.

Например:

• Заменить титульную картинку на главной страницы, а также все элементы, которые участвуют в "Карусели".
• Преобразовать БД в нужную вам версию, включая любые изменения в контенте или структуре.
• Добавить в меню новые нужные вам пункты, убрать ненужные.
• Сделать новую систему авторизации, которая полностью удовлетворяет требованиям информационной безопасности.
• Любые другие изменения и дополнения.

Для того, чтобы выполнить пункты выше рекомендую:

• Полное руководство по Yii 2.0 в формате pdf - очень полезная инструкция для изучения фреймворка Yii 2.0, рус и англ.
• Полное руководство по Yii 2.0 онлайн - рус, англ, авто.
• Форум YII2.
• Yii Framework Extensions (Расширения) - Сообщество Yii разработало огромное количество расширений, предоставляющих множество полезных функций. Расширения, которые вы найдете здесь, являются расширениями, предоставленными пользователями. Существует также набор расширений, поддерживаемых командой Yii, они называются официальные расширения.
• Краткая информация о Фреймворке Yii2.

---

=== Конец ===

---

Спасибо за внимание!

---