Commit de503ccca33c0e628b72f26ca7a06fd3b537888a
1 parent
0abbaeb8
update readme help
Showing
1 changed file
with
38 additions
and
19 deletions
README.md
| 1 | 1 | # SPOD-MANAGER |
| 2 | 2 | |
| 3 | -## Requirements | |
| 3 | +## Table of contents | |
| 4 | +* Introduction | |
| 5 | +* SPOD Requirements | |
| 6 | +* SPOD Manager download | |
| 7 | +* SPOD Manager help | |
| 8 | +* Examples of use | |
| 9 | + | |
| 10 | +## Introduction | |
| 11 | +A package for the installation, update, backup and restore of a Social Platform for Open Data (SPOD) application. | |
| 12 | +SPOD enables social interactions among open data users and between open data users and government data. http://spod.routetopa.eu | |
| 13 | + | |
| 14 | +SPOD is based on three packages available under GitLab: | |
| 15 | +* 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 | |
| 16 | +* spod-themes, which contains the SPOD look and feel | |
| 17 | +* spod-plugins, which contains some of the Oxwall adapted to SPOD and some other plugins specifically developed for SPOD. | |
| 18 | + | |
| 19 | + | |
| 20 | +## SPOD Requirements | |
| 4 | 21 | * Linux (tested on Kernel 3.19.0-25-generic) |
| 5 | 22 | * Apache Web Server (local installation) |
| 6 | -* MySql Server (local and remote installation) | |
| 23 | +* MySql Server (local or remote installation) | |
| 7 | 24 | * Git shell client |
| 8 | -* ROUTE-TO_PA source code account | |
| 25 | +* ROUTE-TO-PA GitLab source code account | |
| 9 | 26 | * Root access on local machine |
| 10 | 27 | |
| 11 | -## Download | |
| 28 | +## SPOD Manager download | |
| 12 | 29 | |
| 13 | 30 | wget http://service.routetopa.eu:7480/carspa/spod-manager/raw/master/spod-manager.sh |
| 14 | 31 | chmod +x spod-manager.sh |
| 15 | 32 | |
| 16 | -## Actions help | |
| 33 | +## SPOD Manager help | |
| 17 | 34 | |
| 18 | 35 | sudo ./spod-manager.sh --help |
| 19 | - spod-manager.sh is manager tool for SPOD application of ROUTE-TO-PA European project all rights are reserved. 2015 | |
| 36 | + spod-manager.sh is package for the installation, update, backup and restore of a Social Platform for Open Data (SPOD) application. | |
| 37 | +SPOD enables social interactions among open data users and between open data users and government data. http://spod.routetopa.eu | |
| 38 | + | |
| 20 | 39 | list of arguments: |
| 21 | 40 | -h, --help show commands help. |
| 22 | - -a, --action=ACTION specify an action install, uninstall, update, backup and restore. | |
| 23 | - -m, --mysql-username=username specify the username of mysql (*). | |
| 24 | - -n, --mysql-password=password specify the password of mysql server (*). | |
| 25 | - -o, --mysql-address=address specify the address of mysql server (deafult is localhost). | |
| 26 | - -p, --spod-git-username=user specify the user name of SPOD git server (*). | |
| 27 | - -q, --spod-git-email=email specify the email of SPOD git server (*). | |
| 28 | - -r, --spod-git-password=password specify the passoword of SPOD git server (*). | |
| 29 | - -s, --spod-git-address=address:port specify the SPOD git server (deafult is service.routetopa.eu:7480). | |
| 30 | - -w, --spod-hostname=hostname specify the SPOD host name (example http://spod.routetopa.eu/). | |
| 31 | - -e, --spod-www-backup=www-folder specify the SPOD www folder path. | |
| 32 | - -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). | |
| 33 | - -b, --backup-dir=DIR specify the directory where store the spod backup (default is current directory). | |
| 41 | + -a, --action=ACTION define the action [install, uninstall, update, backup, restoredb, restoreall] (*). | |
| 42 | + -m, --mysql-username=username mysql server username (*). | |
| 43 | + -n, --mysql-password=password mysql server password (*). | |
| 44 | + -o, --mysql-address=address mysql server hostname or ip address (deafult is localhost). | |
| 45 | + -p, --spod-git-username=user SPOD Git server user name (*). | |
| 46 | + -q, --spod-git-email=email SPOD Git server user email (*). | |
| 47 | + -r, --spod-git-password=password SPOD Git server password (*). | |
| 48 | + -s, --spod-git-address=address:port SPOD Git server hostname or address (deafult is http://service.routetopa.eu:7480). | |
| 49 | + -w, --spod-hostname=hostname SPOD hostname (example http://spod.routetopa.eu/). | |
| 50 | + -e, --spod-www-backup=www-folder SPOD backup folder path (defauld is current directory). | |
| 51 | + -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). | |
| 52 | + -b, --backup-dir=DIR SPOD backup directory (default is current directory). | |
| 34 | 53 | * the arguments is required. |
| 35 | 54 | |
| 36 | -## Actions examples | |
| 55 | +## Example of use | |
| 37 | 56 | |
| 38 | 57 | ### INSTALLATION SPOD |
| 39 | 58 | ... | ... |