Dokumentacja techniczna

Jak używać aplikacji RiseNet CMS

RiseNet CMS jest aplikacją opartą na frameworku Zend w wersji 1.* oraz ORM Doctrine 1.2.4

Wymagania

Aby uruchomić aplikację RiseNet CMS, serwer na którym będzie zainstalowana musi spełniać minimalne wymagania:

  • serwer Apache 2.2 lub wyższy
  • wersja PHP 5.3.* lub 5.4.*
  • bazę danych MySQL 5.5 lub wyższą
  • zainstalowany Rewrite Module

Ponadto, indywidualne moduły mogą posiadać własne wyższe wymagania względem serwera. Informacje dotyczące wymagań poszczególnych modułów będą umieszczone na tej stronie.

Dodatkowe informacje dotyczące wymagań Zenda można uzyskać pod adresem http://framework.zend.com/manual/1.12/en/requirements.introduction.html oraz dla Doctrina http://docs.doctrine-project.org/projects/doctrine1/en/latest/en/manual/introduction.html#minimum-requirements

Instalacja

Aplikację należy pobrać z naszej strony do pobrania, a następnie postępować według poniższych kroków:

  • Rozpakować zawartość pobranego pliku do katalogu decelowego na serwerze.
  • Wgrać bazę danych. Struktura bazy danych wraz z niezbędnymi danymi znajduje się w pliku /data/doctrine/data/_sql.sql
  • Skonfigurować plik konfiguracyjny bazy danych /application/config/database.php Należy podać nazwę użytkownika, hasło oraz nazwę bazy danych według przykładu: 
        ...
'connection' =>
    'mysql://' .
    (getenv('MYSQL_USERNAME') ? getenv('MYSQL_USERNAME') : 'root') . ':' .
    (getenv('MYSQL_PASSWORD') ? getenv('MYSQL_PASSWORD') : 'pass') . '@' .
    (getenv('MYSQL_DB_HOST') ? getenv('MYSQL_DB_HOST') : 'localhost') . '/' .
    (getenv('MYSQL_DB_NAME') ? getenv('MYSQL_DB_NAME') : 'risenet_cms'),
'options' => array(
...
  • Nadać uprawnienia do zapisu dla następujacych katalogów:
    • data/cache
    • data/cache/pagetag
    • data/logs
    • data/upload
    • public/cached
    • public/files
  • Skierować ustawienia vhost domeny, aby głównym katalogiem na który wskazuje był katalog public/.

Po wykonaniu powyższych kroków aplikacja jest już w pełni gotowa do działania a na ekrenie ukaże się poniższy ekran strony głównej:

W sytuacji innego zachowania zalecamy włączenie trybu deweloperskiego w celu wyświetlenia komunikatu błędu.

Obsługa konsoli

Aplikacja oferuje narzędzia dostępne z poziomu konsoli szczególnie pomocne podczas prac deweloperskiech. Listing dostępnych opcji otrzymamy po wprowadzeniu polecenia php zf z katalogu aplikacji

Dostępne narzędzia:

  • php zf clean cache, czyści cache aplikacji
  • php zf build doctrine, generuje modele Doctrina z plików Yml w katalogu data/doctrine/schema. Podczas generowania usuwane są także zbędne modele.
  • php zf diff migration, listuje brakujące pliki migracyjne/aktualizujące bazy danych
  • php zf update migration [number], aktualizuje bazę danych o brakujące pliki aktualizacyjne. Opcjonalny atrybut number pozwala wykonać poszczeglną aktualizację, np: php zf update migration 12, php zf update migration 12,14,15
  • php zf show migration number, wyświetla zawartość wybranego pliku aktualizacyjnego bazy danych
  • php zf mark migration numbers, odznacza plik migracyjny bazy danych jako wykonany

Aktualizacja

Aktualizacja aplikacji możliwa jest poprzez paczki aktualizacyjne dostępne na naszej stronie pobrań. Aktualizacje należy przeprowadzać pomiędzy kolejnymi wersjami o równorzędnym znaczniu, np.:

  • aktualizacja z wersji 0.8 do 0.9
  • aktualizacja z wersji 0.8.3 do 0.8.4
  • w przypadku aktualizacji z wersji 0.8 do 0.11, należy kolejno wykonać aktualizację v. 0.9, v. 0.10 oraz 0.11
  • w przypadku aktualizacji z wersji 0.8.2 do 0.8.4, należy kolejno wykonać aktualizację v. 0.8.3 v. 0.8.4
  • w przypadku aktualizacji z wersji 0.8.4 do 0.9, należy kolejno wykonać wszystkie aktualizację 0.8.* następujące po v. 0.8.4

Tryb deweloperski

Domyślnie aplikacja zawsze działa w trybie produkcyjnym. Tryb produkcyjny nie wyświetla błędów oraz wykorzystywany jest cache aplikacji w celu optymalizacji szybkości działania strony.

Tryb deweloperski wyłącza cache aplikacji oraz wyświetla komunikat błędu bezpośrednio na ekran przez przeglądarkę. Włączenie trybu deweloperskiego możliwe jest w każdej chwili niezależnie od środowika na którym aplikacja została uruchomiona za pomocą dostępnych narzędzi deweloperskich.

Dostęp do powyższych opcji dostępny jest jedynie użytkownikom o odpowiedniej roli admin + developer

Ręczne włączenie trybu deweloperskiego

W przypadku braku możliwości włączenia trybu deweloperskiego poprzez aplikację, należy ręcznie dodać odpowiednie ciasteczka o wartości "1", których nazwa umieszczona jest w pliku application/settings/config.php

Każda aplikacja powinna posiadać indywidualne nazywy ciasteczek

Licencja

Informacje o licencji dostępne są pod adresem licencja