BitNami Spree

How to start/stop the servers?

The Stacks include a graphical tool to manage the servers easily. You can find the "manager-windows.exe", "manager-osx" or "manager-linux" tool in your installation directory. Using this tool, you can Start, Stop or Restart the servers and check the log files. You can click on the icon to start it.

On Windows: You can also start the Manager tool from shortcuts: Start -> Program Files -> BitNami Stack -> Manager tool

If you prefer, you can use the "ctlscript.sh" utility from the command line. This script is in the installation directory.

On OS X: You can start the Manager tool from the installation directory or you can use the "ctlscript.sh" utility from a Terminal.

host:~ user$ cd /Applications/application-version
host:~ user$ ./ctlscript.sh start

On Linux:

$ cd ~/applicaton-version
$ ./ctlscript.sh start

How to change the default URL?

If you want to change Spree to the root url you should follow the next next section. In this section you can see how to replace the URL "/spree" with "/new_url".

  On Linux and OS X, you should modify the following options in the "installdir/apps/spree/config/spree.conf" file. Note if you are using the Virtual Appliacne or the AMI, replace installdir with "/opt/bitnami" by default.

<Location /new_name>
  SetEnv RAILS_RELATIVE_URL_ROOT "/new_name"
  RackBaseURI /new_name
</Location>                                                    
...                                              
PassengerPreStart http://127.0.0.1/new_name

It is also necessary to update the symbolic link that you can find in /installdir/apache2/htdocs folder:

$ cd /installdir/apache2/htdocs
$ ln -s ../apps/spree/htdocs/public new_name

Then, restart the server:

$ ./ctlscript.sh restart apache

On Windows it is necessary to modify the Apache configuration. Edit "installdir/apps/spree/conf/spree.conf" the file to modify the "/spree" setting:

ProxyPass /spree balancer://spreecluster
ProxyPassReverse /spree balancer://spreecluster

<Proxy balancer://spreecluster>
  BalancerMember http://127.0.0.1:3001/spree
  BalancerMember http://127.0.0.1:3002/spree
</Proxy>

You should modify the "installdir/apps/spree/scripts/serviceinstall.bat" and change the prefix entry "--prefix /spree".  You should also update the prefix in the "installdir/apps/spree/htdocs/config/additional_environment.rb" file.

Then run the following command from a command prompt with Admin privileges:

> cd “C:\bitnami\Spree-1.2.2-0\apps\spree\scripts”
> serviceinstall.bat UNINSTALL
> serviceinstall.bat INSTALL

Then restart the Apache server using the Manager graphical application.

In both cases, before restarting the Apache server, you should precompile the assets again. To do so:

cd /installdir/
./use_spree
cd apps/spree/htdocs
ruby bin/rake assets:clean RAILS_ENV=production
ruby bin/rake assets:precompile RAILS_ENV=production RAILS_RELATIVE_URL_ROOT='/'

How to change the default URL to the root?

  On Linux and OS X, you can change the "installdir/apps/spree/conf/spree.conf" file to modify the "/spree" url to the root url. You can find below a configuration example. Please take into account that your current spree.conf file may be a little bit different. You should modify the "installdir/apps/spree/config/spree.conf" file according to the changes that you can see in bold:

DocumentRoot /installdir/apps/spree/htdocs/public

<Directory "/installdir/apps/spree/htdocs/public">
  Options -MultiViews
  allow from all
</Directory>

PassengerPreStart http://127.0.0.1:8080/

Then restart the Apache server.

On Windows it is necessary to modify the Apache configuration. Edit "installdir/apps/spree/conf/spree.conf" the file to remove the "/spree" setting:

<VirtualHost *:80>
  ServerAdmin example.com
  ServerName example.com
  ServerAlias server
  ErrorLog "logs/error.log" 
  CustomLog "logs/access.log" combined
  RewriteEngine On
  # Redirect non-static requests to cluster                                     
  RewriteCond %{DOCUMENT_ROOT}/%{REQUEST_FILENAME} !-f
  RewriteRule ^/(.*)$ balancer://spreecluster%{REQUEST_URI} [P,QSA,L]
</VirtualHost>

#ProxyPass / balancer://spreecluster
#ProxyPassReverse / balancer://spreecluster

<Proxy balancer://spreecluster>
  BalancerMember http://127.0.0.1:3001
  BalancerMember http://127.0.0.1:3002
</Proxy>

You should modify the "installdir/apps/spree/scripts/serviceinstall.bat" and remove the prefix entry "--prefix /spree". You should also remove the "installdir/apps/spree/htdocs/config/additional_environment.rb" file which ships the prefix too. Then run the following command from a command prompt with Admin privileges:

> cd “C:\bitnami\Spree-1.2.2-0\apps\spree\scripts”
> serviceinstall.bat UNINSTALL
> serviceinstall.bat INSTALL

Then restart the Apache server. You can use the Manager graphical tool to restart it. Do not forget to refresh the web page to clean the cache.

How to create a full backup of spree?

Because BitNami stacks are self-contained, the simplest option for performing your backups is to copy or compress the BitNami Stack installation directory. To do so in a safe manner, you will need to stop all servers, so this method may not be appropriate if you have people accessing the application continously.

On Linux and OS X:

$ cd installdir
$ ./ctlscript.sh stop
$ cp -r installdir application-backup

Or you can create a tarball:

$ tar -czvf application-backup.tar.gz installdir

Or a zip file:

$ zip -r application-backup.zip installdir/*

To restore this backup you only need to uncompress the backup in the same location. It is important to use the same path that was used when the stack was originally installed.

For example if you have a backup in a Red Hat machine, you can copy it to an Ubuntu Linux machine (a different distro!) in the same location. Then start the servers and that’s all.

$ cd installdir
$ ./ctlscript.sh start

You just need to be carefull to keep the same permissions for the files and folders. If you installed as root make sure that in the new machine you copy the files also as root. And this case, if you are also moving MySQL or PostgreSQL, you will need to create those users in the new machine (if they don't exist yet).

On Windows:

On Windows, you should follow the same process. Stop the servers using the shortcuts and copy the whole installation directory. To restore the system, copy the directory to a different Windows machine in the same location and follow these steps from a command prompt:

$ cd installdir
$ serviceinstall.bat INSTALL

You can access your BitNami Application at the usual URL.

If you want to create only a database backup, check the following link for MySQL /Components/MySQL#How_to_create_a_database_backup or for PostgreSQL

How to upgrade Spree?

It is strongly recommended that you create a backup before starting the update process. If you have important data, it is advisable that you create and try to restore a backup to ensure that everything works properly.

There are two different ways to upgrade your application.

1. If you want to upgrade the application and all Stack components PHP, Ruby, MySQL, Apache… You can follow the steps described at How to upgrade the full Stack migrating the data?
2. In case you only want to upgrade the application code without modifying any other Stack components. You can find below the steps to upgrade only the Spree application.

It is necessary to run the following command:

$ cd installdir
$ ./use_spree
$ cd apps/spree/htdocs
$ gem update spree

Afterwards, restart the Apache server, and the thin servers in Windows.

How to install the sample data in Spree?

The sample data shipped with Spree can be added manually after performing the installation of the BitNami Spree stack, if the option of not installing it automatically was chosen. 

To do so, run the following commands:

$ cd installdir
$ ./use_spree
$ cd apps/spree/htdocs
$ rake spree_sample:load
$ rake assets:precompile:all RAILS_ENV=production RAILS_GROUPS=assets
$ cd installdir
$ ./ctlscript.sh restart apache