diff --git a/README.md b/README.md index 7884094..f2c333c 100644 --- a/README.md +++ b/README.md @@ -1,39 +1,58 @@ # SPOD-MANAGER -## Requirements +## Table of contents +* Introduction +* SPOD Requirements +* SPOD Manager download +* SPOD Manager help +* Examples of use + +## Introduction +A package for the installation, update, backup and restore of a Social Platform for Open Data (SPOD) application. +SPOD enables social interactions among open data users and between open data users and government data. http://spod.routetopa.eu + +SPOD is based on three packages available under GitLab: +* spod-core, which provides an intiall Oxwall installation tailored on SPOD. In particular it includes a folder (db_dump) which contains an empty Oxwall database configured for SPOD +* spod-themes, which contains the SPOD look and feel +* spod-plugins, which contains some of the Oxwall adapted to SPOD and some other plugins specifically developed for SPOD. + + +## SPOD Requirements * Linux (tested on Kernel 3.19.0-25-generic) * Apache Web Server (local installation) -* MySql Server (local and remote installation) +* MySql Server (local or remote installation) * Git shell client -* ROUTE-TO_PA source code account +* ROUTE-TO-PA GitLab source code account * Root access on local machine -## Download +## SPOD Manager download wget http://service.routetopa.eu:7480/carspa/spod-manager/raw/master/spod-manager.sh chmod +x spod-manager.sh -## Actions help +## SPOD Manager help sudo ./spod-manager.sh --help - spod-manager.sh is manager tool for SPOD application of ROUTE-TO-PA European project all rights are reserved. 2015 + spod-manager.sh is package for the installation, update, backup and restore of a Social Platform for Open Data (SPOD) application. +SPOD enables social interactions among open data users and between open data users and government data. http://spod.routetopa.eu + list of arguments: -h, --help show commands help. - -a, --action=ACTION specify an action install, uninstall, update, backup and restore. - -m, --mysql-username=username specify the username of mysql (*). - -n, --mysql-password=password specify the password of mysql server (*). - -o, --mysql-address=address specify the address of mysql server (deafult is localhost). - -p, --spod-git-username=user specify the user name of SPOD git server (*). - -q, --spod-git-email=email specify the email of SPOD git server (*). - -r, --spod-git-password=password specify the passoword of SPOD git server (*). - -s, --spod-git-address=address:port specify the SPOD git server (deafult is service.routetopa.eu:7480). - -w, --spod-hostname=hostname specify the SPOD host name (example http://spod.routetopa.eu/). - -e, --spod-www-backup=www-folder specify the SPOD www folder path. - -d, --spod-database-version=db specify the SPOD db git path located in db_dump of SPOD git core (example in backup action: oxwall_v.0.1_antares.sql, deafults is really simple SPOD and Oxwall installationi; in restore action use a local db dump). - -b, --backup-dir=DIR specify the directory where store the spod backup (default is current directory). + -a, --action=ACTION define the action [install, uninstall, update, backup, restoredb, restoreall] (*). + -m, --mysql-username=username mysql server username (*). + -n, --mysql-password=password mysql server password (*). + -o, --mysql-address=address mysql server hostname or ip address (deafult is localhost). + -p, --spod-git-username=user SPOD Git server user name (*). + -q, --spod-git-email=email SPOD Git server user email (*). + -r, --spod-git-password=password SPOD Git server password (*). + -s, --spod-git-address=address:port SPOD Git server hostname or address (deafult is http://service.routetopa.eu:7480). + -w, --spod-hostname=hostname SPOD hostname (example http://spod.routetopa.eu/). + -e, --spod-www-backup=www-folder SPOD backup folder path (defauld is current directory). + -d, --spod-database-version=db SPOD db name. For installation, it is the name of a db file on the spod-core/db_dump folder (example oxwall_v.0.1_antares.sql). For restoredb and restoreall, it is the db file absolute path). + -b, --backup-dir=DIR SPOD backup directory (default is current directory). * the arguments is required. -## Actions examples +## Example of use ### INSTALLATION SPOD