# CAI CP: Help

# Советы по использованию

- Табличные виджеты можно распахнуть на весь экран двойным щелчком по заголовку.
- Для переключения по информационным блокам используйте следующие комбинации клавиш:
  - Ctrl + 1: Система
  - Ctrl + 2: Пульс системы
  - Ctrl + 3: Файловое хранилище
  - Ctrl + 4: Сеть
  - Ctrl + 5: SMB
  - Ctrl + Влево: Предыдущий блок
  - Ctrl + Вправо: Следующий блок
  Также вы можете переключаться между блоками, проведя влево или вправо по заголовку на устройствах с сенсорным экраном.

  - Ctrl + F1: Справка

# Системные требования

Ядро системы использует следующие команды и утилиты:

- gawk (GNU awk)
- grep
- hddtemp
- lsb-release
- sed
- smartmontools (smartctl)
- sysstat (iostat)
- php7

Различные приложения могут требовать наличие других программ и утилит.

# Настройка

Для мониторинга S.M.A.R.T. и температуры дисков требуется разрешить выполнение smartctl и hddtemp веб-сервером. Для этого запустите редактор sudo командой visudo и добавьте в раздел User privilege specification следующие строки:

                        wwwrun ALL=NOPASSWD: /usr/sbin/smartctl
                        wwwrun ALL=NOPASSWD: /usr/sbin/hddtemp

Для мониторинга ресурсов SMB требуется разрешить выполнение smbstatus веб-сервером. Для этого запустите редактор sudo командой visudo и добавьте в раздел User privilege specification следующие строки:

                        wwwrun ALL=NOPASSWD: /usr/bin/smbstatus

Конфигурация панели управления задаётся в файле /system/json/settings.json.
Параметры:

Параметр | Возможные значения | Описание
lang | ru en ... | Язык по умолчанию. Может быть указан один из доступных языков.
langs | "en" : "English" "ru" : "Русский" ... | Доступные языки.
dim_on_create | true false | Виджеты отображаются полупрозрачными пока не загрузятся данные.
check_files_rights | true false | При запуске проводится проверка правильности установленных прав на файлы и каталоги.
check_hdd_temp_interval | 0 .. 86400 | Интервал (в секундах) проверки температуры жёстких дисков.
check_smart_interval | 0 .. 86400 | Интервал (в секундах) проверки состояния S.M.A.R.T. жёстких дисков.

Список загружаемых приложений находится в файле /system/apps/apps.json. Панель управления проверяет зависимости приложений и отключает те, что не могут быть запущены на данном сервере. Если вы хотите принудительно отключить какое-либо приложение, удалите строку с его названием из данного файла.

# Безопасность

1. Назначьте владельцем файлов и каталогов wwwrun:www, всем каталогам и файлам .sh назначьте права по маске 550, остальным файлам - 440.

   Если хотите иметь возможность управлять некоторыми параметрами из веб-интерфейса, установите маску 640 файлу /system/json/settings.json.

   Для этого выполните следующие команды:
   `$ chown -R wwwrun:www /path/to/base/dir
   $ chmod 440 $(find /path/to/base/dir -type f)
   $ chmod 550 $(find /path/to/base/dir -type d)
   $ chmod 550 $(find /path/to/base/dir -type f | grep .sh$)
   $ chmod 640 /path/to/base/dir/system/json/settings.json
   $ chmod 640 /path/to/base/dir/system/apps/apps.json`

2. Запретите доступ через веб к файлам с расширением .sh, для этого в конфигурационный файл Apache в блок

       <Directory></Directory>

   добавьте следующие строки:

                               <FilesMatch "\.(sh)$">
                                   Require all denied
                               </FilesMatch>

3. Установите пароль на доступ к панели управления. Пример для настройки базовой аутентификации: с помощью утилиты htpasswd (входит в комплект сервера Apache) создайте содержащий пароль файл .htpasswd. В конфигурационный файл Apache добавьте в блок

       <Directory></Directory>

   следующие строки:

                               AuthName "Restricted zone"
                               AuthType Basic
                               AuthUserFile [Путь к файлу .htpasswd]
                               Require valid-user

   После этого перезагрузите сервер Apache.

   Обратите внимание, что в рассмотренном случае используется базовая аутентификация, при её использовании пароль передаётся в открытом виде, для защиты передаваемой информации настройте доступ по протоколу HTTPS.

4. Если хотите включить возможность перезагрузки и отключения сервера, следует добавить пользователя wwwrun в sudoers. Будьте осторожны с данной возможностью!

   Запустите `# visudo` и добавьте следующую строку в блок "User privilege specification": `wwwrun ALL=NOPASSWD: /sbin/shutdown`

# О панели управления

CAI CP
Версия _._ от __.__.____
Автор: Александр Чебыкин
Лицензия: MIT

    Лицензия MIT
    ------------

    Copyright (c) 2016-2017, Александр Чебыкин

    Данная лицензия разрешает лицам, получившим копию данного программного
    обеспечения и сопутствующей документации (в дальнейшем именуемыми
    «Программное Обеспечение»), безвозмездно использовать Программное Обеспечение
    без ограничений, включая неограниченное право на использование, копирование,
    изменение, слияние, публикацию, распространение, сублицензирование и/или
    продажу копий Программного Обеспечения, а также лицам, которым предоставляется
    данное Программное Обеспечение, при соблюдении следующих условий:

    Указанное выше уведомление об авторском праве и данные условия должны быть
    включены во все копии или значимые части данного Программного Обеспечения.

    ДАННОЕ ПРОГРАММНОЕ ОБЕСПЕЧЕНИЕ ПРЕДОСТАВЛЯЕТСЯ «КАК ЕСТЬ», БЕЗ КАКИХ-ЛИБО
    ГАРАНТИЙ, ЯВНО ВЫРАЖЕННЫХ ИЛИ ПОДРАЗУМЕВАЕМЫХ, ВКЛЮЧАЯ ГАРАНТИИ ТОВАРНОЙ
    ПРИГОДНОСТИ, СООТВЕТСТВИЯ ПО ЕГО КОНКРЕТНОМУ НАЗНАЧЕНИЮ И ОТСУТСТВИЯ НАРУШЕНИЙ,
    НО НЕ ОГРАНИЧИВАЯСЬ ИМИ. НИ В КАКОМ СЛУЧАЕ АВТОРЫ ИЛИ ПРАВООБЛАДАТЕЛИ НЕ НЕСУТ
    ОТВЕТСТВЕННОСТИ ПО КАКИМ-ЛИБО ИСКАМ, ЗА УЩЕРБ ИЛИ ПО ИНЫМ ТРЕБОВАНИЯМ, В ТОМ
    ЧИСЛЕ, ПРИ ДЕЙСТВИИ КОНТРАКТА, ДЕЛИКТЕ ИЛИ ИНОЙ СИТУАЦИИ, ВОЗНИКШИМ ИЗ-ЗА
    ИСПОЛЬЗОВАНИЯ ПРОГРАММНОГО ОБЕСПЕЧЕНИЯ ИЛИ ИНЫХ ДЕЙСТВИЙ С ПРОГРАММНЫМ
    ОБЕСПЕЧЕНИЕМ.

    -------------------------------------------------------------------------------

    MIT License
    -----------

    Copyright (c) 2016-2017, Alexander I. Chebykin

    Permission is hereby granted, free of charge, to any person obtaining a copy
    of this software and associated documentation files (the "Software"), to deal
    in the Software without restriction, including without limitation the rights
    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
    copies of the Software, and to permit persons to whom the Software is
    furnished to do so, subject to the following conditions:

    The above copyright notice and this permission notice shall be included in
    all copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    THE SOFTWARE.

Данный продукт частично основан на Linux Dash .