Skip to content

Getting Started installations

Jump to bottom Edit New page
Steve Ireland edited this page Sep 3, 2018 · 31 revisions

After read this read also Getting Started Usage

Installation

Please follow the instructions here as closely as possible, otherwise we won't be able to support you in case of issues.

We will be installing a prebuilt version of OSPOS. Do not click on the Green "Clone or Download" button found in the Code view of GitHub. It is NOT a working copy of OSPOS. Instead, in the following instructions, we will be retrieving and installing a prebuilt official release.

Local Deploy install for Unix/Linux environments.

  1. Terminal windows must be open: in MacOSX at Finder->Accesories->Terminal in Linux at Menu->SystemTools->Terminal, then a window with prompt will show, it's best to elevate to root access with sudo su command.

  2. Dependencies Install: Apache2, MariaDB, PhP with openssl/mcrypt, curl, gd, intl and bcmath, in MAC all these are included in MAMP, in Linux for Deb and RPM based distribution you need apt-get install apache2 mariadb-server php5-curl php5-mysql php5-gd php5-intl or/and yum install httpd mysql-server php php-bcmath php-dba php-gd. Debian does not use "php5" bit "php" in their names of the packages. Now finally enable the mod-rewrite module by entering the a2enmod rewrite command.

  3. Htdocs working directory: Change the working directory in the current terminal window, assuming the /var/www/html as the web root html document directory and you can move to by executing cd /var/www/html but remember this depends of the Operating System Apache2 install

  4. Download Retrieve a prebuilt version of OSPOS using the latest release. Execute in same terminal: wget https://github.com/opensourcepos/opensourcepos/releases/download/3.2.3/opensourcepos.20180613210031.3.2.3.f1cf3d.zip -O osposlastedstable.zip to later move to the htdoc directory.

  5. Uncompress to htdocs the download: cd /var/www/html;unzip osposlastedstable.zip this will populate all the web server htdocs root directory only for the software.

  6. Create database and access: executing in same terminal mysql -u root -e "CREATE SCHEMA ospos;CREATE USER 'admin'@'%' IDENTIFIED BY 'pointofsale';GRANT ALL PRIVILEGES ON ospos . * TO 'admin'@'%' IDENTIFIED BY 'pointofsale' WITH GRANT OPTION;FLUSH PRIVILEGES;" take in consideratin password administrative privilegies for the database users.

  7. Populate database with that other command in same terminal mysql -u admin -ppointofsale -D ospos < /var/www/html/application/database/database.sql

  8. Configure the OSPOS index page and encryption key this its by editing the config and htaccess files, can be bypassing but strong recommended set the encryption key at application/config/config.php with your owcurrently for security.

  9. Browsing using the web browser and run from http://localhost/public or better http://127.0.0.1/public

  10. Login by using username as admin and the password are pointofsale and then enjoy the software.

Now next to Getting Started Usage

Local Docker install

Docker deploy are not recomended, due its a *nix like environment and on upgrades many services changes policies about running commands and maybe the build command of that docker are not up to date respect distribution services changes. Due Docker runs natively on mac and linux.. If you dont want to mess with that read installation-notes-for-impatients section

  1. Terminal windows must be open: in MacOSX at Finder->Accesories->Terminal in Linux at Menu->SystemTools->Terminal, then a window with prompt will show, in Linux flavors must gain root access only for next step with sudo su command

  2. Dependences install: docker.io, please refer to the docker documentation for better instructions: in MAC all included in docker.img file by launching it, drag Moby the whale to the Applications folder and later relaunch service from Finder, in Linux for Deb and RPM based distribution are apt-get install docker.io or/and yum-config-manager --add-repo https://download.docker.com/linux/centos/docker-ce.repo;yum install -y docker-ce respectively, oldstable deb distributions may need "backports" or "external" repositories. After install hit "CRTL+D" to out from root account.

  3. Dockerplace working directory for the dockerfile of ospos: this it's change the working directory in the current terminal window, assuming the ~ represent your home with a docker root document directory and you can move to by executing mkdir ~/osposdocker;cd ~/osposdocker but remenber this depends of the Operating System Docker install too.

  4. Download please Dont use github direclty!! and executing in same terminal: wget https://github.com/opensourcepos/opensourcepos/releases/download/3.2.3/opensourcepos.20180613210031.3.2.3.f1cf3d.zip -O osposlastedstable.zip to later move to the htdoc directory.

  5. Uncompress to htdocs the download: tar zxvf osposlastedstable.tar.gz --strip 1 -C ~/osposdocker this will populate all the docker root image directory only for the software.

  6. Build+Run the image with following commands docker-compose build and then later docker-compose up, take in consideratin password administrative privilegies for the database users.

Now next to Getting Started Usage More info in the wiki page Extras for Docker cloud maintenance must be read.

If you want to run from the latest git source, then use docker and composer to run the build

docker run --rm -v $(pwd):/app composer/composer install
docker run --rm -v $(pwd):/app -w /app lucor/php7-cli php bin/install.php translations develop
docker run --rm -it -v $(pwd):/app -w /app digitallyseamless/nodejs-bower-grunt "sh -c npm install && bower install"
docker-compose build
docker-compose up

More info in the wiki page Extras for Docker cloud maintenance must be read.

See also:

Cloud Install

Cloud Deploy installation

For Cloud hosting we recommend DigitalOcean (click here) if need hosting related. If you dont want to mess with that read installation-notes-for-impatients section.

  1. Create a Digitalocean account and once complete go log in.

  2. Choose a Debian Droplet by click the Create button in the top right hand corner, and later from the dropdown menu.

  3. OneClickApp as the LAMP on 9 app, clik the One click apps link. Scroll down, and choose a size. Then scroll down to Choose a datacenter region. Select the region closest to you. Finally select hosname as osposdo

  4. Connecting: Now click the Create button to create your droplet. When your droplet has been created, you'll receive an email from DigitalOcean. This will have the information to log in. You now have the information needed to log in to your server. If you have Mac or Linux, you can use the built-in terminal program SSH as ssh root@<digitalocean's-ip>.

  5. Install software, apache and mysql/mariadb are already, need enable the mod-rewrite module by a2enmod rewrite then PHP modules by apt-get install php7.0-intl php7.0-mcrypt php7.0-bcmath php7.0-curl Type "Y" when it asks if you want to continue. Finally restart service by service apache2 restart

  6. Download please Dont use github direclty!!, and executing in same terminal: wget https://github.com/opensourcepos/opensourcepos/releases/download/3.2.3/opensourcepos.20180613210031.3.2.3.f1cf3d.zip -O osposlastedstable.zip to later move to the htdoc directory.

  7. Uncompress to htdocs the download: tar zxvf osposlastedstable.tar.gz --strip 1 -C /var/www/html this will populate all the web server htdocs root directory only for the software.

  8. Create database and access: executing in same terminal mysql -u root -p -e "CREATE SCHEMA ospos;CREATE USER 'admin'@'%' IDENTIFIED BY 'pointofsale';GRANT ALL PRIVILEGES ON ospos . * TO 'admin'@'%' IDENTIFIED BY 'pointofsale' WITH GRANT OPTION;FLUSH PRIVILEGES;" the DigitalOcean's password are in the filesystem, get with cat /root/.digitalocean_password command before, and take in consideratin password administrative privilegies for the database users.

  9. Populate database with that other command in same terminal mysql -u admin -ppointofsale -D ospos < /var/www/html/application/database/database.sql

  10. Configure the OSPOS index page and encription key, this its by editing the config and htaccess files, can be bypassing but strong recommended set the encryption key at application/config/config.php with your owcurrently for security.

  11. Browsing using the web browser and run from http://<digitalocean-ip>/public changing the "digitalocean-ip" with that provided in the mail previously received.

  12. Login by using username as admin and the password are pointofsale and then enjoy the software.

Now next to Getting Started Usage

More info in the wiki page Extras for Docker cloud maintenance must be read.

Professional Install

This section its dedicated to those that will deploy in secure and serious production environments. Dont use github direclty!! Downloads must be using unstable bintray or stable releases checkpoints.

Professional Install Local

Professional install will assumed behing a complex network, that will redirect the port and the path of the OSPOS installation due a front webserver will receive the request and firewall/reverseproxy will redirect to the ospos server install place.

  • If you will use reverse proxy redirection due there's no need of a installed firewall in the local webserver OS, that are under a DMZ zone.
  • If you dont want hiyacked all the root of your webserver, can defined new port and to that port a new webroot htdocs place where the OSPOS software will reside away of the normal webserver installation.

Other Install guides

See also:

If you like the project, and you are making money out of it on a daily basis, then consider buying us a coffee so I can keep adding features. Donate

Quick start:

Usage docs

Developer Docs

Installation Extra Guides

Clone this wiki locally