lpalgarvio / open-semantic-framework-installer

Command line tool used for installing, updating and configuring an Open Semantic Framework instance

The Open Semantic Framework Installer script is used to install and deploy an OSF stack. It can also be used to install, upgrade, and configure parts of the stack, or related external tools such as the OSF Datasets Management Tool, the OSFOntologies Management Tool, the OSF WS PHP API, etc.

If you prefer, you can create a new OSF instance using a pre-packaged Amazon EC2 instance. Read the Creating and Configuring an Amazon EC2 AMI OSF Instance page to know how to create a OSF instance using this other method.

Requirements

• Supported Linux Distributions:
  • CentOS 7
  • Ubuntu 14.04
• PHP 5.5 or higher
• 64 Bit Operating System
• Access to internet from your server
• 5 GB of disk space on the partition where you are installing OSF
• 2 GB of RAM

Installing the Open Semantic Framework

To install OSF on your server, you first have to install the OSF Installer command line tool. You only have to run the following commands:

mkdir -p /usr/share/osf-installer/

cd /usr/share/osf-installer/

wget https://raw.github.com/structureddynamics/Open-Semantic-Framework-Installer/3.4/install.sh

chmod 755 install.sh

./install.sh

Now that the OSF Installer is installed, you can configure the installation and install OSF:

./osf-installer -c --install-osf -v

Or you can simply run the installer, without configuring it, using the settings defined in the installer.ini configuration file:

./osf-installer --install-osf -v

When you install OSF using that command, then no input is required in the command line. This means that you can create configuration profiles by updating the settings directly in the installer.ini file and use these values to automatically deploy OSF on your server. This kind of installation is normally used by automated deployment systems to automatically install and configure OSF on a server without requiring external inputs.

Subsequently, if you want to install OSF for Drupal on the same server, then you can run the following command:

./osf-installer -d --install-osf-drupal -v

Usage

Usage: osf-install [OPTIONS]


General Options:
-h, --help                              Show this help section
-v, --verbose                           Make this installer verbose
-c, --configure-osf-installer           Configure the options used by this installer
-d, --configure-osf-drupal-installer    Configure the options used by this installer to install OSF for Drupal
--list-configurations                   List the current configuration used by the installer tool

OSF Installation Options:
Note: the [VERSION] parameter is optional.
      If no version is specified, the latest DEV version will be used

--install-osf                           Install the Open Semantic Framework
--install-apache2                       Install Apache2
--install-mysql                         Install MySQL
--install-phpmyadmin                    Install PhpMyAdmin
--install-virtuoso                      Install Virtuoso
--install-solr                          Install Solr
--install-php5                          Install PHP5
--install-osf-ws-php-api="[VERSION]"                    Install the OSF-WS-PHP-API library
--install-osf-tests-suites="[VERSION]"                  Install the OSF Tests Suites
--install-osf-datasets-management-tool="[VERSION]"      Install the OSF Datasets Management Tool
--install-osf-permissions-management-tool="[VERSION]"   Install the OSF Permissions Management Tool
--install-osf-data-validator-tool="[VERSION]"           Install the OSF Data Validator Tool
--install-osf-ontologies-management-tool="[VERSION]"    Install the OSF Ontologies Management Tool

OSF Drupal Installation Options:

--install-osf-drupal                    Install Drupal with the OSF Drupal modules

Upgrade Options:
Note: the [VERSION] parameter is optional.
      If no version is specified, the latest DEV version will be used

--upgrade-osf-web-services="[VERSION]"               Upgrade the OSF Web Services
--upgrade-osf-ws-php-api="[VERSION]"                 Upgrade the OSF-WS-PHP-API library
--upgrade-osf-tests-suites="[VERSION]"               Upgrade the OSF Tests Suites
--upgrade-osf-datasets-management-tool="[VERSION]"   Upgrade the OSF Datasets Management Tool
--upgrade-osf-permissions-management-tool="[VERSION]"   Upgrade the OSF Permissions Management Tool
--upgrade-osf-data-validator-tool="[VERSION]"        Upgrade the OSF Data Validator Tool
--upgrade-osf-ontologies-management-tool="[VERSION]" Upgrade the OSF Ontologies Management Tool

Next Steps

Once you have installed the OSF stack, you next query the OSF Web Services endpoints, and import datasets using OSF for Drupal. Here are a few things you can do to start exploring the Open Semantic Framework:

• Start exploring OSF Web Services
• Start exploring OSF for Drupal
• Start exploring Ontologies usage in OSF
• Start importing and manipulating datasets
• Start exploring the Open Semantic Framework architecture
• Start using the OSF Web Services PHP API.

When you are ready to begin developing and configuring your new instance in earnest, the best place to start is A Basic Guide to Content on the TechWiki.

For More Help

If you are experiencing issues with this installation process, please do make an outreach to the Open Semantic Web Mailing List.

Describe the specifications of the server where you are trying to install OSF. Tell us where the issue happens in the installation process. Also add any logs that could be helpful in debugging the issue.