Instrucțiuni de instalare

De la Dexonline wiki
Salt la: navigare, căutare

Codul dexonline este disponibil liber (și gratuit) sub licența Affero GPL. Iată cum puteți să creați o copie funcțională a dexonline și să contribuiți cu patch-uri.

Aceste instrucțiuni sunt pentru un sistem GNU/Linux. Pentru alte sisteme, încercați:

  • Vagrant: Alex Morega a scris o listă de instrucțiuni (neîntreținute) pentru dezvoltarea într-un mediu virtual prin Vagrant. Poate fi mai rapid de instalat -- YMMV.
  • OS X cu MAMP

Cerințe de sistem

El a fost testat pe sisteme Ubuntu și Fedora standard. Aveți nevoie cel puțin de:

  • PHP >= 5.0
    • Modulele curl, mbstring, mysql și zlib sunt strict necesare.
    • Modulul php5-imagick este necesar pentru dicționarul vizual.
    • Modulele apc și memcache sunt opționale.
  • MySQL >= 5.0
  • Apache HTTP Server >= 2.0 sau Nginx
  • Git

Convenții de codare

  • Asigurați-vă că sistemul dumneavoastră permite citirea și tastarea diacriticelor românești ĂÂÎȘȚ. În particular, asigurați-vă că puteți folosi diacriticele Ș și Ț cu virgulă (nu Ş și Ţ cu sedilă). Editorul dumneavoastră trebuie să poată deschide și salva fișiere fără a corupe semnele diacritice din ele. Orice sistem GNU/Linux modern se descurcă perfect cu aceste simboluri. Sub Gnome, singura operație necesară este adăugarea unei mapări românești de tastatură (System / Preferences / Keyboard / Layouts / Add / Country:Romania). Cătălin folosește varianta simplă (Romania), care practic lasă tastatura originală nemodificată și adaugă diacriticele românești folosind talta !AltGr (Alt din dreapta).
  • Fișierele sunt scrise cu indentare de două spații, fără taburi. Aceasta este doar o convenție. Dacă preferați un alt stil, putem să îl adoptăm, dar trebuie să scrieți un script care să modifice toată baza de cod. Dacă ne oferiți și un fișier .emacs care să formateze codul în stilul dumneavoastră, este și mai bine. :-)
  • Majoritatea identificatorilor sunt „camelCased”, fără underscores: $numeVariabilă, NumeClasă, $this->numeCâmp.
  • Constantele sunt scrise cu litere mari și cu underscore: NUME_CONSTANTĂ.
  • Lățimea ecranului nu este bătută în cuie; credem că până la 160 de caractere nu se va supăra nimeni.
  • Pentru cuvintele-cheie (for, foreach, if, while, case etc.) se lasă spațiu în afara parantezelor, nu și înăuntrul lor.
  • Pentru apeluri de funcții, nu se lasă loc între numele funcției și paranteza deschisă.
  • Se lasă spațiu în afara acoladelor.
  • Se lasă spațiu după virgule.
  • Orice acoladă deschisă stă pe aceeași linie cu instrucțiunea if / else etc. precedentă și este urmată de o linie nouă.
  • Orice acoladă închisă este singură pe linia ei.
  • Folosim acolade și dacă blocul if / else / while etc. constă dintr-o singură instrucțiune.
if (($y > 3) && ($y < 10)) {
  while ($z < 10) {
    $z++;
    callMyFunction($y, $z);      
  }
}

Variante de instalare

În Apache există două variante de instalare a codului și un pas opțional pentru oricare dintre ele. Instrucțiunile de instalare depind în mică măsură de alegerea făcută.

  • userdir: în directorul utilizatorului, de obicei /home/user/public_html/DEX. URL-ul de acces este http://localhost/~user/DEX/wwwbase
  • document root: în directorul-rădăcină al lui Apache, de obicei /var/www/DEX. URL-ul de acces este http://localhost/DEX/wwwbase

Opțional:

  • virtual host: pentru oricare din variantele 1 și 2, puteți crea un site virtual. URL-ul de acces este http://dex.domeniulmeu.com (desigur, presupunând că dețineți domeniul domeniulmeu.com, ați creat subdomeniul dex.domeniulmeu.com și sunteți pe o conexiune cu IP static).

Nginx nu are suport nativ pentru directoare utilizator, deci alegeți orice cale doriți, să zicem /var/www/DEX.

Instalarea și configurarea codului și a bazei de date

Alegeți-vă directorul unde doriți să lucrați, conform secțiunii precedente. Descărcați o copie a codului sursă:

cd /home/user/public_html
# sau cd /var/www
git clone https://github.com/dexonline/dexonline DEX
cd DEX

Configurați codul pentru prima dată. Acest pas poate produce diverse erori, deoarece scriptul setup.sh nu este bine pus la punct.

tools/setup.sh

Modificați fișierul dex.conf conform cu setările sistemului. Acest fișier nu este sub controlul Git, deci este acceptabil să stocați parola pentru baza de date. În special:

  • Modificați valoarea variabilei database conform specificației DSN.
  • Dacă veți avea nevoie să testați pagini ale moderatorului, setați developmentMode = 1. Aceasta va modifica pagina de login pentru a vă putea să vă conectați cu orice permisiuni.

Descărcați baza de date a dexonline și importați-o în MySQL. De asemenea, migrați schema bazei de date la ultima versiune pentru cazul (improbabil) în care codul din Git este mai nou decât codul care rulează pe dexonline.ro.

mysql -u ... -p ... -e "create database DEX character set utf8"
wget -O /tmp/dex-database.sql.gz https://dexonline.ro/static/download/dex-database.sql.gz
zcat /tmp/dex-database.sql.gz | mysql -u ... -p ... DEX
php tools/migration.php

Altfel, creați-vă un cont și apoi executați comanda de mai sus. Puteți să vă creați un cont chiar pe dexonline.ro, altfel cel creat local se va pierde când veți recopia baza de date. Există diferite niveluri de privilegii, pentru editarea definițiilor, editare LOC, gestionarea cuvântului zilei etc. Valoarea 63 le include pe toate (cu OR).

Configurarea Apache

Aceste instrucțiuni sunt pentru Apache cu mod_php5 sub Ubuntu. Le puteți folosi cu titlu orientativ pe orice alt sistem, dar fișierele exacte pe care trebuie să le modificați pot diferi. Toate comenzile și editările se execută ca root.

  • Permiteți execuția de cod PHP.
apt-get install libapache2-mod-php5
  • Activați modulul rewrite:
a2enmod rewrite
  • Numai pentru userdir: Activați modulul userdir
a2enmod userdir
  • Numai pentru userdir: În /etc/apache2/mods-available/php5.conf comentați secțiunea
# <IfModule mod_userdir.c>
#     <Directory /home/*/public_html>
#         php_admin_value engine Off
#     </Directory>
# </IfModule>
  • Numai pentru userdir: Permiteți fișiere .htaccess. În /etc/apache2/mods-available/userdir.conf modificați secțiunea
<Directory /home/*/public_html>
    ...
    AllowOverride All
    ...
</Directory>
  • Numai pentru document root: Permiteți fișiere .htaccess. În /etc/apache2/sites-available/default modificați secțiunea
<Directory /var/www/>
    ...
    AllowOverride All
    ....
</Directory>
  • Alegeți setul de caractere UTF-8. În /etc/apache2/conf.d/charset, decomentați sau adăugați linia
AddDefaultCharset UTF-8
  • Numai pentru userdir, fără virtual host: Editați DEX/wwwbase/.htaccess și decomentați/modificați linia:
RewriteBase /~user/DEX/wwwbase/
  • Numai pentru virtual host: Creați fișierul /etc/apache2/sites-available/dex.domeniulmeu.com:
<VirtualHost *:80>
    DocumentRoot /path/to/DEX/wwwbase
    ServerName dex.domeniulmeu.com
</VirtualHost>

apoi

a2ensite dex.domeniulmeu.com
  • Reporniți Apache:
sudo /etc/init.d/apache2 restart
  • Accesați una din paginile
    • userdir: http://localhost/~user/DEX/wwwbase
    • document root: http://localhost/DEX/wwwbase
    • virtual host: http://dex.domeniulmeu.com

Dacă întâmpinați probleme netratate aici, vă rugăm contactați-ne ca să actualizăm acest document.

Configurarea Nginx

Această secțiune este mai puțin detaliată. Tratăm un singur caz: combinația Ubuntu + Nginx + php-fpm + instalare în /var/www/DEX.

  • Instalați nginx și php5-fpm:
sudo apt-get install nginx php5-fpm
  • Creați un server Nginx pentru instalarea de DEX. Copiați acest conținut în /etc/nginx/sites-available.
  • Creați un symlink către acest fișier în /etc/nginx/sites-enabled.
  • Editați prima secțiune conform nevoilor dumneavoastră. Aproape sigur nu aveți nevoie să modificați nimic în secțiunile location.
  • Vizitați http://localhost/DEX

Configurarea OpenID Connect

Această secțiune vă interesează doar dacă lucrați, în mod explicit, la autentificarea în dexonline folosind un cont Google. Vă reamintim că, pentru a vă putea conecta la instalarea dumneavoastră locală cu orice drepturi, trebuie doar să activați developmentMode = 1 în dex.conf.

Pe 20 aprilie 2015, Google a întrerupt suportul pentru OpenID 2.0 și recomandă migrarea la OpenID Connect (sau la alte sisteme, dar noi am ales OpenID Connect). Pentru a vă putea conecta cu contul Google pe instalarea dumneavoastră locală, trebuie să urmați o procedură care nu este grea, dar este migăloasă. Urmați acești pași:

  1. Creați un proiect în Google Developers Console
  2. Pentru acest proiect, creați un ID de client și un secret conform instrucțiunilor (pașii a-f)
  3. În fereastra „redirect URIs”, introduceți URL-ul la care utilizatorul revine după autentificare. Acesta depinde de calea unde ați făcut instalarea locală, de exemplu:
    • http://localhost/DEX/wwwbase/auth/revenireOpenidConnect.php
    • http://localhost/~username/DEX/wwwbase/auth/revenireOpenidConnect.php
  4. În fișierul de configurare dex.conf, în secțiunea [openid], adăugați o linie cu ID-ul de client și secretul, în formatul
    • credentials[accounts.google.com] = "ID_client|secret" (înlocuiți valorile ID_client și secret cu valorile din Google Developers Console)

(Posibil) Descărcați un certificat pentru Curl

Unele părți ale Dexonline au nevoie să descarce pagini web prin Curl. Unele din aceste pagini sunt pe protocolul https (în special pentru autentificarea cu OpenId). Unii utilizatori au raportat că nu pot descărca pagini https cu Curl decât dacă instalează un certificat în prealabil.

Dacă întâlniți probleme similare, puteți instala certificatul astfel:

Vedeți și o discuție pe StackOverflow.

Ținerea la zi

Pentru a ține ulterior clientul la zi, rulați:

git pull
php tools/migration.php

Modificările schemei bazei de date se fac exclusiv prin patchuri în directorul patches/. De aceea, ultimii pași nu sunt necesari decât atunci când apar fișiere noi în directorul patches/.

O situație mai delicată o au fișierele dex.conf și wwwbase/.htaccess. Acestea nu sunt sub controlul lui Git, deoarece sunt prea dependente de sistem. Ele sunt copiate după fișierele-șablon dex.conf.sample și respectiv docs/.htaccess. Când fișierele-șablon se modifică, trebuie să încorporați noutățile și în fișierele propriu-zise.

Contribuții la baza de cod

Această secțiune este în curs de rescriere. Vom adopta politica standard de contribuții pe GitHub. Trebuie doar să o documentăm și aici.