Merge pull request #17 from SteveClement/install_docs

chg: [doc] Updated INSTALL doc
pull/30/head
Andras Iklody 2020-06-30 19:10:48 +02:00 committed by GitHub
commit 463b9a37e8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 46 additions and 14 deletions

View File

@ -1,24 +1,31 @@
## Requirements
An Ubuntu server (18.04/20.04 should both work fine) - though other linux installations should work too.
- apache2, mysql/mariadb, sqlite need to be installed and running
- php extensions for intl, mysql, sqlite need to be installed and running
An Ubuntu server (18.04/20.04 should both work fine) - though other Linux installations should work too.
- sqlite, apache2, mysql/mariadb need to be installed and running
- php extensions for intl, mysql, sqlite3, mbstring, xml need to be installed and running
- composer
## Cerebrate installation instructions
Simply clone this repository (for example into /var/www/cerebrate)
Install dependencies
```
sudo apt install composer apache2 libapache2-mod-php php php-intl php-mysql php-mbstring php-sqlite3 php-xml unzip mariadb-server
```
Clone this repository (for example into /var/www/cerebrate)
```
cd /var/www
git clone git@github.com:cerebrate-project/cerebrate.git
sudo mkdir /var/www/cerebrate
sudo chown www-data:www-data /var/www/cerebrate
sudo -u www-data git clone https://github.com/cerebrate-project/cerebrate.git /var/www/cerebrate
```
Run composer
```
cd /var/www/cerebrate
composer install
sudo -u www-data composer install
```
Create a database for cerebrate
@ -32,25 +39,50 @@ GRANT ALL PRIVILEGES ON cerebrate.* to cerebrate@localhost;
FLUSH PRIVILEGES;
```
```
sudo mysql -e "CREATE DATABASE cerebrate;"
sudo mysql -e "CREATE USER 'cerebrate'@'localhost' IDENTIFIED BY 'YOuR_Pa$$WORD!';"
sudo mysql -e "GRANT USAGE ON *.* to cerebrate@localhost;"
sudo mysql -e "GRANT ALL PRIVILEGES ON cerebrate.* to cerebrate@localhost;"
sudo mysql -e "FLUSH PRIVILEGES;"
```
Load the default table structure into the database
```
mysql -u cerebrate -p cerebrate < /var/www/cerebrate/INSTALL/mysql.sql
sudo mysql -u cerebrate -p cerebrate < /var/www/cerebrate/INSTALL/mysql.sql
```
create your local configuration and set the db credentials
```
cp -a /var/www/cerebrate/config/app_local.example.php /var/www/cerebrate/config/app_local.php
vim /var/www/cerebrate/config/app_local.php
sudo -u www-data cp -a /var/www/cerebrate/config/app_local.example.php /var/www/cerebrate/config/app_local.php
sudo -u www-data vim /var/www/cerebrate/config/app_local.php
```
Simply modify the Datasource -> default array's username, password, database fields
Modify the Datasource -> default array's username, password, database fields
Create an apache config file for cerebrate / ssh key and point the document root to /var/www/cerebrate/webroot/index.php and you're good to go
Create an apache config file for cerebrate / ssh key and point the document root to /var/www/cerebrate/webroot/index.php and you're good to go.
mod_rewrite needs to be enabled:
```
sudo a2enmod rewrite
```
For development installs the following can be done:
```
# This configuration is purely meant for local installations for development / testing
# Using HTTP on an unhardened apache is by no means meant to be used in any production environment
sudo cp /var/www/cerebrate/INSTALL/cerebrate_dev.conf /etc/apache2/sites-available/
sudo ln -s /etc/apache2/sites-available/cerebrate_dev.conf /etc/apache2/sites-enabled/
sudo service apache2 restart
```
Now you can point your browser to: http://localhost:8000
To log in use the default credentials below:
username: admin
Username: admin
Password: Password1234